langchain.chains.router.multi_retrieval_qa.MultiRetrievalQAChain

注意

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

Runnable接口在runnables中还有一些额外的可用的方法,比如with_typeswith_retryassignbindget_graph等等。

class langchain.chains.router.multi_retrieval_qa.MultiRetrievalQAChain[source]

基类: MultiRouteChain

一个多路由链,它使用一个LLM路由器链来在检索qa链中进行选择。

参数 callback_manager: Optional[BaseCallbackManager] = None

已弃用。请使用callbacks代替。

参数 callbacks: Callbacks = None

可选的回调处理器(或回调管理器)列表。默认值为None。回调处理器在整个调用链的生命周期中被调用,从on_chain_start开始,到on_chain_endon_chain_error结束。每个自定义链可以可选地调用额外的回调方法,请参阅回调文档以获取详细信息。

参数 default_chain: Chain [必填]

当路由器无法将输入映射到任何目的地时,使用默认链。

参数 destination_chains: Mapping[str, BaseRetrievalQA] [必填]

输入可以路由到的候选链的映射。

参数 memory: 可选[BaseMemory] = None

可选的内存对象。默认为 None。内存是一个在每次链的开始和结束时被调用的类。在开始时,内存加载变量并在链中传递它们。在结束时,它保存任何返回的变量。有许多不同类型的内存 - 请参阅内存文档以获取完整目录。

参数 metadata: 可选[Dict[str, Any]] = None

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

参数 router_chain: LLMRouterChain [必填]

用于决定目标链及其输入的链。

参数 silent_errors: 布尔值 = False

如果为 True,则在提供无效的目标名称时使用默认链。默认为 False。

参数 :tags : Optional[List[str]] = None

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

参数 :verbose : bool [Optional]

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

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

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

执行链。

参数
  • 输入 (Union[Dict[str, Any], Any]) - 输入的字典,或者链式调用仅期望一个参数时使用单个输入。应包含所有在 Chain.input_keys 中指定的输入,但不包括由链式调用的内存设置的输入。

  • return_only_outputs (bool) - 是否仅返回响应中的输出。如果为 True,则仅返回此链式调用生成的新键。如果为 False,则返回输入键和此链式调用生成的新键。默认为 False。

  • callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) - 用于此链式调用的回调。这些回调将除在构建链式调用时传入的回调之外调用,但只有这些运行时回调会传递到对其他对象的调用。

  • tags (Optional[List[str]]) - 要传递到所有回调的字符串标签列表。这些将在构建链式调用时传递的标签之外传递,但只有这些运行时标签会传递到对其他对象的调用。

  • metadata (Optional[Dict[str, Any]]) - 与链式调用相关联的可选元数据。默认为 None。

  • include_run_info (bool) – 是否在响应中包含运行信息。默认为 False。

  • run_name (Optional[str]) –

返回:

命名输出的字典。应包含 Chain.output_keys 中指定的所有输出。

Chain.output_keys.

返回类型:

Dict[str, Any]

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

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

批处理的默认实现在 I/O 密集型可运行的任务上运行良好。

如果子类可以更有效地批量处理,则应该重写此方法;例如,如果底层的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 (可选[联合[RunnableConfig, Sequence[RunnableConfig]]]) - 调用Runnable时使用的配置。该配置支持标准键,如‘tags’、‘metadata’(用于追踪目的)、‘max_concurrency’(用于控制并行执行的工作量)和其他键。有关详细信息,请参阅RunnableConfig。默认值为None。默认值为None。

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

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

产生

从Runnable返回的输入和输出的索引的元组。

返回类型:

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

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

自版本 langchain==0.1.0 已弃用: 请使用 ainvoke 代替。

异步执行链。

参数
  • 输入 (Union[Dict[str, Any], Any]) - 输入的字典,或者链式调用仅期望一个参数时使用单个输入。应包含所有在 Chain.input_keys 中指定的输入,但不包括由链式调用的内存设置的输入。

  • return_only_outputs (bool) - 是否仅返回响应中的输出。如果为 True,则仅返回此链式调用生成的新键。如果为 False,则返回输入键和此链式调用生成的新键。默认为 False。

  • callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) - 用于此链式调用的回调。这些回调将除在构建链式调用时传入的回调之外调用,但只有这些运行时回调会传递到对其他对象的调用。

  • tags (Optional[List[str]]) - 要传递到所有回调的字符串标签列表。这些将在构建链式调用时传递的标签之外传递,但只有这些运行时标签会传递到对其他对象的调用。

  • metadata (Optional[Dict[str, Any]]) - 与链式调用相关联的可选元数据。默认为 None。

  • include_run_info (bool) – 是否在响应中包含运行信息。默认为 False。

  • run_name (Optional[str]) –

返回:

命名输出的字典。应包含 Chain.output_keys 中指定的所有输出。

Chain.output_keys.

返回类型:

Dict[str, Any]

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

ainvoke的默认实现,从另一个线程调用invoke。

默认实现允许即使Runnable没有实现invoke的本地async版本,也能使用async代码。

子类应该如果可以异步执行,则覆盖此方法。

参数
  • input (Dict[str, Any]) –

  • config (Optional[RunnableConfig]) –

  • kwargs (Any) –

返回类型:

Dict[str, Any]

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

自langchain==0.1.0以来已弃用:使用batch代替。

在列表中的所有输入上调用链。

参数
返回类型:

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

