`langchain_google_community.documentai_warehouse`.DocumentAIWarehouseRetriever¶

注意：

DocumentAIWarehouseRetriever 实现了标准 Runnable Interface。🏃

Runnable Interface 有额外的在 runnables 上可用的方法，例如 with_types、with_retry、assign、bind、get_graph 等。

class langchain_google_community.documentai_warehouse.DocumentAIWarehouseRetriever[source]¶

基类：BaseRetriever

基于 Document AI Warehouse 的检索器。

文档应在单独的流程中创建和上传。: 此检索器只使用提供的 Document AI schema_id 来搜索相关文档。

参数 location: str = 'us'¶: Document AI Warehouse 所在的 Google Cloud 位置。

参数 metadata: Optional[Dict[str, Any]] = None¶: 与检索器关联的可选元数据。默认为None。这些元数据将与该检索器的每次调用关联，并作为在回调中定义的处理器的参数传递。您可以使用它们来例如识别具有特定用例的检索器的特定实例。

参数project_number: str [必需]¶: Google Cloud项目编号，应仅包含数字。

参数qa_size_limit: int [默认=5]¶: 返回的文档数量限制。

参数schema_id: Optional[str] [默认=None]¶: 要查询的Document AI Warehouse模式。如果没有提供，将搜索项目中所有文档。

参数tags: Optional[List[str]] [默认=None]¶: 与检索器关联的可选标签列表。默认为None。这些标签将与该检索器的每次调用关联，并作为在回调中定义的处理器的参数传递。您可以使用它们来例如识别具有特定用例的检索器的特定实例。

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

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

默认批处理实现对于IO密集型的runnables运行良好。

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

参数

inputs （列表 [ 输入 ]）- Runnable的输入列表。
config （可选 [ 联合 [ RunnableConfig ，列表 [ RunnableConfig ] ]）- 调用Runnable时使用的配置。配置支持标准键如“标签”，“元数据”进行跟踪，'max_concurrency'用于控制并行执行的工作量，以及其他键。请参阅RunnableConfig获取更多详细信息。默认为None。
return_exceptions （布尔值）- 是否返回异常而不是引发异常。默认为False。
kwargs （可选 [ 任何 ]）- 传递给Runnable的额外关键字参数。

返回

Runnable的输出列表。

返回类型

列表 [ 输出 ]

异步的 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]]]¶

并行地对一系列输入调用runnable，随着它们的完成输出结果。

参数

inputs (Sequence[Input]) – Runnable的输入列表。
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用Runnable时使用的配置。配置支持诸如‘tags’、‘metadata’等用于追踪的标准键，用于控制并行工作的‘max_concurrency’等键。有关更多详细信息，请参阅RunnableConfig。默认为None。
return_exceptions （布尔值）- 是否返回异常而不是引发异常。默认为False。
kwargs （可选 [ 任何 ]）- 传递给Runnable的额外关键字参数。

产出：

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

返回类型

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

async aget_relevant_documents(query: str, *, callbacks: Callbacks = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, **kwargs: Any) → List[Document]¶

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

异步获取与查询相关的文档。

用户应优先使用 .ainvoke 或 .abatch，而不是直接使用 aget_relevant_documents。

参数

query (str) – 要查找相关文档的字符串。
callbacks (Callbacks) – 回调管理器或回调列表。
tags (Optional[List[str]]) – 相关检索器的可选标签列表。这些标签将关联到检索器的每次调用，并作为参数传递给在 callbacks 中定义的处理程序。默认为 None。
metadata (Optional[Dict[str, Any]]) – 相关检索器的可选元数据。这些元数据将关联到检索器的每次调用，并作为参数传递给在 callbacks 中定义的处理程序。默认为 None。
run_name (Optional[str]) – 运行可选择名称。默认为 None。
kwargs (Any) – 要传递给检索器的其他参数。

返回

相关文档列表。

返回类型

列表[Document]

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

异步调用检索器以获取相关文档。

异步检索器调用的主入口点。

参数

input (str) – 查询字符串。
config (Optional[RunnableConfig]) – 检索器的配置。默认为 None。
kwargs (Any) – 要传递给检索器的其他参数。

返回

相关文档列表。

返回类型

List[Document]

示例

await retriever.ainvoke("query")

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 将基于一个Runnable实例化一个具有名称、描述和 args_schema 的BaseTool。尽可能从 runnable.get_input_schema 推断模式。如果有必要（例如，Runnable接受一个字典作为输入并且具体的字典键无类型定义），可以使用 args_schema 直接指定模式。您还可以传递 arg_types 来仅指定所需的参数及其类型。

参数

args_schema (可选]类型[BaseModel]]) – 工具的模式。默认为None。
name (可选]str]) – 工具的名称。默认为None。
description (可选]str]) – 工具的描述。默认为None。
arg_types (可选]Dict[str, 类型]]) – 参数名称到类型的字典。默认为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 （可选 [ 任何 ]）- 传递给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的迭代器，它提供关于Runnable进度的实时信息，包括中间结果的StreamEvents。

StreamEvent是一个包含以下方案的字典

event: str - 事件名称格式为：
格式：on_[runnable_type]_(start|stream|end)。
name: str - 生成事件的Runnable的名称。
run_id: str - 与给定执行的随机生成的ID关联。
触发事件的可运行对象。作为父可运行对象执行部分而调用的子可运行对象会被分配其唯一的ID。
parent_ids： 列表[str] - 生成了事件的父可运行对象的ID。
根可运行对象将具有空列表。父ID的顺序是从根到直接父项。仅适用于API的v2版本。API的v1版本将返回空列表。
tags： Optional[List[str]] - 生成了事件的可运行对象的标签。
metadata： Optional[Dict[str, Any]] - 生成了事件的可运行对象的元数据。
data： Dict[str, Any]

