`langchain.chains.retrieval_qa.base`.VectorDBQA¶

注意

VectorDBQA 实现了标准 Runnable 接口。🏃

Runnable 接口 还提供了在可运行代码中可用的额外方法，例如 with_types、with_retry、assign、bind、get_graph 等。

class langchain.chains.retrieval_qa.base.VectorDBQA[source]¶

基类: BaseRetrievalQA

面向矢量数据库的问答链。

param callback_manager: Optional[BaseCallbackManager] = None¶: 【弃用】请使用 callbacks 代替。

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

param combine_documents_chain: BaseCombineDocumentsChain [Required]¶: 用于组合文档的链。

param k: int = 4¶: 查询文档的数量。

param memory: Optional[BaseMemory] = None¶: 可选的内存对象。默认为 None。内存是一个在每条链的开始和结束时都会被调用的类。在开始时，内存加载变量并将它们传递给链。结束时，它将保存任何返回的变量。有许多不同类型的内存 - 请参阅内存文档以获取完整的目录。

param metadata: Optional[Dict[str, Any]] = None¶: 与链相关的可选元数据。默认为 None。此元数据将与每个链调用相关联，并作为参数传递给 callbacks 中定义的处理程序。您可以使用这些来识别特定链的使用情况。

param return_source_documents: bool = False¶: 是否返回源文档。

param search_kwargs: Dict[str, Any] [Optional]¶: 额外的搜索参数。

param search_type: str = 'similarity'¶: 用于向量和存储的搜索类型。可以是 similarity 或 mmr。

param tags: Optional[List[str]] = None¶: 与链相关联的可选标签列表。默认为 None。这些标签将与每次调用此链相关联，并将其作为参数传递给在 callbacks 中定义的处理程序。您可以使用这些标签来例如识别具有特定用例的链的特定实例。

param vectorstore: VectorStore [Required]¶: 要连接的矢量数据库。

param 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]] = 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。
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 中指定的所有输出: 。.

返回类型

Dict[str, Any]

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

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

批处理的默认实现对 I/O 密集型运行程序效果良好。

子类应在能够更有效地批处理时重写此方法；例如，如果基础 Runnable 使用支持批处理模式的 API。

参数

inputs (List[Input]) – Runnable 的输入列表。
config (可选，类型 Union[[RunnableConfig，List[[RunnableConfig]]]]) – 在调用Runnable时使用的配置。该配置支持标准键，如用于跟踪的‘tags’、‘metadata’，用于控制并行工作多少的‘max_concurrency’和其他键。请参阅RunnableConfig以获取更多详细信息。默认为None。

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

kwargs (可选，类型 Any) – 传递给Runnable的额外关键字参数。

返回

Runnable的输出列表。

返回类型

List[Output]

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

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

参数

inputs (可变序列，类型 Input) – Runnable的输入列表。
config（《可选》Union）- 在调用可运行程序时使用的配置。该配置支持标准键，如用于跟踪的’tags’、‘metadata’，用于控制并行工作量的’max_concurrency’以及其他键。请参阅RunnableConfig获取更多详细信息。默认为None。默认为None。
return_exceptions (布尔) – 是否返回异常而不是引发它们。默认为False。
kwargs (可选，类型 Any) – 传递给Runnable的额外关键字参数。

生成项

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

返回类型

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

async acall(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版本：请使用ainvoke代替。

异步执行链。

参数

inputs (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 中指定的所有输出: 。.

返回类型

Dict[str, Any]

async ainvoke(输入: Dict[str, Any], 配置: Optional[RunnableConfig] = None, **kwargs: Any) → Dict[str, Any]¶

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

默认实现允许在Runnable没有实现本地async版本的invoke时仍可使用async代码。

子类应在它们可以异步运行时重写此方法。

参数

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

返回类型

Dict[str, Any]

apply(输入列表: List[Dict[str, Any]], 回调: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) → List[Dict[str, str]]¶

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

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

参数

输入列表 (列表[字典[str, Any]]) –
回调函数 (可选[Union[列表[BaseCallbackHandler], BaseCallbackManager]]) –

返回类型

列表[字典[str, str]]

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

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

参数: inputs (Union[Dict[str, Any], Any]) – 原始输入的字典，或链期望只有一个参数时的单个输入。应包含 Chain.input_keys 中指定的所有输入，但不包括链内存将设置的输入。
返回: 所有输入的字典，包括由链内存添加的输入。
返回类型: 字典[str, str]

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

验证并准备链输出，并将本次运行的信息保存到内存中。

参数

inputs (Dict[str, str]) – 包括链内存添加的任何输入的链输入的字典。
outputs (Dict[str, str]) – 初始链输出的字典。
return_only_outputs (bool) – 是否仅返回链输出。如果为False，则输入也被添加到最终输出。

返回

最终链输出的字典。

返回类型

字典[str, str]

async arun)*args:Anycallbacks:Optional[Union[List[BaseCallbackHandler],BaseCallbackManager]]=Nonetags:Optional[List[str]]=Nonemetadata:Optional[Dict[str, Any]]=None**kwargs) → Any¶

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

