`langchain_community.tools.azure_cognitive_services.text_analytics_health`.AzureCogsTextAnalyticsHealthTool¶

注意

AzureCogsTextAnalyticsHealthTool 实现了标准 Runnable 接口. 🏃

Runnable 接口 拥有额外的运行时方法，例如 with_types、with_retry、assign、bind、get_graph 以及更多。

class langchain_community.tools.azure_cognitive_services.text_analytics_health.AzureCogsTextAnalyticsHealthTool[source]¶

基类: BaseTool

查询 Azure cognitive services 文本分析健康 API 的工具。

要设置此工具，请按照以下说明操作：[链接](https://learn.microsoft.com/en-us/azure/ai-services/language-service/text-analytics-for-health/quickstart?tabs=windows&pivots=programming-language-python)

初始化工具。

param args_schema: Optional[TypeBaseModel] = None¶

Pydantic 模型类，用于验证和解析工具的输入参数。

参数模式应该是：

pydantic.BaseModel 的子类。

或者 - pydantic 2 的 v1 命名空间中的 pydantic.v1.BaseModel 的子类。

参数 : callback_manager : Optional[BaseCallbackManager] = None¶: 已弃用。请使用回调代替。

参数 : callbacks : Callbacks = None¶: 在工具执行期间将调用的回调。

参数 : description : str = 'A wrapper around Azure Cognitive Services Text Analytics for Health. Useful for when you need to identify entities in healthcare data. Input should be text.'¶

用于告知模型何时以及为何使用工具。

您可以在描述中提供少量示例。

参数 : handle_tool_error : Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶: 处理抛出的 ToolException 的内容。

参数 : handle_validation_error : Optional[Union[bool, str, Callable[[ValidationError], str]] = False¶: 处理抛出的 ValidationError 内容。

param metadata: Optional[Dict[str, Any]]] = None¶: 与该工具关联的可选元数据。默认为 None。这些元数据将关联到每次对工具的调用，并作为参数传递给在 callbacks 中定义的处理程序。您可以用这些来例如识别特定工具的特定用例。

param response_format: Literal['content', 'content_and_artifact'] = 'content'¶

工具响应格式。默认为‘内容’。

如果为“内容”，则工具的输出被解释为 ToolMessage 的内容。如果为“content_and_artifact”，则期望输出为对应于 ToolMessage 的 (内容，工件) 的两个元素元组。

param return_direct: bool = False¶

是否直接返回工具的输出。

将此设置为 True 表示调用工具后，AgentExecutor 会停止循环。

param tags: Optional[List[str]] = None¶: 与工具关联的可选标签列表。默认为 None。这些标签将关联到每次对工具的调用，并作为参数传递给在 callbacks 中定义的处理程序。您可以用这些来例如识别特定工具的特定用例。

param verbose: bool = False¶: 是否记录工具的进度。

__call__(tool_input: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) → str¶

自langchain-core==0.1.47版本以来已弃用: 请使用invoke代替。

使工具可调用。

参数

tool_input (str) –
callbacks (可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]) –

返回类型

str

