langchain_google_community.search.GoogleSearchRun

注意

GoogleSearchRun 实现了标准 Runnable Interface。🏃

Runnable Interface 具有额外的可在可运行对象上使用的方法，例如 with_types，with_retry，assign，bind，get_graph 以及更多。

class langchain_google_community.search.GoogleSearchRun

基类: BaseTool

查询 Google 搜索 API 的工具。

初始化工具。

param api_wrapper: GoogleSearchAPIWrapper [必需]

param args_schema: Optional[TypeBaseModel] = None

Pydantic 模型类，用于验证和解析工具的输入参数。

参数架构应为以下之一

• pydantic.BaseModel 的子类。

或 - pydantic 2 中访问 v1 命名空间时 pydantic.v1.BaseModel 的子类

参数 callback_manager: Optional[BaseCallbackManager] = None

已弃用。请使用回调代替。

参数 callbacks :Callbacks = None

在工具执行期间调用的回调。

参数 description :str = '围绕Google搜索的包装器。在您需要回答有关当前事件的问题时很有用。输入应为搜索查询。'

用于告诉模型如何/何时/为什么使用工具。

您可以在描述中提供一些示例。

参数 handle_tool_error :Optional[Union[bool, str, Callable[[ToolException], str]] = False

处理抛出的ToolException内容。

参数 handle_validation_error :Optional[Union[bool, str, Callable[[ValidationError], str]] = False

处理抛出的ValidationError内容。

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

与该工具相关联的可选元数据。默认为None。这些元数据将与该工具的每次调用相关联，并作为参数传递给在callbacks中定义的处理程序。您可以使用这些来识别特定工具的使用案例。

param response_format: Literal['content', 'content_and_artifact'] = 'content'

工具响应格式。默认为‘content’。

如果为“content”，则将工具的输出解释为ToolMessage的内容。如果为“content_and_artifact”，则预期输出是一个与ToolMessage的(content, artifact)对应的两个元素元组。

param return_direct: bool = False

是否直接返回工具的输出。

将此设置为True意味着在调用工具后，AgentExecutor将停止循环。

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

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

param verbose: bool = False

是否记录工具的进度。

__call__(tool_input: str, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None) → str

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

使工具可调用。

参数：

• tool_input (str) –

• callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) –

返回类型

str

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

默认实现使用 asyncio.gather 以并行方式运行 run。

默认实现的批处理对 I/O 密集型任务工作良好。

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

参数：

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

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

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

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

返回

Runnable的输出列表。

返回类型

列表[输出]

异步 abatch_as_completed(inputs: Sequence[Input], config: 可选[并集[RunnableConfig, Sequence[RunnableConfig]]]] = None, *, return_exceptions: 布尔值 = False, **kwargs: 可选[任何]) → 异步迭代器[元组[int, 并集[输出, Exception]]]¶

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

参数：

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

• config (可选[联合[RunnableConfig, Sequence[RunnableConfig]]]) – 在调用Runnable时使用的配置。配置支持标准键如 'tags'，'metadata' 适用于跟踪目的，'max_concurrency' 用于控制并行执行的工作量，以及其他键。请参阅RunnableConfig以获取更多信息。默认为None。

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

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

生成

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

返回类型

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

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

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

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

子类应覆盖此方法，如果它们可以异步运行。

参数：

• input (联合[str, Dict, ToolCall]) –

• config (可选[RunnableConfig]) –

• kwargs (Any) –

返回类型

Any

async arun(tool_input: Union[str, Dict], verbose: Optional[bool] = None, start_color: Optional[str] = 'green', color: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, run_id: Optional[UUID] = None, config: Optional[RunnableConfig] = None, tool_call_id: Optional[str] = None, **kwargs: Any) → Any

异步运行工具。

参数：

• tool_input (联合[str, Dict]) – 工具的输入。

• verbose (可选[bool]) – 是否记录工具的进度。默认为None。

• start_color (可选[str]) – 开始工具时要使用的颜色。默认为‘green’。

• color (可选[str]) – 结束工具时要使用的颜色。默认为‘green’。

• callbacks (可选[联合[List[BaseCallbackHandler], BaseCallbackManager]]) – 在工具执行期间要调用的回调。默认为None。

• tags (可选[[str]]) - 与工具关联的可选标签列表。默认为 None。

• metadata (可选[[str, Any]]) - 与工具关联的可选元数据。默认为 None。

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

• run_id (可选[[UUID]]) - 运行的 id。默认为 None。

• config (可选[[RunnableConfig]]) - 工具的配置。默认为 None。

• tool_call_id (可选[[str]]) - 工具调用的 id。默认为 None。

• kwargs - 传递给工具的额外参数

返回

工具的输出

抛出

ToolException - 如果工具执行过程中发生错误。

