langchain_community.retrievers.google_vertex_ai_search.GoogleVertexAISearchRetriever

注意 (Note)

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

Runnable 接口 在可运行对象上还有其他可用方法,例如 with_typeswith_retryassignbindget_graph 等。

class langchain_community.retrievers.google_vertex_ai_search.GoogleVertexAISearchRetriever[源代码]

基类:BaseRetriever, _BaseGoogleVertexAISearchRetriever

版本 0.0.33 中已弃用: 请使用 langchain_google_community.VertexAISearchRetriever 代替。

Google Vertex AI Search 检索器。

有关 Vertex AI Search 概念和配置参数的详细说明,请参阅产品文档。 https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction

初始化私有字段。

param credentials: Any = None

进行 API 调用时使用的默认自定义凭据 (google.auth.credentials.Credentials)。如果未提供,凭据将从环境中获取。

param data_store_id: Optional[str] = None

Vertex AI Search 数据存储 ID。

param engine_data_type: int = 0

定义 Vertex AI Search 应用程序数据类型 0 - 非结构化数据 1 - 结构化数据 2 - 网站数据 3 - 混合搜索

约束 (Constraints)
  • 最小值 (minimum) = 0

  • 最大值 (maximum) = 3

param filter: Optional[str] = None

过滤器表达式 (Filter expression)。

param get_extractive_answers: bool = False

如果为 True,则返回抽取式答案 (Extractive Answers),否则返回抽取式片段 (Extractive Segments) 或代码段 (Snippets)。

param location_id: str = 'global'

Vertex AI Search 数据存储位置。

param max_documents: int = 5

要返回的最大文档数。

约束 (Constraints)
  • 最小值 (minimum) = 1

  • 最大值 (maximum) = 100

param max_extractive_answer_count: int = 1

每个搜索结果中返回的最大抽取式答案数。每个 SearchResult 最多返回 5 个答案。

约束 (Constraints)
  • 最小值 (minimum) = 1

  • 最大值 (maximum) = 5

param max_extractive_segment_count: int = 1

每个搜索结果中返回的最大抽取式片段数。目前,每个 SearchResult 将返回一个片段。

约束 (Constraints)
  • 最小值 (minimum) = 1

  • 最大值 (maximum) = 1

param metadata: Optional[Dict[str, Any]] = None

与检索器关联的可选元数据。默认为 None。此元数据将与对此检索器的每次调用关联,并作为参数传递给 callbacks 中处理程序。您可以使用这些元数据来标识检索器的特定实例及其用例。

param project_id: str [必填]

Google Cloud 项目 ID。

param query_expansion_condition: int = 1

用于确定在何种条件下进行查询扩展的规范。 0 - 未指定的查询扩展条件。在这种情况下,服务器行为默认为

禁用 (disabled)

1 - 禁用查询扩展。即使 SearchResponse.total_size 为零,也仅使用精确搜索查询。

SearchResponse.total_size 为零。

2 - 由 Search API 构建的自动查询扩展。

约束 (Constraints)
  • 最小值 (minimum) = 0

  • 最大值 (maximum) = 2

param search_engine_id: Optional[str] = None

Vertex AI Search 应用程序 ID。

param serving_config_id: str = 'default_config'

Vertex AI Search 服务配置 ID。

param spell_correction_mode: int = 2

用于确定在何种条件下进行查询扩展的规范。 0 - 未指定的拼写校正模式。在这种情况下,服务器行为默认为

自动 (auto)。

1 - 仅建议 (Suggestion only)。如果存在任何拼写建议,Search API 将尝试查找并在 SearchResponse.corrected_query 中放入。拼写建议不会用作搜索查询。

和放入 SearchResponse.corrected_query。拼写建议不会用作搜索查询。

2 - 由 Search API 构建的自动拼写校正。

如果找到,搜索将基于更正后的查询。

约束 (Constraints)
  • 最小值 (minimum) = 0

  • 最大值 (maximum) = 2

param tags: Optional[List[str]] = None

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

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 使用支持批量模式的 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 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

参数 (Parameters)
  • query (str) – 用于查找相关文档的字符串。

  • callbacks (Callbacks) – 回调管理器或回调列表。

  • tags (Optional[List[str]]) – 与检索器关联的可选标签列表。这些标签将与对此检索器的每次调用关联,并作为参数传递给 callbacks 中定义的处理程序。默认为 None。

  • metadata (Optional[Dict[str, Any]]) – 与检索器关联的可选元数据。此元数据将与对此检索器的每次调用关联,并作为参数传递给 callbacks 中定义的处理程序。默认为 None。

  • run_name (Optional[str]) – 运行的可选名称。默认为 None。

  • kwargs (Any) – 传递给检索器的其他参数。

返回 (Returns)

相关文档列表。

返回类型 (Return type)