async abatch(inputs: List[Input], config: 可选[联合[RunnableConfig, 列表[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: 可选[Any]) → List[Output]¶

默认实现使用asyncio.gather并行运行invoke。

默认的批量实现对I/O密集型可运行项工作良好。

子类应在其能够更有效地批处理时重写此方法；例如，如果底层的Runnable使用支持批处理模式的API。

参数

inputs (List[输入]) - Runnable的输入列表。
config (Optional[Union[RunnableConfig, List[RunnableConfig]]]) - 调用Runnable时使用的配置。该配置支持标准键，如用于跟踪的“tags”、“metadata”，以及用于控制并行工作量的“max_concurrency”等键。请参阅RunnableConfig获取更多详细信息。默认为None。
return_exceptions (布尔型) - 是否返回异常而不是抛出异常。默认为False。
kwargs (Optional[任何]) - 传递给Runnable的附加关键字参数。

返回

Runnable的输出列表。

返回类型

List[输出]

async abatch_as_completed(inputs: 序列[输入], config: Optional[Union[RunnableConfig, 序列[RunnableConfig]]] = None, *, return_exceptions: 布尔型 = False, **kwargs: Optional[任何]) → 异步迭代器[元组[整数, Union[输出, 异常]]]¶

并行在输入列表上运行Run，随着它们的完成产生结果。

参数

inputs (序列[输入]) - Runnable的输入列表。
config (可选[联合[RunnableConfig，Sequence[RunnableConfig]]]) - 调用Runnable时要使用的配置。该配置支持标准的键，如‘tags’和‘metadata’，用于跟踪目的，‘max_concurrency’用于控制并行执行的工作量，以及其他键。请参阅RunnableConfig获取更多详情。默认为None。默认为None。
return_exceptions (布尔型) - 是否返回异常而不是抛出异常。默认为False。
kwargs (Optional[任何]) - 传递给Runnable的附加关键字参数。

产出

Runnable输出的输入和输出索引的元组。

返回类型

AsyncIterator[Tuple[int, Union[Output, Exception]]]

async ainvoke(input: Union[str， Dict， ToolCall], config: Optional[RunnableConfig] = None, **kwargs: Any) → Any¶

ainvoke的默认实现，从线程中调用invoke。

默认实现允许即使在Runnable没有实现invoke的原生异步版本的情况下也可以使用异步代码。

子类应该在其能异步运行时重写此方法。

参数

input (Union[str，Dict，ToolCall]) -
config (Optional[RunnableConfig]) -
kwargs (Any) –

返回类型

Any

async arun(tool_input: Union[str, Dict], verbose: Optional[bool] = None, start_color: Optional[str] = 'green', color: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, run_id: Optional[UUID] = None, config: Optional[RunnableConfig] = None, tool_call_id: Optional[str] = None, **kwargs: Any) → Any¶

异步运行工具。

参数

tool_input (Union[str，Dict]) – 工具的输入。
verbose (Optional[bool]) – 是否记录工具的进度。默认为None。
start_color (Optional[str]) – 启动工具时使用的颜色。默认为‘green’。
color (Optional[str]) – 结束工具时使用的颜色。默认为‘green’。
callbacks (Optional[Union[List[BaseCallbackHandler]，BaseCallbackManager]]) – 工具执行期间要调用的回调。默认为None。
标签 (可选：标签列表[字符串]]) - 与工具相关联的标签列表，可选。默认为None。
元数据 (可选：字典[字符串，任意]]) - 与工具相关联的元数据，可选。默认为None。
运行名称 (可选：字符串) - 运行的名称。默认为None。
运行ID (可选：UUID) - 运行的ID。默认为None。
配置 (可选：RunnableConfig) - 工具的配置。默认为None。
工具调用ID (可选：字符串) - 工具调用的ID。默认为None。
额外参数 (任意) - 传递给工具的额外参数

返回

工具的输出。

抛出

工具异常 - 如果在执行工具过程中发生错误。

返回类型

Any

as_tool(args_schema: Optional[Type[BaseModel]] = None, *, name: Optional[str] = None, description: Optional[str] = None, arg_types: Optional[字典[字符串，Type]] = None) → BaseTool¶

测试版

本API处于测试版，未来可能会有所变化。

从Runnable创建BaseTool。

as_tool将从Runnable实例化一个带有名称、描述和args_schema的BaseTool。尽可能的情况下，模式是从runnable.get_input_schema推断出来的。另外（例如，如果Runnable以字典作为输入且特定字典键未指定类型），可以使用args_schema直接指定模式。您还可以通过arg_types仅指定所需的参数及其类型。

参数

args_schema（《可选》）[类型[BaseModel]] - 工具的模式。默认值为None。
name（《可选》）[str] - 工具的名称。默认值为None。
description（《可选》）[str] - 工具的描述。默认值为None。
arg_types（《可选》）[Dict[str, 类型]] - 参数名称到类型的字典。默认值为None。

返回

BaseTool的实例。

返回类型

BaseTool

类型化字典输入

from typing import List
from typing_extensions import TypedDict
from langchain_core.runnables import RunnableLambda

class Args(TypedDict):
    a: int
    b: List[int]

def f(x: Args) -> str:
    return str(x["a"] * max(x["b"]))

runnable = RunnableLambda(f)
as_tool = runnable.as_tool()
as_tool.invoke({"a": 3, "b": [1, 2]})

dict输入，通过args_schema指定模式

from typing import Any, Dict, List
from langchain_core.pydantic_v1 import BaseModel, Field
from langchain_core.runnables import RunnableLambda

def f(x: Dict[str, Any]) -> str:
    return str(x["a"] * max(x["b"]))

class FSchema(BaseModel):
    """Apply a function to an integer and list of integers."""

    a: int = Field(..., description="Integer")
    b: List[int] = Field(..., description="List of ints")

runnable = RunnableLambda(f)
as_tool = runnable.as_tool(FSchema)
as_tool.invoke({"a": 3, "b": [1, 2]})

dict输入，通过arg_types指定模式

from typing import Any, Dict, List
from langchain_core.runnables import RunnableLambda

def f(x: Dict[str, Any]) -> str:
    return str(x["a"] * max(x["b"]))

runnable = RunnableLambda(f)
as_tool = runnable.as_tool(arg_types={"a": int, "b": List[int]})
as_tool.invoke({"a": 3, "b": [1, 2]})

字符串输入

from langchain_core.runnables import RunnableLambda

def f(x: str) -> str:
    return x + "a"

def g(x: str) -> str:
    return x + "z"

runnable = RunnableLambda(f) | g
as_tool = runnable.as_tool()
as_tool.invoke("b")

新版本0.2.14。

asyncastream(input: Input, config: Optional[RunnableConfig = None, **kwargs: Optional[Any]) → AsyncIterator[Output]¶

astream的默认实现，它调用ainvoke。子类应该覆盖此方法以支持流输出。

参数

input（《输入”）- Runnable的输入。
config（《可选”）[RunnableConfig]）- 要用于Runnable的配置。默认值为None。
kwargs (Optional[任何]) - 传递给Runnable的附加关键字参数。

产出

Runnable的输出。

返回类型

AsyncIterator[Output]

astream_events(input: Any, config: Optional[RunnableConfig] = None, *, version: Literal['v1', 'v2'], include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[Sequence[str]] = None, exclude_names: Optional[Sequence[str]] = None, exclude_types: Optional[Sequence[str]] = None, exclude_tags: Optional[Sequence[str]] = None, **kwargs: Any) → AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]¶

测试版

本API处于测试版，未来可能会有所变化。

生成事件流。

用于创建一个迭代器，该迭代器遍历提供实时信息有关Runnable的进度的StreamEvents，包括来自中间结果的StreamEvents。

StreamEvent是一个具有以下模式的字典

event：str - 事件名称的格式如下:
format: on_[runnable_type]_(start|stream|end).
name：str - 产生事件的Runnable的名称。
run_id: 字符串 - 与给定的一次执行相关的随机生成的ID。
它关联了发出事件的可运行对象。在父可运行对象的执行过程中被调用的子可运行对象将分配其自己的唯一ID。
parent_ids: 字符串列表 - 生成事件的父可运行对象的ID。
根可运行对象将有一个空列表。父ID的顺序是从根到直接父对象。仅适用于API的v2版本。API的v1版本将返回一个空列表。
tags: 可选的字符串列表 - 生成事件的可运行对象的标签。
metadata: 可选的字典（字符串到任何内容） - 生成事件的可运行对象的元数据。
data: 字典（字符串到任何内容）

以下表格展示了某些可能由各种链发出的事件。为了简洁，省略了元数据字段。链定义在表格之后。

请注意 此参考表是针对方案V2版本的。

事件	名称	数据块	输入	输出
on_chat_model_start	[模型名称]		{“messages”: [[系统消息，人类消息]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content="hello")
on_chat_model_end	[模型名称]		{“messages”: [[系统消息，人类消息]]}	AIMessageChunk(content="hello world")
on_llm_start	[模型名称]		{‘input’: 'hello’}
on_llm_stream	[模型名称]	‘Hello’
on_llm_end	[模型名称]		‘Hello human!’
on_chain_start	format_docs
on_chain_stream	format_docs	“hello world!, goodbye world!”
on_chain_end	format_docs		[文档(…)]	“hello world!, goodbye world!”
on_tool_start	some_tool		{“x”: 1, “y”: “2”}
on_tool_end	some_tool			{“x”: 1, “y”: “2”}
on_retriever_start	[检索器名称]		{“query”: “hello”}
on_retriever_end	[检索器名称]		{“query”: “hello”}	[文档(…), ..]
on_prompt_start	[模板名称]		{“question”: “hello”}
on_prompt_end	[模板名称]		{“question”: “hello”}	ChatPromptValue(messages: [SystemMessage, …])

除了标准事件外，用户还可以调度自定义事件（以下为示例）。

自定义事件仅可通过API的V2版本显示！

自定义事件具有以下格式

属性	类型	描述
名称	str	事件的用户定义名称。
data	Any	与事件相关联的数据。这可以是任何内容，尽管我们建议使其可序列化为JSON。

以下是与上述标准事件相关联的声明

format_docs:

def format_docs(docs: List[Document]) -> str:
    '''Format the docs.'''
    return ", ".join([doc.page_content for doc in docs])

format_docs = RunnableLambda(format_docs)

some_tool:

@tool
def some_tool(x: int, y: str) -> dict:
    '''Some_tool.'''
    return {"x": x, "y": y}

提示:

template = ChatPromptTemplate.from_messages(
    [("system", "You are Cat Agent 007"), ("human", "{question}")]
).with_config({"run_name": "my_template", "tags": ["my_template"]})

示例

from langchain_core.runnables import RunnableLambda

async def reverse(s: str) -> str:
    return s[::-1]

chain = RunnableLambda(func=reverse)

events = [
    event async for event in chain.astream_events("hello", version="v2")
]

# will produce the following events (run_id, and parent_ids
# has been omitted for brevity):
[
    {
        "data": {"input": "hello"},
        "event": "on_chain_start",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
    {
        "data": {"chunk": "olleh"},
        "event": "on_chain_stream",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
    {
        "data": {"output": "olleh"},
        "event": "on_chain_end",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
]

示例：调度自定义事件

from langchain_core.callbacks.manager import (
    adispatch_custom_event,
)
from langchain_core.runnables import RunnableLambda, RunnableConfig
import asyncio


async def slow_thing(some_input: str, config: RunnableConfig) -> str:
    """Do something that takes a long time."""
    await asyncio.sleep(1) # Placeholder for some slow operation
    await adispatch_custom_event(
        "progress_event",
        {"message": "Finished step 1 of 3"},
        config=config # Must be included for python < 3.10
    )
    await asyncio.sleep(1) # Placeholder for some slow operation
    await adispatch_custom_event(
        "progress_event",
        {"message": "Finished step 2 of 3"},
        config=config # Must be included for python < 3.10
    )
    await asyncio.sleep(1) # Placeholder for some slow operation
    return "Done"

slow_thing = RunnableLambda(slow_thing)

async for event in slow_thing.astream_events("some_input", version="v2"):
    print(event)

参数

input (任何内容) – Runnable的输入。
config (可选RunnableConfig) – 用于Runnable的配置。
version (字面量['v1', 'v2']) – 要使用的方案版本，可以是v2或v1。用户应使用v2。v1为向后兼容性而设计，将在0.4.0版本中弃用。默认值将在API稳定之前不分配。自定义事件仅在v2中显示。
include_names (可选[字符串序列]) – 仅包括具有匹配名称的可运行对象的事件。
include_types (可选[字符串序列]) – 仅包括具有匹配类型的可运行对象的事件。
include_tags (可选[字符串序列]) – 仅包括具有匹配标签的可运行对象的事件。
exclude_names (可选[字符串序列]) – 排除具有匹配名称的可运行对象的事件。
exclude_types (可选[序列[str]]) – 从具有匹配类型的runnables中排除事件。
exclude_tags (可选[序列[str]]) – 从具有匹配标签的runnables中排除事件。
kwargs (任意) – 传递给Runnable的附加关键字参数。这些将被传递给astream_log，因为astream_events的实现建立在astream_log之上。

产出

异步流式处理StreamEvents。

抛出

NotImplementedError – 如果版本不是v1或v2。

返回类型

AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]

batch(inputs: 列表[输入], config: 可选[联合[RunnableConfig, 列表[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: 可选[任意]) → 列表[输出]¶

默认实现使用线程池执行器并行运行调用。

默认的批量实现对I/O密集型可运行项工作良好。

子类应在其能够更有效地批处理时重写此方法；例如，如果底层的Runnable使用支持批处理模式的API。

参数

inputs (列表[输入]) –
config (可选[联合[RunnableConfig, 列表[RunnableConfig]]]) –
return_exceptions (bool) –
kwargs (可选[任意]) –

返回类型

List[输出]

batch_as_completed(inputs: 序列[输入], config: 可选[联合[RunnableConfig, 序列[RunnableConfig]]]]= None, *, return_exceptions: 布尔型 = False, **kwargs: 可选[任何值]) → 迭代器[元组[int, 联合[输出, Exception]]]¶

并行地在输入列表上运行调用，按完成的顺序产生结果。

参数

inputs (序列[输入]) –
config (可选[联合[RunnableConfig, 序列[RunnableConfig]]]) –
return_exceptions (bool) –
kwargs (可选[任意]) –

返回类型

迭代器[元组[int, 联合[输出, Exception]]]

configurable_alternatives(which: ConfigurableField, *, default_key: str = 'default', prefix_keys: bool = False, **kwargs: Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]) → RunnableSerializable[Input, Output]¶

为可以运行时设置的Runnables配置替代方案。

参数

which (ConfigurableField) – 用于选择替代方案的ConfigurableField实例。
default_key (str) – 如果未选择替代方案，则使用的默认键。默认为“default”。
prefix_keys (bool) – 是否在键前加上ConfigurableField id作为前缀。默认为False。
**kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到Runnable实例或返回Runnable实例的可调用对象字典。

返回

配置替代方案的新Runnable。

返回类型

RunnableSerializable[Input, Output]

from langchain_anthropic import ChatAnthropic
from langchain_core.runnables.utils import ConfigurableField
from langchain_openai import ChatOpenAI

model = ChatAnthropic(
    model_name="claude-3-sonnet-20240229"
).configurable_alternatives(
    ConfigurableField(id="llm"),
    default_key="anthropic",
    openai=ChatOpenAI()
)

# uses the default model ChatAnthropic
print(model.invoke("which organization created you?").content)

# uses ChatOpenAI
print(
    model.with_config(
        configurable={"llm": "openai"}
    ).invoke("which organization created you?").content
)

configurable_fields(**kwargs: Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) → RunnableSerializable[Input, Output]¶

在运行时配置特定的可运行对象（Runnable）字段。

参数: **kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) – 要配置的可配置字段实例的字典。
返回: 配置了字段的新的可运行对象。
返回类型: RunnableSerializable[Input, Output]

from langchain_core.runnables import ConfigurableField
from langchain_openai import ChatOpenAI

model = ChatOpenAI(max_tokens=20).configurable_fields(
    max_tokens=ConfigurableField(
        id="output_token_number",
        name="Max tokens in the output",
        description="The maximum number of tokens in the output",
    )
)

# max_tokens = 20
print(
    "max_tokens_20: ",
    model.invoke("tell me something about chess").content
)

# max_tokens = 200
print("max_tokens_200: ", model.with_config(
    configurable={"output_token_number": 200}
    ).invoke("tell me something about chess").content
)

invoke(input: Union[str, Dict, ToolCall], config: Optional[RunnableConfig] = None, **kwargs: Any) → Any¶

将单个输入转换为输出。重写以实现此功能。

参数

input (Union[str, Dict, ToolCall]) – 可运行对象的输入。
config (可选[RunnableConfig]) – 当调用Runnable时使用的配置。配置支持一些标准键，如用于跟踪目的的’tags’和‘metadata’，用于控制并行工作量的‘max_concurrency’以及其他键。请参阅RunnableConfig获取更多详细信息。
kwargs (Any) –

返回

Runnable的输出。

返回类型

Any

run(tool_input: Union[str, Dict[str, Any]], verbose: Optional[bool] = None, start_color: Optional[str] = 'green', color: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, run_id: Optional[UUID] = None, config: Optional[RunnableConfig] = None, tool_call_id: Optional[str] = None, **kwargs: Any) → Any¶

运行工具。

参数

tool_input (联合[str, Dict[str, Any]]) – 工具的输入。
verbose (Optional[bool]) – 是否记录工具的进度。默认为None。
start_color (Optional[str]) – 启动工具时使用的颜色。默认为‘green’。
color (Optional[str]) – 结束工具时使用的颜色。默认为‘green’。
callbacks (Optional[Union[List[BaseCallbackHandler]，BaseCallbackManager]]) – 工具执行期间要调用的回调。默认为None。
标签 (可选：标签列表[字符串]]) - 与工具相关联的标签列表，可选。默认为None。
元数据 (可选：字典[字符串，任意]]) - 与工具相关联的元数据，可选。默认为None。
运行名称 (可选：字符串) - 运行的名称。默认为None。
运行ID (可选：UUID) - 运行的ID。默认为None。
配置 (可选：RunnableConfig) - 工具的配置。默认为None。
工具调用ID (可选：字符串) - 工具调用的ID。默认为None。
额外参数 (任意) - 传递给工具的额外参数

返回

工具的输出。

抛出

工具异常 - 如果在执行工具过程中发生错误。

返回类型

Any

stream(input: Input, config: Optional[RunnableConfig], **kwargs: Optional[Any]) → 迭代器[Output]¶

stream的默认实现，它调用invoke。如果子类支持流式输出，则应重写此方法。

参数

input（《输入”）- Runnable的输入。
config（《可选”）[RunnableConfig]）- 要用于Runnable的配置。默认值为None。
kwargs (Optional[任何]) - 传递给Runnable的附加关键字参数。

产出

Runnable的输出。

返回类型

迭代器[输出]

to_json() → 联合[SerializedConstructor, SerializedNotImplemented]¶

将Runnable序列化为JSON。

返回: Runnable的JSON可序列化表示。
返回类型: 联合[SerializedConstructor, SerializedNotImplemented]

属性args : dict¶

属性is_single_input : bool¶: 工具是否只接受单个输入。

属性 tool_call_schema: 类型[BaseModel]¶

langchain_community.tools.azure_cognitive_services.text_analytics_health.AzureCogsTextAnalyticsHealthTool¶

`langchain_community.tools.azure_cognitive_services.text_analytics_health`.AzureCogsTextAnalyticsHealthTool¶