返回类型

Any

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 的 BasicTool 实例。尽可能的情况下，方案是从 runnable.get_input_schema 推断出来的。或者（例如，如果 Runnable 使用字典作为输入且具体字典键没有类型），可以直接通过 args_schema 指定方案。您也可以传递 arg_types 仅指定所需的参数及其类型。

参数：

• args_schema （可选）[类型[BaseModel]]] – 工具的方案。默认值为 None。

• name （可选）[str] – 工具的名称。默认值为 None。

• description （可选）[str] – 工具的描述。默认值为 None。

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

返回

BasicTool 实例。

返回类型

BasicTool

类型化字典输入

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 新增。

asyncastream(input: Input, config: Optional[RunnableConfig], **kwargs: Optional[Any]) \

这是 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 处于测试版，将来可能会有所变化。

生成事件流。

用于创建一个遍历提供关于 Runnable 进度的实时信息的 StreamEvents 的迭代器，包括中间结果的 StreamEvents。

StreamEvent 是一个具有以下方案的字典

• event： 字符串 - 事件名称具有如下格式：

  例如：on_[runnable_type]_(start|stream|end)。

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

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

  被调用的子Runnable作为父Runnable执行的一部分，会分配自己的唯一ID。

• parent_ids: 列表[str] - 生成了事件的父Runnable的ID。根Runnable将有空列表。父ID的顺序是从根到直接父级。只有v2版本的API有此信息。v1版本的API将返回空列表。

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

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

• data: Dict[str, Any]

以下是表格，说明了可能由各种链发出的某些事件。为了简短，省略了元数据字段。链定义在表格后。

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

事件	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!”
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, …])

除了标准事件外，用户还可以分发自定义事件（下面有示例）。

自定义事件 only 在 `v2` 版本的 API 中出现！

自定义事件有以下格式

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

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 (任何) – 可由此Runnable使用的输入。

• config (Optional[RunnableConfig]) – 为Runnable使用配置。

• version (文字['v1', 'v2']) – 要使用的架构版本，要么是 v2 要么是 v1。用户应使用 `v2`。 `v1` 用于向后兼容性，将在 0.4.0 中弃用。直到API稳定之前，不会分配默认值。自定义事件 only 在 `v2` 中出现。

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

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

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

• exclude_names (可选[序列[str]]) – 排除与指定名称匹配的可执行事件的调用。

• exclude_types (可选[序列[str]]) – 排除与指定类型匹配的可执行事件的调用。

• exclude_tags (可选[序列[str]]) – 排除与指定标签匹配的可执行事件的调用。

• kwargs (任意) – 传递给可执行器的额外关键字参数。这将传递给 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 (列表[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]]]

在输入列表上并行运行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]

配置在运行时可以设置的可替换项。

参数：

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

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

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

参数：

• input (Union[str, Dict, ToolCall]) – 可运行的输入。

• config (Optional[RunnableConfig]) – 在调用时可使用的配置。配置支持标准的键，如‘tags’、‘metadata’用于跟踪目的，‘max_concurrency’用于控制并行执行的工作量，以及其他键。请参阅 RunnableConfig 了解更多详情。

• kwargs (Any) –

返回

Runnable 的输出。

返回类型

Any

run(tool_input: Union[str, Dict[str, Any]], verbose: Optional[bool] = None, start_color: Optional[str] = 'green', color: Optional[str] = 'green', callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, run_id: Optional[UUID] = None, config: Optional[RunnableConfig] = None, tool_call_id: Optional[str] = None, **kwargs: Any) → Any

运行工具。

参数：

• tool_input (Union[str, Dict[str, Any]]) – 工具的输入。

• verbose (可选[bool]) – 是否记录工具的进度。默认为None。

• start_color (可选[str]) – 开始工具时要使用的颜色。默认为‘green’。

• color (可选[str]) – 结束工具时要使用的颜色。默认为‘green’。

• callbacks (可选[联合[List[BaseCallbackHandler], BaseCallbackManager]]) – 在工具执行期间要调用的回调。默认为None。

• tags (可选[[str]]) - 与工具关联的可选标签列表。默认为 None。

• metadata (可选[[str, Any]]) - 与工具关联的可选元数据。默认为 None。

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

• run_id (可选[[UUID]]) - 运行的 id。默认为 None。

• config (可选[[RunnableConfig]]) - 工具的配置。默认为 None。

• tool_call_id (可选[[str]]) - 工具调用的 id。默认为 None。

• kwargs - 传递给工具的额外参数

返回

工具的输出

抛出

ToolException - 如果工具执行过程中发生错误。

返回类型

Any

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]

property args: dict

property is_single_input: bool

工具是否仅接受单个输入。

property tool_call_schema: Type[BaseModel]