langchain.chains.mapreduce.MapReduceChain

注意事项

MapReduceChain 实现了标准 Runnable Interface。🏃

Runnable Interface 具备额外的可供调用的方法，比如 with_types、with_retry、assign、bind、get_graph 等等。

class langchain.chains.mapreduce.MapReduceChain

基类: Chain

映射-归约链。

param callback_manager: Optional[BaseCallbackManager] = None

[已弃用] 请使用 callbacks 代替。

param callbacks: Callbacks = None

可选的回调处理程序列表（或回调管理器）。默认值为 None。回调处理程序在调用链的生命周期中调用，从 on_chain_start 开始，以 on_chain_end 或 on_chain_error 结束。每个自定义链都可以选择调用额外的回调方法，请参阅回调文档以获取完整详细信息。

参 num: 参数名[必填]

用于组合文档的链。

参 memory: 可选[内存对象]) = None

可选的内存对象。默认为 None。内存对象会在链的开始和结束时被调用。在开始时，它加载变量并在链中传递。在结束时，它保存任何返回的变量。存在许多不同类型的内存 - 请参阅内存文档以查看完整的目录。

参 metadata: 可选[字典[str,Any]] = None

与链相关的可选元数据。默认为 None。此元数据将与链的每次调用相关联，并作为参数传递给在 callbacks 中定义的处理程序。您可以使用这些信息来识别链的一个特定实例及其用例。

参 tags: 可选[列表[str]] = None

与链相关的可选标签列表。默认为 None。这些标签将与链的每次调用相关联，并作为参数传递给在 callbacks 中定义的处理程序。您可以使用这些标签来识别链的一个特定实例及其用例。

参 text_splitter: 文本分割器[必填]

要使用的文本分割器。

参 verbose: 布尔值[可选]

是否以详细模式运行。在详细模式下，一些中间日志将被打印到控制台。默认为全局 verbose 值，可通过对 langchain.globals.get_verbose() 的调用访问。

__call__(inputs: Union[Dict[str, Any], Any], return_only_outputs: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, include_run_info: bool = False) → Dict[str, Any]

自langchain==0.1.0版本以来已弃用： 请使用invoke代替。

执行链。

参数

• inputs (Union[Dict[str, Any], Any]) – 输入字典，或者如果链只需要一个参数，则为单个输入。应包含所有由Chain.input_keys指定的输入，但不包括链的内存将设置的输入。

• return_only_outputs (bool) – 是否只在响应中返回输出。如果为True，则只返回此链生成的新键。如果为False，则返回输入键和由此链生成的新键。默认为False。

• 回调函数 (可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]) – 用于此链运行时使用的回调函数。这些将在链构造期间传递的回调函数之外被调用，但只有这些运行时回调将传播到对其他对象的调用。

• 标签 (可选[列表[字符串]]) – 要传递给所有回调函数的字符串标签列表。这些将除构造期间传递给链的标签之外还传递，但只有这些运行时标签将传播到对其他对象的调用。

• 元数据 (可选[字典[字符串，任意类型]]) – 与链相关联的可选元数据。默认为 None。

• 包含运行信息 (布尔型) – 是否将在响应中包含运行信息。默认为 False。

• 运行名称 (可选[字符串]) –

返回值

命名输出的字典。应包含在

Chain.output_keys中指定的所有输出。.

返回类型

字典[字符串, 任意类型]

异步 abatch(inputs: 列表[Input], config: 可选[联合[RunnableConfig, 列表[RunnableConfig]]] = None, **kwargs: 可选[任何类型]) → 列表[Output]¶

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

默认实现的批量处理方法适用于I/O密集型的可运行对象。

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

参数

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

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

• return_exceptions (布尔值) – 是否返回异常而不是引发它们。默认为False。

• kwargs (可选[任何]) – 要传递给Runnable的额外关键字参数。

返回值

Runnable的输出列表。

返回类型

List[输出]

async abatch_as_completed(inputs: Sequence[Input], config: 可选[Union[RunnableConfig, Sequence[RunnableConfig]]], *, return_exceptions: bool = False, **kwargs: 可选[任何]) → AsyncIterator[Tuple[int, Union[输出, 异常]]]¶

