langchain_core.output_parsers.string.StrOutputParser

注意 (Note)

StrOutputParser 实现了标准的 Runnable 接口。🏃

Runnable 接口 具有在 runnable 对象上可用的其他方法，例如 with_types, with_retry, assign, bind, get_graph，等等。

class langchain_core.output_parsers.string.StrOutputParser

基类： BaseTransformOutputParser[str]

OutputParser，将 LLMResult 解析为最可能的字符串。

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

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

batch 的默认实现非常适合 IO 绑定的 runnable 对象。

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

参数 (Parameters)

• 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 对象的其他关键字参数。

返回 (Returns)

来自 Runnable 对象的输出列表。

返回类型 (Return type)

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，并在结果完成时产生结果。

参数 (Parameters)

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

• config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用 Runnable 对象时使用的配置。配置支持标准键，如用于跟踪目的的“tags”、“metadata”，用于控制并行执行量的“max_concurrency”以及其他键。有关更多详细信息，请参阅 RunnableConfig。默认为 None。默认为 None。

• return_exceptions (bool) – 是否返回异常而不是引发异常。默认为 False。

• kwargs (Optional[Any]) – 传递给 Runnable 对象的其他关键字参数。

产生 (Yields)

输入索引和来自 Runnable 对象的输出的元组。

返回类型 (Return type)

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

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

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

即使 Runnable 对象未实现 invoke 的原生异步版本，默认实现也允许使用异步代码。

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

参数 (Parameters)

• input (Union[str, BaseMessage]) –

• config (Optional[RunnableConfig]) –

• kwargs (Optional[Any]) –

返回类型 (Return type)

T

async aparse(text: str) → T

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

参数 (Parameters)

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

返回 (Returns)

结构化输出 (Structured output)。

返回类型 (Return type)

T

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

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

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

被假定为最高可能性的 Generation。

参数 (Parameters)

• result (List[Generation]) – 要解析的 Generations 列表。Generations 被假定为单个模型输入的不同候选输出。

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

返回 (Returns)

结构化输出 (Structured output)。

返回类型 (Return type)

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

Beta

此 API 处于 Beta 阶段，将来可能会发生变化。

从 Runnable 对象创建 BaseTool。

as_tool 将从 Runnable 对象实例化具有名称、描述和 args_schema 的 BaseTool。在可能的情况下，模式从 runnable.get_input_schema 推断。或者（例如，如果 Runnable 对象将 dict 作为输入，并且未键入特定的 dict 键），可以使用 args_schema 直接指定模式。您也可以传递 arg_types 以仅指定必需的参数及其类型。

参数 (Parameters)

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

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

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

• arg_types (Optional[Dict[str, Type]]) – 参数名称到类型的字典。默认为 None。

返回 (Returns)

BaseTool 实例。

返回类型 (Return type)

BaseTool

类型化 dict 输入 (Typed dict input)

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

字符串输入 (String input)

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。如果子类支持流式输出，则应覆盖此方法。

参数 (Parameters)

• input (Input) – Runnable 对象的输入。

• config (Optional[RunnableConfig]) – 用于 Runnable 对象的配置。默认为 None。

• kwargs (Optional[Any]) – 传递给 Runnable 对象的其他关键字参数。

产生 (Yields)

Runnable 对象的输出。

返回类型 (Return type)

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 处于 Beta 阶段，将来可能会发生变化。

生成事件流。

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

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

• event: str - 事件名称的格式为：

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

• name: str - 生成事件的 Runnable 对象的名称。

• run_id: str - 随机生成的 ID，与发出事件的给定 Runnable 对象的执行相关联。作为父 Runnable 对象执行的一部分调用的子 Runnable 对象被分配其自己的唯一 ID。

  the Runnable that emitted the event. A child Runnable that gets invoked as part of the execution of a parent Runnable is assigned its own unique ID.

• parent_ids: List[str] - 生成事件的父 runnable 对象的 ID 列表。

  生成事件的父 runnable 对象的 ID 列表。根 Runnable 对象将具有一个空列表。父 ID 的顺序是从根到直接父级。仅适用于 API 的 v2 版本。API 的 v1 版本将返回一个空列表。

• tags: Optional[List[str]] - 生成事件的 Runnable 对象的标签。

  the event.

• metadata: Optional[Dict[str, Any]] - 生成事件的 Runnable 对象的元数据。

  that generated the event.

• data: Dict[str, Any]

下面是一个表格，说明了各种链可能发出的一些事件。为了简洁起见，元数据字段已从表中省略。链定义已包含在表格之后。

注意 此参考表适用于模式的 V2 版本。

事件 (event)	名称 (name)	块 (chunk)	输入 (input)	输出 (output)
on_chat_model_start	[模型名称] ([model name])		{“messages”: [[SystemMessage, HumanMessage]]}
on_chat_model_stream	[模型名称] ([model name])	AIMessageChunk(content=”hello”)
on_chat_model_end	[模型名称] ([model name])		{“messages”: [[SystemMessage, HumanMessage]]}	AIMessageChunk(content=”hello world”)
on_llm_start	[模型名称] ([model name])		{‘input’: ‘hello’}
on_llm_stream	[模型名称] ([model name])	‘Hello’
on_llm_end	[模型名称] ([model name])		‘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	[检索器名称] ([retriever name])		{“query”: “hello”}
on_retriever_end	[检索器名称] ([retriever name])		{“query”: “hello”}	[Document(…), ..]
on_prompt_start	[模板名称] ([template_name])		{“question”: “hello”}
on_prompt_end	[模板名称] ([template_name])		{“question”: “hello”}	ChatPromptValue(messages: [SystemMessage, …])