异步 aprep_inputs(inputs: 联合[字典[字符串, Any], Any]) 字典[字符串, 字符串]

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

参数

inputs (联合[字典[字符串, Any], Any]) – 原始输入的字典,或者链期望只有一个参数时的单个输入。应该包含在 Chain.input_keys 中指定的所有输入,除了由链的内存设置的输入。

返回:

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

返回类型:

字典[字符串,字符串]

异步 aprep_outputs(inputs: 字典[字符串, 字符串], outputs: 字典[字符串, 字符串], return_only_outputs: 布尔值 = False) 字典[字符串, 字符串]

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

参数
  • 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 代替。

执行链的便捷方法。

此方法与[cite:] Chain.__call__的区别在于,此方法期望直接以位置参数或关键字参数的形式传递输入,而 Chain.__call__期望一个包含所有输入的单个输入字典

参数
  • *args (<em>Any) – 如果链期望单个输入,它可以作为独立的位置参数传递。

  • callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) - 用于此链式调用的回调。这些回调将除在构建链式调用时传入的回调之外调用,但只有这些运行时回调会传递到对其他对象的调用。

  • tags (Optional[List[str]]) - 要传递到所有回调的字符串标签列表。这些将在构建链式调用时传递的标签之外传递,但只有这些运行时标签会传递到对其他对象的调用。

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

  • metadata (<em>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 (可选[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 (Input) – Runnable 的输入。

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

  • kwargs (Optional[Any]) – 要传递给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 - Event 事件的名称是以下格式

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

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

  • run_id: str - 与给定执行的 Runnable 关联的随机生成的 ID。

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

  • parent_ids: List[str] - 生成事件的父级 Runnable 的 ID。

    根 Runnable 将有一个空列表。父级 IDs 的顺序是从根到直接父级。只有在 API 的 v2 版本中可用。API 的 v1 版本将返回一个空列表。

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

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

以下是展示各种链可能产生的一些事件的表格。为了简洁,表省略了元数据字段。链定义在表格之后。

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

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

[Document(…)]

“hello world!, goodbye world!”

在工具启动时

某个工具

{“x”: 1, “y”: “2”}

在工具结束时

某个工具

{“x”: 1, “y”: “2”}

在检索器启动时

[检索器名称]

{“query”: “hello”}

在检索器结束时

[检索器名称]

{“query”: “hello”}

[文档(…), ..]

在提示启动时

[模板名称]

{“question”: “hello”}

在提示结束时

[模板名称]

{“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)

某个工具:

@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 (可选[序列[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 密集型可运行的任务上运行良好。

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

参数
  • inputs (列表[输入]) –

  • **config** (可选[联合[RunnableConfig, 列表[RunnableConfig]]]) –

  • **return_exceptions** (布尔值) –

  • **kwargs** (可选[任意]) –

返回类型:

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

在输入列表上并行运行调用,按完成顺序产出结果。

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

配置运行时可以设置的运行可根据选项。

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

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

参数

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

返回:

配置了字段的新的Runnable。

返回类型:

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_retrievers(llm: BaseLanguageModel, retriever_infos: List[Dict[str, Any]], default_retriever: Optional[BaseRetriever] = None, default_prompt: Optional[PromptTemplate] = None, default_chain: Optional[Chain] = None, *, default_chain_llm: Optional[BaseLanguageModel] = None, **kwargs: Any) MultiRetrievalQAChain[source]
参数
返回类型:

MultiRetrievalQAChain

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

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

参数
  • 输入 (Dict[str, Any]) – 可执行的输入。

  • 配置 (Optional[RunnableConfig]) – 在调用可执行时使用的配置。该配置支持用于跟踪的标签、元数据等标准键,'max_concurrency' 用于控制并行执行的工作量,以及其他键。请参阅 RunnableConfig 了解更多详情。

  • kwargs (Any) –

返回:

Runnable 的输出。

返回类型:

Dict[str, Any]

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

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

参数

inputs (联合[字典[字符串, Any], Any]) – 原始输入的字典,或者链期望只有一个参数时的单个输入。应该包含在 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 代替。

执行链的便捷方法。

此方法与[cite:] Chain.__call__的区别在于,此方法期望直接以位置参数或关键字参数的形式传递输入,而 Chain.__call__期望一个包含所有输入的单个输入字典

参数
  • *args (<em>Any) – 如果链期望单个输入,它可以作为独立的位置参数传递。

  • callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) - 用于此链式调用的回调。这些回调将除在构建链式调用时传入的回调之外调用,但只有这些运行时回调会传递到对其他对象的调用。

  • tags (Optional[List[str]]) - 要传递到所有回调的字符串标签列表。这些将在构建链式调用时传递的标签之外传递,但只有这些运行时标签会传递到对其他对象的调用。

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

  • metadata (<em>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 属性,并且内存为 null。

参数

文件路径 (Union[[Path, str]]) – 保存链的文件的路径。

返回类型:

示例

chain.save(file_path="path/chain.yaml")
stream(input: 输入, config: Optional[[RunnableConfig]] = None, **kwargs: Optional[Any]]) Iterator[Output]

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

参数
  • input (Input) – Runnable 的输入。

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

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

产生

Runnable 的输出。

返回类型:

Iterator[Output]

to_json() Union[[SerializedConstructor, SerializedNotImplemented]]

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

返回:

可序列化为JSON的Runnables表示。

返回类型:

Union[[SerializedConstructor, SerializedNotImplemented]