`langchain.agents.output_parsers.json`.JSONAgentOutputParser¶

注意

JSONAgentOutputParser实现了标准Runnable 接口。🏃

Runnable 接口在Runnable上提供了额外的方法，例如with_types、with_retry、assign、bind、get_graph等等。

class langchain.agents.output_parsers.json.JSONAgentOutputParser[源码]¶

基类: AgentOutputParser

解析JSON格式的工具调用和最终答案。

期望输出为以下两种格式之一。

如果输出指示应该执行某个操作，则应该采用以下格式。这将返回一个AgentAction。

``` {

“action”: “search”, “action_input”: “2+2”

}¶

如果输出指示应该给出最终答案，则应该采用以下格式。这将返回一个AgentFinish。

``` {

“action”: “Final Answer”, “action_input”: “4”

}¶

async abatch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → List[Output]¶

默认实现通过asyncio.gather并行运行ainvoke。

默认的批量实现对于IO密集型的Runnable运行效果良好。

如果子类可以更有效地批量处理，则应重写此方法；例如，如果底层Runnable使用支持批量模式的API。

参数

inputs (列表[输入]) – Runnable的输入列表。
config (可选[联合[RunnableConfig, 列表RunnableConfig]]]) – 调用Runnable时使用的配置。配置支持用于跟踪的标准键（如’tags’，‘metadata’），用于控制并行处理的多少工作的‘max_concurrency’，以及其他键。有关详细信息，请参阅RunnableConfig。默认为None。
return_exceptions (布尔) – 是否返回异常而不是抛出它们。默认为False。
kwargs (可选[任何]) – 传递给Runnable的额外关键字参数。

返回

从Runnable返回的输出列表。

返回类型

列表[输出]

async abatch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → AsyncIterator[Tuple[int, Union[Output, Exception]]]¶

在输入列表上并行运行runInvoker，按结果完成顺序返回结果。

参数

inputs (Sequence[Input]) – 可运行对象输入列表。
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用可运行对象时使用的配置。配置支持如‘tags’、‘metadata’等标准关键字，用于跟踪目的，‘max_concurrency’用于控制并行执行的工作量，以及其他关键字。请参考RunnableConfig获取更多详细信息。默认为None。
return_exceptions (布尔) – 是否返回异常而不是抛出它们。默认为False。
kwargs (可选[任何]) – 传递给Runnable的额外关键字参数。

返回

包含输入索引和可运行对象输出的元组。

返回类型

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

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

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

默认实现允许使用异步代码，即使 Runnable 没有实现 invoke 的本地异步版本。

如果子类可以异步运行，则应覆盖此方法。

参数

输入 (Union[str, BaseMessage]) –
配置 (Optional[RunnableConfig]) –
kwargs (Optional[Any]) –

返回类型

T

async aparse(text: str) → T¶

异步将单个字符串模型输出解析为某些结构。

参数: 文本 (str) – 语言模型的字符串输出。
返回: 结构化输出。
返回类型: T

async aparse_result(result: List[Generation], *, partial: bool = False) → T¶

异步将候选模型生成列表解析为特定格式。

返回值仅从结果中的第一个生成项解析得出，该生成项: 假定是最有可能的生成项。

参数

结果 (列表[Generation]) – 要解析的 Generations 列表。假定 Generations 是单个模型输入的不同候选输出。
部分 (布尔值) – 是否将输出解析为部分结果。这对于可以解析部分结果的解析器很有用。默认为 False。

返回

结构化输出。

返回类型

T

as_tool(args_schema: Optional[Type[BaseModel]], *, name: Optional[str], description: Optional[str], arg_types: Optional[Dict[str, Type]]) → BaseTool¶

Beta

此 API 处于测试阶段，未来可能会有所变化。

从可运行对象创建 BaseTool。

as_tool 将从一个可运行对象中实例化一个带有名称、描述和 args_schema 的 BaseTool。尽可能从 runnable.get_input_schema 推断模式。另一种情况（例如，如果可运行对象接受字典作为输入且具体的字典键未指定类型），可以使用 args_schema 直接指定模式。您也可以传递 arg_types 来仅指定所需的参数及其类型。

参数

args_schema (可选[Type[BaseModel]]) – 工具的模式。默认为 None。
name (可选[字符串]) – 工具的名称。默认为 None。
description (可选[字符串]) – 工具的描述。默认为 None。
arg_types (可选[字典[字符串, Type]]) – 参数名称到类型的字典。默认为 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 开始新增。

async astream(input: Input, config: Optional[RunnableConfig], **kwargs: Optional[Any]) → AsyncIterator[Output]¶

astream 的默认实现，它会调用 ainvoke。子类应覆盖此方法，如果它们支持流式输出。

参数

input (Input) – Runnable 的输入。
config (Optional[RunnableConfig]) –为 Runnable 使用的配置。默认为 None。
kwargs (可选[任何]) – 传递给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]]¶

Beta

此 API 处于测试阶段，未来可能会有所变化。

生成事件流。

用于创建对提供运行时进度实时信息的 StreamEvents 的迭代器，包括来自中间结果的 StreamEvents。

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

event: str - 事件名称的格式为
格式：on_[runnable_type]_(start|stream|end).
name: str - 生成事件的 Runnable 名称。
run_id: str - 与给定执行中的 Runnable 关联的随机生成的 ID。
与派生 Runnable 一起调用的接口作为父 Runnable 执行的一部分分配其自己的唯一 ID。
parent_ids: List[str] - 生成事件的父 Runnable 的 ID。
根 Runnable 将有一个空列表。父 ID 的顺序是从根到直接父级。仅适用于 API 的 v2 版本。API 的 v1 版本将返回一个空列表。
tags: Optional[List[str]] - 生成事件的 Runnable 的标签。
。
metadata: Optional[Dict[str, Any]] - 生成事件的 Runnable 的元数据。
。
data: Dict[str, Any]

