langchain_core.output_parsers.list.NumberedListOutputParser

注意：

数字列表输出解析器（NumberedListOutputParser）实现了标准 Runnable 接口。🏃

Runnable 接口 在可运行对象上提供了额外的功能，如 with_types，with_retry，assign，bind，get_graph 等。

class langchain_core.output_parsers.list.NumberedListOutputParser[source]

基类：ListOutputParser

解析编号列表。

param pattern: str = '\\d+\\.\\s([^\\n]+)'

用于匹配编号列表项的模式。

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

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

默认的批处理实现对I/O绑定型runables运行效果良好。

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

参数

  • inputs (List[Input]) – Runnable的输入列表。

  • config (Optional[Union[RunnableConfig, List[RunnableConfig]]]) – 调用Runnable时要使用的配置。配置支持标准的键，如用于跟踪的‘tags’，‘metadata’，用于控制并行工作量的‘max_concurrency’以及其他键。请参阅RunnableConfig获取更多详细信息。默认为None。

  • return_exceptions (bool) – 是否返回异常而不是抛出它们。默认为False。

  • kwargs (Optional[Any]) – 要传递给Runnable的附加关键字参数。

返回

Runnable的输出列表。

返回类型

List[Output]

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]]]

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

参数

  • inputs (Sequence[Input]) – Runnable的输入列表。

  • config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用Runnable时使用的配置。该配置支持标准键，如‘tags’、‘metadata’用于跟踪目的，‘max_concurrency’用于控制并行工作的数量，以及其他键。请参阅RunnableConfig获取更多详情。默认值为None。

  • return_exceptions (bool) – 是否返回异常而不是抛出它们。默认为False。

  • kwargs (Optional[Any]) – 要传递给Runnable的附加关键字参数。

产生

输入索引和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 的本地异步版本，也能使用异步代码。

子类应覆盖此方法，如果它们能异步运行的话。

参数
返回类型

T

async aparse(text: str) → T

异步解析单个字符串模型输出到某种结构。

参数

text (str) – 语言模型的字符串输出。

返回

结构化输出。

返回类型

T

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

异步解析候选模型生成结果的列表到特定格式。

返回值仅从中解析第一个 Generation 的结果，这

被认为是可能性最高的 Generation。