并行地在输入列表上运行ainvoke，随结果完成而返回。

参数

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

• config (可选[联合[RunnableConfig, Sequence[RunnableConfig]]]) – 在调用 Runnable 时使用的配置。此配置支持用于追踪的标准键，如 'tags'（标签）、'metadata'（元数据），以及用于控制并行工作量的 'max_concurrency'（最大并发数）等键。请参阅 RunnableConfig 获取更多详情。默认值为 None。默认值为 None。

• return_exceptions (布尔值) – 是否返回异常而不是引发它们。默认为False。

• kwargs (可选[任何]) – 要传递给Runnable的额外关键字参数。

产生

一个包含输入和输出索引的 Runnable 的元组。

返回类型

AsyncIterator[Tuple[int, 联合[Output, Exception]]]

async acall(inputs: Union[Dict[str, Any], Any], return_only_outputs: bool = False, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]], *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, include_run_info: bool = False) → Dict[str, Any]

自 langchain==0.1.0 版本以来已弃用： 请使用 ainvoke 代替。

异步执行链操作。

参数

• inputs (Union[Dict[str, Any], Any]) – 输入字典，或者如果链只需要一个参数，则为单个输入。应包含所有由Chain.input_keys指定的输入，但不包括链的内存将设置的输入。

• return_only_outputs (bool) – 是否只在响应中返回输出。如果为True，则只返回此链生成的新键。如果为False，则返回输入键和由此链生成的新键。默认为False。

• 回调函数 (可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]) – 用于此链运行时使用的回调函数。这些将在链构造期间传递的回调函数之外被调用，但只有这些运行时回调将传播到对其他对象的调用。

• 标签 (可选[列表[字符串]]) – 要传递给所有回调函数的字符串标签列表。这些将除构造期间传递给链的标签之外还传递，但只有这些运行时标签将传播到对其他对象的调用。

• 元数据 (可选[字典[字符串，任意类型]]) – 与链相关联的可选元数据。默认为 None。

• 包含运行信息 (布尔型) – 是否将在响应中包含运行信息。默认为 False。

• 运行名称 (可选[字符串]) –

返回值

命名输出的字典。应包含在

Chain.output_keys中指定的所有输出。.

返回类型

字典[字符串, 任意类型]

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

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

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

子类应在其可以异步运行的情况下重写此方法。

参数

• input (Dict[str, Any]) –

• config (Optional[RunnableConfig]) –

• kwargs (Any) –

返回类型

字典[字符串, 任意类型]

apply(input_list: List[Dict[str, Any]], callbacks: Optional[Union[BaseCallbackHandler], BaseCallbackManager]] = None) → List[Dict[str, str]]¶

自langchain==0.1.0版本以来已弃用：请使用batch。

对列表中的所有输入调用chain。

参数

• input_list (List[Dict[str, Any]]) –

• 回调 (可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]) –

返回类型

列表[字典[字符串, 字符串]]

async aprep_inputs(inputs: Union[Dict[str, Any], Any]) → Dict[str, str]

准备链输入，包括添加来自内存的输入。

参数

inputs (联合[字典[字符串, 任何值], 任何值]) – 原始输入的字典，或者如果链只需要一个参数，则为单个输入。应包含 Chain.input_keys 中指定的所有输入，除非输入将由链的内存设置。

返回值

包含链的内存添加的所有输入的字典。

返回类型

字典[字符串, 字符串]

async aprep_outputs(inputs: Dict[str, str], outputs: Dict[str, str], return_only_outputs: bool = False) → Dict[str, str]

验证和准备链输出，并保存此运行的详细信息到内存。

参数

• inputs (字典[字符串, 字符串]) – 包括由链记忆添加的输入的链输入字典。

• outputs (字典[字符串, 字符串]) – 初始链输出的字典。

• return_only_outputs (布尔值) – 是否仅返回链输出。如果为 False，则输入也被添加到最终输出中。

返回值

最终链输出的字典。

返回类型

字典[字符串, 字符串]

