`langchain_community.tools.searchapi.tool`.SearchAPIResults¶

注意

SearchAPIResults 实现了标准的 Runnable 接口. 🏃

Runnable 接口 包含了在可运行对象上有额外方法，如 with_types、with_retry、assign、bind、get_graph 等更多。

class langchain_community.tools.searchapi.tool.SearchAPIResults[source]¶

父类: BaseTool

这是一个查询 SearchApi.io 搜索 API 并返回 JSON 的工具。

初始化工具。

param api_wrapper: SearchApiAPIWrapper [可选]¶

param args_schema: Optional[TypeBaseModel] = None¶

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

参数架构应该是

pydantic.BaseModel 的子类。

或者 - pydantic.v1.BaseModel 的子类（如果在使用 pydantic 2 中的 v1 命名空间时）

param callback_manager: Optional[BaseCallbackManager] = None¶: 已弃用。请使用回调代替。

参数 callbacks: Callbacks = None¶: 在工具执行过程中调用的回调。

参数 description: str = 'Google Search API由SearchApi.io提供。此工具在需要回答有关当前事件的问题时非常有用。输入应为搜索查询，输出是一个包含查询结果的JSON对象。'¶

用于告诉模型何时以及如何使用工具。

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

参数 handle_tool_error: Optional[Union[bool, str, Callable[[ToolException], str]]] = False¶: 处理抛出的ToolException的内容。

参数 handle_validation_error: Optional[Union[bool, str, Callable[[ValidationError], str]]] = False¶: 处理抛出的ValidationError的内容。

参数 metadata: 可选[Dict[str, Any]] = None¶: 与工具关联的可选元数据。默认为None。此元数据将与对该工具的每次调用相关联，并作为参数传递给在callbacks中定义的处理程序。您可以使用这些（例如，通过其用例）来标识特定工具的实例。

参数 response_format: Literal['content', 'content_and_artifact'] = 'content'¶

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

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

参数 return_direct: bool = False¶

是否直接返回工具输出。

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

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

参数 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 并行运行 invoke。

默认批处理实现适用于 I/O 密集型的运行任务。

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

参数

输入（列表 [ 输入 ]） - Runnable的可执行输入列表。
配置（可选 [ 并集 [ RunnableConfig ], 列表 [ RunnableConfig ] ] ]） - 调用Runnable时使用的配置。配置支持诸如'tags'、'metadata'（用于跟踪）、'max_concurrency'（用于控制并行的工作量）等标准键。请参阅RunnableConfig获取更多详情。默认为None。

return_exceptions （布尔型） - 是否返回异常而不是引发它们。默认为False。

kwargs （可选 [ 任何 ]） - 传递给Runnable的额外关键字参数。

返回

Runnable的输出列表。

返回类型

列表 [ 输出 ]

async abatch_as_completed(*inputs: 输入序列[ 输入 ], config: Optional[Union[ RunnableConfig , 列表[ RunnableConfig ] ] ]] = None, return_exceptions: 布尔型 = False, **kwargs: Optional[ 任何 ] ]) → 异步迭代器[ 元组[ 整数, 并集[ 输出, 异常]] ]]: 在输入列表上并行运行runnable，在结果完成时产生结果。

参数

输入（输入序列 [ 输入 ]） - Runnable的可执行输入列表。

config （可选[联合[RunnableConfig，Sequence[RunnableConfig]]]） – 调用可运行对象时使用的配置。该配置支持如‘tags’，‘metadata’等标准键，用于跟踪目的，'max_concurrency' 用于控制并行工作的工作量，以及其他键。请参考RunnableConfig以获取更多详细信息。默认为None。默认为None。

return_exceptions （布尔型） - 是否返回异常而不是引发它们。默认为False。

kwargs （可选 [ 任何 ]） - 传递给Runnable的额外关键字参数。

产生

来自可运行对象的输入和输出的索引的元组。

返回类型

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

async ainvoke(input: 联合[str， Dict， ToolCall], config: 可选[RunnableConfig], **kwargs: Any) → Any¶

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

