langchain_community.retrievers.tavily_search_api.TavilySearchAPIRetriever¶

注意

TavilySearchAPIRetriever 实现了标准 Runnable Interface。🏃

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

class langchain_community.retrievers.tavily_search_api.TavilySearchAPIRetriever

Bases: BaseRetriever

Tavily 搜索 API 检索器。

设置

安装 langchain-community 并设置环境变量 TAVILY_API_KEY。

pip install -U langchain-community
export TAVILY_API_KEY="your-api-key"

关键初始化参数

k: int

包含的结果数量。

include_generated_answer: bool

在结果中包含生成的答案。

include_raw_content: bool

在结果中包含原始内容。

include_images: bool

除了文本外还返回图片。

实例化

from langchain_community.retrievers import TavilySearchAPIRetriever

retriever = TavilySearchAPIRetriever(k=3)

用法

query = "what year was breath of the wild released?"

retriever.invoke(query)

在链中使用

from langchain_core.output_parsers import StrOutputParser
from langchain_core.prompts import ChatPromptTemplate
from langchain_core.runnables import RunnablePassthrough
from langchain_openai import ChatOpenAI

prompt = ChatPromptTemplate.from_template(
    """Answer the question based only on the context provided.

Context: {context}

Question: {question}"""
)

llm = ChatOpenAI(model="gpt-3.5-turbo-0125")

def format_docs(docs):
    return "

“.join(doc.page_content for doc in docs)

chain = (

{“context”: retriever | format_docs, “question”: RunnablePassthrough()} | prompt | llm | StrOutputParser()

)

chain.invoke(“how many units did bretch of the wild sell in 2020”)

param api_key: Optional[str] = None

参数 exclude_domains: Optional[%s[str]] = None¶

参数 include_domains: Optional[%s[str]] = None¶

参数 include_generated_answer: bool = False¶

参数 include_images: bool = False¶

参数 include_raw_content: bool = False¶

参数 k: int = 10¶

参数 kwargs: Optional[%s[str, Any]] = {}¶

参数 :metadata: Optional[Dict[str, Any]] = None

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

参数 search_depth : SearchDepth = SearchDepth.BASIC

参数 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并行运行run.

默认的批量实现适用于I/O密集型的runnables。

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

参数

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

• config (可选[联合[RunnableConfig, 列表[RunnableConfig]]]) – 调用Runnable时使用的配置。配置支持标准键如’tags’、‘metadata’用于跟踪目的，‘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]]]¶

并行运行一个输入列表上的 invoke，按完成顺序生成结果。

参数

• 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 (可选[列表[str]]) – 与检索器关联的可选标签列表。这些标签将与每次调用此检索器相关联，并作为参数传递给 callbacks 中定义的处理程序。默认为 None。

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

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

• kwargs (任何) – 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

列表[Document]

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

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

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

参数

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

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

• kwargs (任何) – 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

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处于测试版，可能在未来会有变化。

从Runnable创建一个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], **kwargs: Optional[Any]) → AsyncIterator[Output]¶

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

参数

• 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_[运行类型]_(开始|流|结束)。

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

• run_id： str - 与给定执行相关联的随机生成的 ID。这是由触发事件的 Runnable 生成的。

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

• parent_ids： List[str] - 生成事件的父 Runnable 的 ID。根 Runnable 将有一个空列表。父 ID 的顺序是从根到直接父。

  仅适用于 API 的 v2 版本。API 的 v1 版本将返回空列表。

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

• metadata： Optional[Dict[str, Any]] - 生成事件的 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}

提示:

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 (可选[序列[str]]) – 排除具有匹配名称的可运行事件。

• exclude_types (可选[序列[str]]) – 排除具有匹配类型的事件。

• exclude_tags (可选[序列[str]]) – 排除具有匹配标签的事件。

• kwargs (任何) – 要传递给可运行函数的附加关键字参数。这些将通过astream_log传递，因为astream_events的实现基于astream_log。

产生结果

一个异步StreamEvent流。

异常

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

返回类型

AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]

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

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

默认的批量实现适用于I/O密集型的runnables。

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

参数

• inputs (列表[Input]) –

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

• return_exceptions (布尔值) –

• kwargs (可选[任何]) –

返回类型

列表[输出]

batch_as_completed(inputs: 序列[输入], config: 可选[联合[可执行配置, 序列[可执行配置]]] = None, *args, return_exceptions: 布尔值 = False, **kwargs) → 迭代器[元组[整数, 联合[输出, 异常]]]]¶

在输入列表上并行运行调用，当结果完成时返回。

参数

• inputs (序列[输入]) –

• config (可选[联合[可执行配置, 序列[可执行配置]]]) –

• return_exceptions (布尔值) –

• kwargs (可选[任何]) –

返回类型

迭代器[元组[整数，联合[输出，异常]]]

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: 联合[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) → RunnableSerializable[Input, Output]

在运行时配置特定可运行的字段。

参数

**kwargs (联合[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
)

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 (Callbacks) – 回调管理器或回调列表。默认为 None。

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

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

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

• kwargs (任何) – 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

列表[Document]

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

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

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

参数

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

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

• kwargs (任何) – 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

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

将可运行的组件序列化为 JSON。

返回

可运行的组件的 JSON 序列化表示。

返回类型

Union[SerializedConstructor, SerializedNotImplemented]

使用 TavilySearchAPIRetriever 的示例

• Tavily 搜索 API