async arun(*args: Any, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

自 langchain==0.1.0 版本以来已弃用： 请使用 ainvoke 代替。

执行链的便捷方法。

此方法与Chain.__call__的主要区别在于，此方法期望直接作为位置参数或关键字参数传递输入，而Chain.__call__期望一个包含所有输入的单个输入字典。

参数

• *args (Any) – 如果链期望单个输入，则它可以作为唯一的位置参数传递。

• 回调函数 (可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]) – 用于此链运行时使用的回调函数。这些将在链构造期间传递的回调函数之外被调用，但只有这些运行时回调将传播到对其他对象的调用。

• 标签 (可选[列表[字符串]]) – 要传递给所有回调函数的字符串标签列表。这些将除构造期间传递给链的标签之外还传递，但只有这些运行时标签将传播到对其他对象的调用。

• **kwargs (Any) – 如果链期望多个输入，可以直接作为关键字参数传递。

• metadata (Optional[Dict[str, Any]]) –

• **kwargs –

返回值

链的输出。

返回类型

Any

示例

# Suppose we have a single-input chain that takes a 'question' string:
await chain.arun("What's the temperature in Boise, Idaho?")
# -> "The temperature in Boise is..."

# Suppose we have a multi-input chain that takes a 'question' string
# and 'context' string:
question = "What's the temperature in Boise, Idaho?"
context = "Weather report for Boise, Idaho on 07/03/23..."
await chain.arun(question=question, context=context)
# -> "The temperature in Boise is..."

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 (可选[字符串]) – 工具的名称。默认为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] = None, **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]]

测试版

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

生成事件流。

用于创建StreamEvents的迭代器，提供关于Runnable进度的实时信息，包括中间结果的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的第2版。API的第1版将返回空列表。

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

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

• data: Dict[str, Any]

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

注意 此参考表适用于第2版架构。

event	name	chunk	input	output
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		[文档(...)]	"hello world!, goodbye world!"
工具启动	某个工具		{“x”: 1, “y”: “2”}
工具结束	某个工具			{“x”: 1, “y”: “2”}
检索开始	检索者名称		{“query”: “hello”}
检索结束	检索者名称		{“query”: “hello”}	[文档(…), ..]
提示开始	模板名称		{“question”: “hello”}
提示结束	模板名称		{“question”: “hello”}	ChatPromptValue(messages: [SystemMessage, …])

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

自定义事件仅会在API的第2个版本中显示!

自定义事件的格式如下

属性	类型	描述
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)

某个工具:

@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 (可选[RunnableConfig]) – 用于Runnable的配置。

• version (文本['v1', 'v2']) – 要使用的模式版本：可以是v2或v1。用户应使用v2。 v1是向后兼容的，将在0.4.0中弃用。直到API稳定之前，将不会分配默认值。自定义事件仅在v2中显示。

• include_names (可选[序列[str]]) – 仅包括具有匹配名称的runnables的事件。

• include_types (可选[序列[str]]) – 仅包括具有匹配类型的runnables的事件。

• include_tags (可选[序列[str]]) – 仅包括具有匹配标签的runnables的事件。

• exclude_names (可选[序列[str]]) – 排除具有匹配名称的runnables的事件。

• exclude_types (可选[序列[str]]) – 排除具有匹配类型的runnables的事件。

• exclude_tags (可选[序列[str]]) – 排除具有匹配标签的runnables的事件。

• kwargs (任何) – 要传递给Runnable的额外关键字参数。这些将通过astream_log传递，因为astream_events的实现是建立在astream_log之上的。

产生

异步流式事件

触发

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]

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

默认实现的批量处理方法适用于I/O密集型的可运行对象。

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

参数

• inputs (列表输入]) –

• config (可选[Union[RunnableConfig, 列表[RunnableConfig]]]) –

• return_exceptions (布尔型) –

• kwargs (可选[任何类型]) –

返回类型

List[输出]

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 (布尔型) –

• kwargs (可选[任何类型]) –

返回类型

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) – 如果未选择替代方案，则使用此默认键。默认为“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]

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

参数

**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
)