以下表格说明了可能会由各种链发出的一些事件。为了简短，表中省略了元数据字段。在表格之后包括链定义。

注意此参考表是针对 schema 的 V2 版本。

`event`	`name`	`chunk`	输入	输出
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		[Document(…)]	"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”}	[Document(…), ..]
on_prompt_start	[模板名称]		{“question”: “hello”}
on_prompt_end	[模板名称]		{“question”: “hello”}	ChatPromptValue(messages: [SystemMessage, …])

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

自定义事件仅在 API 的 v2 版本中显示！

自定义事件的格式如下

属性	类型	描述
`name`	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 (Any) – Runnable 的输入。
config (Optional[RunnableConfig]) – 要为 Runnable 使用的配置。
version ( Literals [ 'v1' , 'v2' ]) – 要使用的模式版本，可以是 v2 或 v1。用户应使用 v2。 v1 用于向后兼容，将在 0.4.0 中弃用。在 API 稳定之前不会分配默认值。自定义事件仅在 v2 中显示。
include_names (Optional[Sequence[str]]) – 仅包括具有匹配名称的 Runnable 的事件。
include_types (Optional[Sequence[str]]) – 仅包括具有匹配类型的 Runnable 的事件。
include_tags (Optional[Sequence[str]]) – 仅包括具有匹配标签的 Runnable 的事件。
exclude_names (Optional[Sequence[str]]) – 排除具有匹配名称的 Runnable 的事件。
exclude_types (Optional[Sequence[str]]) – 排除具有匹配类型的 Runnable 的事件。
exclude_tags (Optional[Sequence[str]]) – 排除具有匹配标签的 Runnable 的事件。
kwargs (Any) – 传递给 Runnable 的额外关键字参数。这些将传递给 astream_log，因为 astream_events 的此实现建立在 astream_log 之上。

返回

StreamEvents 的异步流。

引发

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

返回类型

AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]

batch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → List[Output]¶

默认实现在线程池执行器中并行运行。

默认的批量实现对于IO密集型的Runnable运行效果良好。

如果子类可以更有效地批量处理，则应重写此方法；例如，如果底层Runnable使用支持批量模式的API。

参数

inputs (列表[输入]) –
config (可选[联合[可运行配置, 列表[可运行配置]]) –
return_exceptions (布尔值) –
kwargs (Optional[Any]) –

返回类型

列表[输出]

batch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]], *, return_exceptions: bool = False, **kwargs: Optional[Any]) → Iterator[Tuple[int, Union[Output, Exception]]]¶

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

参数

inputs (Sequence[Input]) –
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) –
return_exceptions (布尔值) –
kwargs (Optional[Any]) –

返回类型

Iterator[Tuple[int, Union[Output, 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) – 如果没有选择备选方案，则使用的默认键。默认为“默认”。
prefix_keys (bool) – 是否以 ConfigurableField id 作为键的前缀。默认为 False。
**kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到 Runnable 实例或返回 Runnable 实例的 callables 的字典。

返回

配置了备选方案的新 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]¶

在运行时配置特定的可运行字段。

参数: **kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) – 要配置的 ConfigurableField 实例的字典。
返回: 具有配置字段的新的可运行实例。
返回类型: 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
)

get_format_instructions() → str¶

关于如何格式化 LLM 输出的说明。

返回类型: str

invoke(input: Union[str, BaseMessage], config: Optional[RunnableConfig] = None) → T¶

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

参数

input (Union[str, BaseMessage]) – 对可运行实例的输入。
config (可选[RunnableConfig]) – 调用Runnable时使用的配置。配置支持标准键，如'tags'和'metadata'（用于跟踪目的），'max_concurrency'（用于控制并行执行的工作量）和其他键。请参阅RunnableConfig以获取更多详细信息。

返回

Runnable 的输出。

返回类型

T

parse(text: str) → Union[AgentAction, AgentFinish][源代码]¶

将文本解析为代理操作/完成。

参数: text (str) –
返回类型: Union[AgentAction, AgentFinish]

parse_result(result: List[Generation], *, partial: bool = False) → T¶

将候选模型生成列表解析为特定格式。

返回值仅从结果中的第一个生成项解析得出，该生成项: 假定是最有可能的生成项。

参数

结果 (列表[Generation]) – 要解析的 Generations 列表。假定 Generations 是单个模型输入的不同候选输出。
部分 (布尔值) – 是否将输出解析为部分结果。这对于可以解析部分结果的解析器很有用。默认为 False。

返回

结构化输出。

返回类型

T

parse_with_prompt(completion: str, prompt: PromptValue) → Any¶

使用输入提示解析LLM调用的输出。

提示主要用于当OutputParser想要重新尝试或以某种方式修复输出时，并需要从提示中获取信息。

参数

completion (str) - 语言模型的字符串输出。
prompt (PromptValue) – 输入PromptValue。

返回

结构化输出。

返回类型

Any

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

stream的默认实现，调用invoke。子类应覆盖此方法以支持流式输出。

参数

input (Input) – Runnable 的输入。
config (Optional[RunnableConfig]) –为 Runnable 使用的配置。默认为 None。
kwargs (可选[任何]) – 传递给Runnable的额外关键字参数。

返回

Runnable 的输出。

返回类型

输出的迭代器

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将可运行对象序列化为JSON。

返回: 可序列化为JSON的可运行对象表示。
返回类型: 联合[已序列化构造函数, 已序列化未实现]

langchain.agents.output_parsers.json.JSONAgentOutputParser¶

}¶

}¶

`langchain.agents.output_parsers.json`.JSONAgentOutputParser¶