默认实现允许在Runnable未实现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 （可选[联合[列表[BaseCallbackHandler]，BaseCallbackManager]]） – 在工具执行期间要调用的回调。默认为None。
tags （可选[列表[str]]） – 与工具相关联的可选标签列表。默认为None。
metadata （可选[Dict[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将从一个可运行程序实例化一个具有名称、描述和args_schema的BaseTool。在可能的情况下，架构从runnable.get_input_schema推断出来。或者（例如，如果可运行程序接受dict作为输入且特定dict键未类型化），可以通过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起引入。

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

astream的默认实现，它调用ainvoke。子类应该覆盖此方法以支持流输出。

参数

input （Input） – Runnable的输入。
config （可选] RunnableConfig]） – 用于Runnable的配置。默认为None。
kwargs （可选 [ 任何 ]） - 传递给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处于测试版本，未来可能会有所改变。

生成事件流。

用于创建StreamEvents的迭代器，这些StreamEvents提供了关于Runnable进度的实时信息，包括中间结果中的StreamEvents。

StreamEvent是一个具有以下模式的字典

event： str - 事件名称的格式为
：on_[runnable_type]_(start|stream|end)。
name： str - 生成事件的Runnable的名称。
run_id： str - 与生成事件的Runnable的给定执行相关联的随机生成的ID。
作为父Runnable执行的一部分被调用的子Runnable将分配它自己的唯一ID。
parent_ids： 列表[str] - 生成交集的父Runnable的ID。
根Runnable将有一个空列表。父ID的顺序从根到直接父级。仅在API的v2版本中可用。API的v1版本将返回一个空列表。
tags：可选[列表[str]] - 生成事件的Runnable的标签。
metadata：可选[字典[str, Any]] - 生成事件的Runnable的元数据。
data： 字典[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	事件的自定义名称。
数据	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)

参数

输入 (任何) – Runnable的输入。
配置 (可选[RunnableConfig]) – 要用于Runnable的配置。
版本 (文字['v1', 'v2']) – 要使用的模式版本，可以是v2或v1。用户应使用v2。 v1用于向后兼容，并在0.4.0版本中弃用。在API稳定之前不分配默认值。自定义事件仅在v2中显示。
include_names (可选[序列[字符串]]) – 仅包含具有匹配名称的runnables的事件。
include_types (可选[序列[字符串]]) – 仅包含具有匹配类型的runnables的事件。
include_tags (可选[序列[字符串]]) – 仅包含具有匹配标签的runnables的事件。
exclude_names (可选[序列[字符串]]) – 排除具有匹配名称的runnables的事件。
exclude_types (可选[序列[字符串]]) – 排除具有匹配类型的runnables的事件。
exclude_tags (可选[序列[字符串]]) – 排除具有匹配标签的runnables的事件。
kwargs (任何) – 传递给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** (列表[Input]) –
**config** (可选[Union[RunnableConfig, List[RunnableConfig]]]) –
**return_exceptions** (布尔值) –
**kwargs** (可选[Any]) –

返回类型

列表 [ 输出 ]

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，按完成顺序返回结果。

参数

（Sequence[Input]） –
（Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]） –
**return_exceptions** (布尔值) –
**kwargs** (可选[Any]) –

返回类型

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]a class="headerlink" href="#langchain_community.tools.searchapi.tool.SearchAPIResults.configurable_alternatives" title="Permalink to this definition">¶

配置可以在运行时设置的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实例的调用函数的字典。

返回

配置好可选参数后生成一个新的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
)

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

将单个输入转换为输出。覆盖以实现。

参数

input (Union[str, Dict, ToolCall]) – Runnable的输入。
config (Optional[RunnableConfig]) – 使用Runnable时使用的配置。配置支持用于追踪的标准化关键字（如'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 （可选[联合[列表[BaseCallbackHandler]，BaseCallbackManager]]） – 在工具执行期间要调用的回调。默认为None。
tags （可选[列表[str]]） – 与工具相关联的可选标签列表。默认为None。
metadata （可选[Dict[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], **kwargs: Optional[Any]) → Iterator[Output]¶

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

参数

input （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]¶

langchain_community.tools.searchapi.tool.SearchAPIResults¶

`langchain_community.tools.searchapi.tool`.SearchAPIResults¶