classmethod from_params(llm: BaseLanguageModel, prompt: BasePromptTemplate, text_splitter: TextSplitter, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, combine_chain_kwargs: Optional[Mapping[str, Any]] = None, reduce_chain_kwargs: Optional[Mapping[str, Any]] = None, **kwargs: Any) → MapReduceChain

使用链构建一个用于map和reduce的map-reduce链。

参数

• llm (BaseLanguageModel) –

• prompt (BasePromptTemplate) –

• text_splitter (TextSplitter) –

• 回调 (可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]) –

• combine_chain_kwargs (Optional[Mapping[str, Any]]) –

• reduce_chain_kwargs (Optional[Mapping[str, Any]]) –

• kwargs (Any) –

返回类型

MapReduceChain

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

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

参数

• input (Dict[str, Any]) – Runnable的输入。

• config (Optional[RunnableConfig]) – 调用Runnable时使用的配置。配置支持标准键，如用于追踪的'tags'、'metadata'，用于控制并行工作量的'max_concurrency'以及其他键。请参阅RunnableConfig获取更多详细信息。

• kwargs (Any) –

返回值

Runnable的输出。

返回类型

字典[字符串, 任意类型]

prep_inputs(inputs: Union[Dict[str, Any], Any]) → Dict[str, str]

准备链输入，包括添加来自内存的输入。

参数

inputs (联合[字典[字符串, 任何值], 任何值]) – 原始输入的字典，或者如果链只需要一个参数，则为单个输入。应包含 Chain.input_keys 中指定的所有输入，除非输入将由链的内存设置。

返回值

包含链的内存添加的所有输入的字典。

返回类型

字典[字符串, 字符串]

prep_outputs(inputs: Dict[str, str], outputs: Dict[str, str], return_only_outputs: bool = False) → Dict[str, str]

验证和准备链输出，并保存此运行的详细信息到内存。

参数

• inputs (字典[字符串, 字符串]) – 包括由链记忆添加的输入的链输入字典。

• outputs (字典[字符串, 字符串]) – 初始链输出的字典。

• return_only_outputs (布尔值) – 是否仅返回链输出。如果为 False，则输入也被添加到最终输出中。

返回值

最终链输出的字典。

返回类型

字典[字符串, 字符串]

run(*args: Any, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

自langchain==0.1.0版本以来已弃用： 请使用invoke代替。

执行链的便捷方法。

此方法与Chain.__call__的主要区别在于，此方法期望直接作为位置参数或关键字参数传递输入，而Chain.__call__期望一个包含所有输入的单个输入字典。

参数

• *args (Any) – 如果链期望单个输入，则它可以作为唯一的位置参数传递。

• 回调函数 (可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]) – 用于此链运行时使用的回调函数。这些将在链构造期间传递的回调函数之外被调用，但只有这些运行时回调将传播到对其他对象的调用。

• 标签 (可选[列表[字符串]]) – 要传递给所有回调函数的字符串标签列表。这些将除构造期间传递给链的标签之外还传递，但只有这些运行时标签将传播到对其他对象的调用。

• **kwargs (Any) – 如果链期望多个输入，可以直接作为关键字参数传递。

• metadata (Optional[Dict[str, Any]]) –

• **kwargs –

返回值

链的输出。

返回类型

Any

示例

# Suppose we have a single-input chain that takes a 'question' string:
chain.run("What's the temperature in Boise, Idaho?")
# -> "The temperature in Boise is..."

# Suppose we have a multi-input chain that takes a 'question' string
# and 'context' string:
question = "What's the temperature in Boise, Idaho?"
context = "Weather report for Boise, Idaho on 07/03/23..."
chain.run(question=question, context=context)
# -> "The temperature in Boise is..."

save(file_path: Union[Path, str]) → None

保存链。

预期 Chain._chain_type 属性已实现，且内存为空。

None

参数

文件路径 (联合路径，str) – 保存链的文件的路径。

返回类型

None

示例

chain.save(file_path="path/chain.yaml")

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

返回类型

Iterator[Output]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]

将 Runnable 序列化为 JSON。

返回值

Runnable 的 JSON 序列化表示。

返回类型

Union[SerializedConstructor, SerializedNotImplemented]

使用 MapReduceChain 的示例

• 清单