以下是一个表格，说明了可能由各种链发射的一些事件。为了简洁起见，省略了元数据字段。链定义在表格之后。

注意本参考表是V2版本架构的。

事件	名称	块	输入	输出
on_chat_model_start	[模型名称]		{“消息”：[[系统消息，人类消息]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content="hello")
on_chat_model_end	[模型名称]		{“消息”：[[系统消息，人类消息]]}	AIMessageChunk(content="hello world")
on_llm_start	[模型名称]		{‘input’：’hello’}
on_llm_stream	[模型名称]	‘Hello’
on_llm_end	[模型名称]		‘Hello human!’
on_chain_start	格式化文档
on_chain_stream	格式化文档	“hello world！再见世界！”
on_chain_end	格式化文档		[Document(…)]	“hello world！再见世界！”
on_tool_start	某些工具		{“x”：1，“y”：”2”}
on_tool_end	某些工具			{“x”：1，“y”：”2”}
on_retriever_start	[检索器名称]		{“查询”：”hello”}
on_retriever_end	[检索器名称]		{“查询”：”hello”}	[Document(…), ..]
on_prompt_start	[模板名称]		{“问题”：”hello”}
on_prompt_end	[模板名称]		{“问题”：”hello”}	ChatPromptValue(messages: [SystemMessage, …])

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

自定义事件仅将在API的v2版本中可见！

自定义事件的格式如下

属性	类型	描述
名称	str	事件的用户定义名称。
data	Any	与事件相关联的数据。这可以是一切，尽管我们建议使其可序列化为JSON。

以下是与上述显示的标准事件相关的声明

格式化文档:

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)

参数

输入 (任何) - Runnable的输入。
配置 (Optional[RunnableConfig]) - 要为Runnable使用的配置。
版本 ( tipos Literales['v1', 'v2']) - 要使用的架构版本，可以是 vampire 2 或者 """v1""". 应使用 vampire 2。 "v1" 用于向后兼容，并在 0.4.0 中弃用。直到API稳定之前，不会分配默认值。自定义事件仅会在 "v2" 中可见。
包含名称 (Optional[Sequence[str]]) - 仅包含具有匹配名称的runnable的事件。
包含类型 (Optional[Sequence[str]]) - 仅包含具有匹配类型的runnable的事件。
包含标签 (Optional[Sequence[str]]) - 仅包含具有匹配标签的runnable的事件。
排除名称 (Optional[Sequence[str]]) - 排除具有匹配名称的runnable的事件。
exclude_types (可选[序列[str]]) – 排除与指定类型匹配的可执行事件。
exclude_tags (可选[序列[str]]) – 排除与指定标签匹配的可执行事件。
kwargs (任何类型) – 传递给Runnable的额外关键字参数。这些将作为astream_events的实现传递给astream_log，因为astream_events是建立在astream_log之上的。

产出：

异步流中的StreamEvents。

引发异常

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

返回类型

一个异步迭代器

batch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]]], *, return_exceptions: bool = False, **kwargs: Optional[任何类型]) → List[Output]¶

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

默认批处理实现对于IO密集型的runnables运行良好。

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

参数

inputs (列表[Input]) –
config (可选[Union[RunnableConfig, 列表[RunnableConfig]]]) –
return_exceptions (布尔型) –
kwargs (可选[任何类型]) –

返回类型

列表 [ 输出 ]

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 (可选[任何类型]) –

返回类型

迭代器[元组[int, 可选[输出, 异常]]]

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]]]) – 键到Runnables实例或返回Runnables实例的callables的字典。

返回

带有配置替代方案的新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]) – 要配置的可配置字段实例的字典。
返回: 一个字段已配置的新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
)

get_relevant_documents(query: str, *, callbacks: Callbacks = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, **kwargs: Any) → List[Document]

自版本 langchain-core==0.1.46 开始弃用：请使用 invoke 代替。

检索与查询相关的文档。

用户应优先使用 .invoke 或 .batch 而非直接使用 get_relevant_documents。

参数

query (str) – 要查找相关文档的字符串。
callbacks （回调） - 回调管理器或回调列表。默认值为 None。
tags (Optional[List[str]]) – 相关检索器的可选标签列表。这些标签将关联到检索器的每次调用，并作为参数传递给在 callbacks 中定义的处理程序。默认为 None。
metadata (Optional[Dict[str, Any]]) – 相关检索器的可选元数据。这些元数据将关联到检索器的每次调用，并作为参数传递给在 callbacks 中定义的处理程序。默认为 None。
run_name (Optional[str]) – 运行可选择名称。默认为 None。
kwargs (Any) – 要传递给检索器的其他参数。

返回

相关文档列表。

返回类型

列表[Document]

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

调用检索器以获取相关文档。

同步检索器调用的主入口点。

参数

input (str) – 查询字符串。
config (Optional[RunnableConfig]) – 检索器的配置。默认为 None。
kwargs (Any) – 要传递给检索器的其他参数。

返回

相关文档列表。

返回类型

List[Document]

示例

retriever.invoke("query")

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

stream 默认实现，调用 invoke 方法。子类应该覆盖此方法以支持流式输出。

参数

input (输入) – Runnable的输入。
config (可选]RunnableConfig]) – 用于Runnable的配置。默认为None。
kwargs （可选 [ 任何 ]）- 传递给Runnable的额外关键字参数。

产出：

Runnable的输出。

返回类型

Iterator[Output]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将 Runnable 序列化为 JSON。

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

langchain_google_community.documentai_warehouse.DocumentAIWarehouseRetriever¶

`langchain_google_community.documentai_warehouse`.DocumentAIWarehouseRetriever¶