执行链的便利方法。

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

参数

*args (Any) – 如果链期望一个输入，则可以作为唯一的位置参数传入。
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 用于此链运行的回调。这些回调将在构建链期间传递的回调之外调用，但只有这些运行时回调将传播到对其他对象的调用。
tags (Optional[List[str]]) – 要传递给所有回调的字符串标签列表。这些标签将在构建链期间传递的标签之外传递，但只有这些运行时标签将传播到对其他对象的调用。
**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 (可选[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 (可选，类型 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 - 事件名称遵循格式:
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 的元数据。
data: Dict[str, Any]

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

注意此参考表是针对 schema 的 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(内容=”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	事件的用户定义名称。
数据	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]]) – 仅包括具有匹配名称的runnables的事件。
include_types (Optional[Sequence[str]]) – 仅包括具有匹配类型的runnables的事件。
include_tags (Optional[Sequence[str]]) – 仅包括具有匹配标签的runnables的事件。
exclude_names (Optional[Sequence[str]]) – 排除具有匹配名称的runnables的事件。
exclude_types (Optional[Sequence[str]]) – 排除具有匹配类型的runnables的事件。
exclude_tags (Optional[Sequence[str]]) – 排除具有匹配标签的runnables的事件。
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]¶

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

批处理的默认实现对 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]¶

配置支持在运行时设置的 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 实例的 Callable 的字典。

返回

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

在运行时配置特定的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
)

classmethodfrom_chain_type(llm: BaseLanguageModel, chain_type: str = 'stuff', chain_type_kwargs: Optional[dict] = None, **kwargs: Any) → BaseRetrievalQA¶

从链类型加载链。

参数

llm (BaseLanguageModel) –
chain_type (str) –
chain_type_kwargs (Optional[dict]) –
kwargs (Any) –

返回类型

BaseRetrievalQA

classmethod from_llm(llm: BaseLanguageModel, prompt: Optional[PromptTemplate] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, llm_chain_kwargs: Optional[dict] = None, **kwargs: Any) → BaseRetrievalQA¶

从LLM初始化。

参数

llm (BaseLanguageModel) –
prompt (可选[PromptTemplate]) –
回调函数 (可选[Union[列表[BaseCallbackHandler], BaseCallbackManager]]) –
llm_chain_kwargs (可选[dict]) –
kwargs (Any) –

返回类型

BaseRetrievalQA

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

返回类型

Dict[str, Any]

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

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

参数: inputs (Union[Dict[str, Any], Any]) – 原始输入的字典，或链期望只有一个参数时的单个输入。应包含 Chain.input_keys 中指定的所有输入，但不包括链内存将设置的输入。
返回: 所有输入的字典，包括由链内存添加的输入。
返回类型: 字典[str, str]

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

验证并准备链输出，并将本次运行的信息保存到内存中。

参数

inputs (Dict[str, str]) – 包括链内存添加的任何输入的链输入的字典。
outputs (Dict[str, str]) – 初始链输出的字典。
return_only_outputs (bool) – 是否仅返回链输出。如果为False，则输入也被添加到最终输出。

返回

最终链输出的字典。

返回类型

字典[str, str]

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) – 如果链期望一个输入，则可以作为唯一的位置参数传入。
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 用于此链运行的回调。这些回调将在构建链期间传递的回调之外调用，但只有这些运行时回调将传播到对其他对象的调用。
tags (Optional[List[str]]) – 要传递给所有回调的字符串标签列表。这些标签将在构建链期间传递的标签之外传递，但只有这些运行时标签将传播到对其他对象的调用。
**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属性，并且内存不应该是: 空的。

参数: file_path (Union[Path, 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 (可选，类型 Any) – 传递给Runnable的额外关键字参数。

生成项

Runnable 的输出。

返回类型

Iterator[Output]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

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

返回: 可运行对象的JSON序列化表示。
返回类型: Union[SerializedConstructor, SerializedNotImplemented]

langchain.chains.retrieval_qa.base.VectorDBQA¶

`langchain.chains.retrieval_qa.base`.VectorDBQA¶