除了标准事件，用户还可以调度自定义事件（请参阅下面的示例）。

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

自定义事件具有以下格式

属性 (Attribute)	类型 (Type)	描述 (Description)
名称 (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}

prompt:

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

示例 (Example)

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": [],
    },
]

示例：调度自定义事件 (Example: Dispatch Custom Event)

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)

参数 (Parameters)

• 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 构建的。

产生 (Yields)

StreamEvents 的异步流。

引发 (Raises)

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

返回类型 (Return type)

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。

batch 的默认实现非常适合 IO 绑定的 runnable 对象。

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

参数 (Parameters)

• inputs (List[Input]) –

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

• return_exceptions (bool) –

• kwargs (Optional[Any]) –

返回类型 (Return type)

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，并在结果完成时生成结果。

参数 (Parameters)

• inputs (Sequence[Input]) –

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

• return_exceptions (bool) –

• kwargs (Optional[Any]) –

返回类型 (Return type)

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 的备选项。

参数 (Parameters)

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

• default_key (str) – 如果未选择备选项，则使用的默认键。默认为“default”。

• prefix_keys (bool) – 是否使用 ConfigurableField id 作为键的前缀。默认为 False。

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

返回 (Returns)

配置了备选项的新 Runnable。

返回类型 (Return type)

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 字段。

参数 (Parameters)

**kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) – 要配置的 ConfigurableField 实例的字典。

返回 (Returns)

配置了字段的新 Runnable。

返回类型 (Return type)

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 输出的说明。

返回类型 (Return type)

str

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

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

参数 (Parameters)

• input (Union[str, BaseMessage]) – Runnable 的输入。

• config (Optional[RunnableConfig]) – 调用 Runnable 时使用的配置。该配置支持标准键，如用于跟踪目的的“tags”、“metadata”，用于控制并行执行量的“max_concurrency”以及其他键。有关更多详细信息，请参阅 RunnableConfig。

返回 (Returns)

Runnable 对象的输出。

返回类型 (Return type)

T

parse(text: str) → str

返回输入文本，不做任何更改。

参数 (Parameters)

text (str) –

返回类型 (Return type)

str

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

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

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

被假定为最高可能性的 Generation。

参数 (Parameters)

• result (List[Generation]) – 要解析的 Generations 列表。Generations 被假定为单个模型输入的不同候选输出。

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

返回 (Returns)

结构化输出 (Structured output)。

返回类型 (Return type)

T

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

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

主要提供提示是为了在 OutputParser 想要重试或以某种方式修复输出时，需要来自提示的信息来执行此操作。

参数 (Parameters)

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

• prompt (PromptValue) – 输入 PromptValue。

返回 (Returns)

结构化输出 (Structured output)。

返回类型 (Return type)

Any

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

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

参数 (Parameters)

• input (Input) – Runnable 对象的输入。

• config (Optional[RunnableConfig]) – 用于 Runnable 对象的配置。默认为 None。

• kwargs (Optional[Any]) – 传递给 Runnable 对象的其他关键字参数。

产生 (Yields)

Runnable 对象的输出。

返回类型 (Return type)

Iterator[Output]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]

将 Runnable 序列化为 JSON。

返回 (Returns)

Runnable 的 JSON 可序列化表示。

返回类型 (Return type)

Union[SerializedConstructor, SerializedNotImplemented]

使用 StrOutputParser 的示例

• # Oracle Cloud Infrastructure Generative AI

• AI21LLM

• Apache Cassandra

• AskNews

• Astra DB

• 构建本地 RAG 应用程序

• 构建基于 SQL 数据的问答系统

• 构建检索增强生成 (RAG) 应用程序

• 构建简单的 LLM 应用程序

• ChatOllama

• DSPy

• Facebook Messenger

• Fiddler

• Fleet AI Context

• 如何添加聊天记录

• 如何向 Runnable 添加默认调用参数

• 如何向 runnable 添加回退

• 如何向聊天机器人添加检索

• 如何向链的状态添加值

• 如何链接 runnables

• 如何创建动态（自构建）链

• 如何进行每用户检索

• 如何在 SQL 问答中进行查询验证

• 如何对 CSV 进行问题解答

• 如何让 RAG 应用程序添加引用

• 如何让您的 RAG 应用程序返回来源

• 如何检查 runnables

• 如何在并行调用 runnables

• 如何将值映射到图数据库

• 如何将参数从一个步骤传递到下一步

• 如何使用每个文档的多个向量进行检索

• 如何在子链之间路由

• 如何运行自定义函数

• 如何流式传输 runnables

• 混合搜索

• Jaguar Vector Database

• Maritalk

• Milvus 混合搜索

• NVIDIA NIMs

• NVIDIA NIMs

• OpaquePrompts

• Tavily Search API

• UpTrain

• Vectara

• Volc Engine Maas

• Weaviate

• You.com

• ZepCloudChatMessageHistory

• iMessage