参数

  • result (列表[(生成)] – 要解析的生成列表。假设生成是针对单个模型输入的不同候选输出。

  • partial (布尔值) – 是否将输出解析为部分结果。这对于可以解析部分结果的解析器很有用。默认为False。

返回

结构化输出。

返回类型

T

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

测试版

此API处于测试版，未来可能会更改。

从可运行对象创建BaseTool。

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

参数

  • args_schema (可选[Type[BaseModel]]) – 工具的模式。默认值为None。

  • name (可选[str]) – 工具的名称。默认值为None。

  • description (可选[str]) – 工具的描述。默认值为None。

  • arg_types (可选[Dict[str, 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] = None, **kwargs: Optional[Any]) → AsyncIterator[Output]

astream的默认实现，它调用ainvoke。子类应在它们支持流式输出时重写此方法。

参数

  • input (输入) – Runnable的输入。

  • config (可选[RunnableConfig]) – 使用Runnable的配置。默认为None。

  • kwargs (Optional[Any]) – 要传递给Runnable的附加关键字参数。

产生

Runnable的输出。

返回类型

AsyncIterator[输出]

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处于测试版，未来可能会更改。

生成事件流。

用于创建StreamEvents的迭代器，这些StreamEvents提供了Runnable进度的实时信息，包括来自中间结果的StreamEvents。

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

  • event: 字符串 - 事件名称的格式为:

    on_[runnable_type]_(start|stream|end)。

  • name: 字符串 - 生成事件的Runnable的名称。

  • run_id: 字符串 - 与Runnable的给定执行相关联的随机生成的ID。

    作为父Runnable执行部分调用的子Runnable将被分配其自己的唯一ID。

  • parent_ids: 字符串列表 - 生成事件的父Runnable的ID。

    根Runnable将有一个空列表。父ID的顺序是从根到直接父级。仅在API的第2版本中可用。API的第1版本将返回一个空列表。

  • tags: 可选的字符串列表 - 生成事件的Runnable的标记。

  • metadata: 可选的字典[字符串, Any] - 生成事件的Runnable的元数据。

  • data：Dict[str, Any]

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

注意 此参考表是针对该模式的 V2 版本的。

事件

名称

块

输入

输出

on_chat_model_start

[模型名称]

{“messages”: [[SystemMessage, HumanMessage]]}

on_chat_model_stream

[模型名称]

AIMessageChunk(content=”hello”)

on_chat_model_end

[模型名称]

{“messages”: [[SystemMessage, HumanMessage]]}

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 版本中呈现！

自定义事件具有以下格式

属性

类型

描述

名称

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 (Literal['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]

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

默认的批处理实现对I/O绑定型runables运行效果良好。

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

参数

  • inputs (List[Input]) –

  • config (Optional[Union[RunnableConfig, List[RunnableConfig]]]) –

  • return_exceptions (bool) –

  • kwargs (Optional[Any]) –

返回类型

List[Output]

batch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]] = None, *, 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 (bool) –

  • 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]

配置可以在运行时设置的运行时的备选方案。

参数

  • which (ConfigurableField) – 将用于选择备选方案的 ConfigurableField 实例。

  • default_key (str) – 未选择备选方案时使用的默认键。默认为“default”。

  • prefix_keys (bool) – 是否以前缀形式添加 ConfigurableField id 到键。默认为 False。

  • **kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到运行时实例或返回运行时实例的可调用对象的字典。

返回

配置了备选方案的新运行时。

返回类型

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[source]

LLM输出应该如何格式化的说明。

返回类型

str

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

将单个输入转换为输出。覆盖以实现。

参数

  • 输入 (Union[字符串, BaseMessage]) – Runnable的输入。

  • 配置 (Optional[RunnableConfig]) – 在调用Runnable时使用的配置。配置支持标准的键值对，如用于跟踪的‘tags’、‘metadata’，用于控制并发的‘max_concurrency’以及其他键。请参阅RunnableConfig获取更多详细信息。

返回

Runnable的输出。

返回类型

T

parse(text: 字符串) → 字符串列表[字符串][来源]

解析LLM调用的输出。

参数

文本 (字符串) – LLM调用的输出。

返回

字符串列表。

返回类型

列表[字符串]

parse_iter(text: 字符串) → 迭代器[匹配][来源]

解析LLM调用的输出。

参数

文本 (字符串) – LLM调用的输出。

产生

每个输出部分的匹配对象。

返回类型

迭代器[匹配]

parse_result(result: 列表[Generation], *, partial: 布尔值 = False) → T

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

返回值仅从中解析第一个 Generation 的结果，这

被认为是可能性最高的 Generation。

参数

  • result (列表[(生成)] – 要解析的生成列表。假设生成是针对单个模型输入的不同候选输出。

  • partial (布尔值) – 是否将输出解析为部分结果。这对于可以解析部分结果的解析器很有用。默认为False。

返回

结构化输出。

返回类型

T

parse_with_prompt(completion: 字符串, prompt: PromptValue) → Any

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

当OutputParser需要重试或以某种方式修复输出时，通常会提供提示信息，并且需要提示信息来进行操作。

参数

  • 完成 (字符串) – 语言模型的字符串输出。

  • 提示 (PromptValue) – 输入 PromptValue。

返回

结构化输出。

返回类型

Any

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

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

参数

  • input (输入) – Runnable的输入。

  • config (可选[RunnableConfig]) – 使用Runnable的配置。默认为None。

  • kwargs (Optional[Any]) – 要传递给Runnable的附加关键字参数。

产生

Runnable的输出。

返回类型

Iterator[Output]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]

将可运行的组件序列化为 JSON。

返回

可序列化的 Runnable 表现。

返回类型

Union[SerializedConstructor, SerializedNotImplemented]