List[Document]

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

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

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

参数 (Parameters)
  • input (str) – 查询字符串。

  • config (Optional[RunnableConfig]) – 检索器的配置。默认为 None。

  • kwargs (Any) – 传递给检索器的其他参数。

返回 (Returns)

相关文档列表。

返回类型 (Return type)

List[Document]

示例 (Examples)

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

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 (可选[Type[BaseModel]]) – 工具的模式。默认为 None。

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

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

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

返回 (Returns)

一个 BaseTool 实例。

返回类型 (Return type)

BaseTool

Typed dict 输入

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

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

  • config (可选[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 - 与给定 Runnable 执行关联的随机生成的 ID,该 Runnable 发出事件。作为父 Runnable 执行一部分被调用的子 Runnable 被分配自己的唯一 ID。

    Runnable 发出事件的给定执行的随机生成 ID。作为父 Runnable 执行一部分被调用的子 Runnable 被分配了自己的唯一 ID。

  • parent_ids: List[str] - 生成事件的父 runnable 的 ID 列表。根 Runnable 将有一个空列表。父 ID 的顺序是从根到直接父级。仅适用于 API 的 v2 版本。API 的 v1 版本将返回一个空列表。

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

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

    生成事件的 Runnable 的标签。

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

    生成事件的 Runnable 的元数据。

  • data: Dict[str, Any]

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

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

事件

名称

输入

输出

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!”

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 版本中显示!

自定义事件具有以下格式

属性

类型

描述

名称

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

示例

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)
参数 (Parameters)
  • input (Any) – Runnable 的输入。

  • config (可选[RunnableConfig]) – 用于 Runnable 的配置。

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

  • include_names (可选[Sequence[str]]) – 仅包括来自具有匹配名称的 runnable 的事件。

  • include_types (可选[Sequence[str]]) – 仅包括来自具有匹配类型的 runnable 的事件。

  • include_tags (可选[Sequence[str]]) – 仅包括来自具有匹配标签的 runnable 的事件。

  • exclude_names (可选[Sequence[str]]) – 排除来自具有匹配名称的 runnable 的事件。

  • exclude_types (可选[Sequence[str]]) – 排除来自具有匹配类型的 runnable 的事件。

  • exclude_tags (可选[Sequence[str]]) – 排除来自具有匹配标签的 runnable 的事件。

  • kwargs (Any) – 要传递给 Runnable 的其他关键字参数。这些将传递给 astream_log,因为 astream_events 的此实现构建在 astream_log 之上。

生成 (Yields)

StreamEvents 的异步流。

Raises

NotImplementedError – 如果版本不是 v1v2,则引发此错误。

返回类型 (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 使用支持批量模式的 API。

参数 (Parameters)
  • inputs (List[Input]) –

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

  • return_exceptions (bool) –

  • kwargs (可选[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 (可选[Union[RunnableConfig, Sequence[RunnableConfig]]]) –

  • return_exceptions (bool) –

  • kwargs (可选[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]

配置可在运行时设置的 Runnable 的备选项。

参数 (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_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]

Deprecated since version langchain-core==0.1.46: 使用 invoke 代替。

检索与查询相关的文档。

用户应优先使用 .invoke.batch 而不是直接使用 get_relevant_documents

参数 (Parameters)
  • query (str) – 用于查找相关文档的字符串。

  • callbacks (Callbacks) – 回调管理器或回调列表。默认为 None。

  • tags (Optional[List[str]]) – 与检索器关联的可选标签列表。这些标签将与对此检索器的每次调用关联,并作为参数传递给 callbacks 中定义的处理程序。默认为 None。

  • metadata (Optional[Dict[str, Any]]) – 与检索器关联的可选元数据。此元数据将与对此检索器的每次调用关联,并作为参数传递给 callbacks 中定义的处理程序。默认为 None。

  • run_name (Optional[str]) – 运行的可选名称。默认为 None。

  • kwargs (Any) – 传递给检索器的其他参数。

返回 (Returns)

相关文档列表。

返回类型 (Return type)

List[Document]

get_relevant_documents_with_response(query: str) Tuple[List[Document], Any][source]
参数 (Parameters)

query (str) –

返回类型 (Return type)

Tuple[List[Document], Any]

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

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

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

参数 (Parameters)
  • input (str) – 查询字符串。

  • config (Optional[RunnableConfig]) – 检索器的配置。默认为 None。

  • kwargs (Any) – 传递给检索器的其他参数。

返回 (Returns)

相关文档列表。

返回类型 (Return type)

List[Document]

示例 (Examples)

retriever.invoke("query")
stream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) Iterator[Output]

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

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

  • config (可选[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)

联合类型[SerializedConstructor, SerializedNotImplemented]

property client_options: ClientOptions

使用 GoogleVertexAISearchRetriever 的示例