`langchain_community.retrievers.you`.YouRetriever¶

注意

YouRetriever实现了标准Runnable 接口。🏃

Runnable 接口在可运行的实例上提供了额外的方法，例如with_types、with_retry、assign、bind、get_graph等更多方法。

class langchain_community.retrievers.you.YouRetriever[source]¶

继承自：BaseRetriever、YouSearchAPIWrapper

You.com搜索API检索器。

它封装了results()来获取相关文档。它使用YouSearchAPIWrapper的所有参数，没有任何更改。

param country: Optional[str] = None¶

param endpoint_type: Literal['search', 'news', 'rag', 'snippet'] = 'search'¶

参数 k: Optional[int] = None¶

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

参数 n_hits: Optional[int]= None¶

参数 n_snippets_per_hit: Optional[int]= None¶

参数 num_web_results: Optional[int]= None¶

参数 safesearch: Optional[Literal['off', 'moderate', 'strict']]= None¶

参数 search_lang: Optional[str]= None¶

参数 spellcheck: Optional[bool] = None¶

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

参数 ui_lang: Optional[str] = None¶

参数 ydc_api_key: Optional[str] = None¶

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

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

默认实现的批处理对I/O密集型可运行函数表现良好。

子类应在其能更有效地批量处理的情况下重写此方法；例如，如果基础可运行函数使用支持批量模式的API。

参数

inputs (列表[Input]) – Runnable的输入列表。
config (可选[联合[RunnableConfig, 列表[RunnableConfig]]]) – 当调用Runnable时使用的配置。该配置支持像‘tags’、‘metadata’这样的标准键，用于跟踪目的，还有其他键，如‘max_concurrency’，用于控制并行执行的工作量。请参阅RunnableConfig以获取更多详细信息。默认为None。
return_exceptions (布尔型) – 是否返回异常而不是抛出它们。默认为False。
kwargs (可选[任何]) – 传递给Runnable的额外关键字参数。

返回

Runnable的输出列表。

返回类型

列表[Output]

异步 abatch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]] = None, **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]↵

自 version 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]]) → BaseTool¶

Beta

此API处于测试阶段，未来可能会发生变化。

从可运行对象创建 BaseTool。

as_tool 会从 Runnable 创建一个包含名称、描述和 args_schema 的 BaseTool。尽可能的情况下，模式是从 runnable.get_input_schema 推断得出的。另请选择（例如，如果 Runnable 接受字典作为输入，且具体字典键没有类型），可以使用 args_schema 直接指定模式。您还可以通过 arg_types 来指定所需的参数及其类型。

参数

args_schema (可选[类型[BaseModel]]) – 工具的模式。默认值为 None。
name (可选[字符串]) – 工具的名称。默认值为 None。
description (可选[字符串]) – 工具的描述。默认值为 None。
arg_types (可选[字典[字符串, 类型]]) – 参数名称到类型的字典。默认值为 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: 输入, config: Optional[RunnableConfig], **kwargs: Optional[Any]) → AsyncIterator[输出]¶

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

Beta

此API处于测试阶段，未来可能会发生变化。

生成事件流。

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

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

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

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

注意此参考表针对的是方案V2版本。

事件	名称	块	输入	输出
on_chat_model_start	[模型名称]		{“messages”: [[系统消息，人类消息]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content =“hello”）
on_chat_model_end	[模型名称]		{“messages”: [[系统消息，人类消息]]}	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！，再见，世界！”
on_chain_end	format_docs		[Document(…)]	“hello world！，再见，世界！”
on_tool_start	一些工具		{“x”：1，“y”：”2”}
on_tool_end	一些工具			{“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 = [系统消息，…])

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

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

自定义事件的格式如下

属性	类型	描述
名称	str	事件的用户定义名称。
数据	任何	与事件关联的数据。这可以是一切，尽管我们建议使其具有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)

一些工具:

@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稳定。custom events将仅在《v2》中可见。
include_names（可选[序列[str]]）- 仅包括具有匹配名称的runnables的事件。
include_types（可选[序列[str]]）- 仅包括具有匹配类型的runnables的事件。
include_tags（可选[序列[str]]）- 仅包括具有匹配标签的runnables的事件。
exclude_names（可选[序列[str]]）- 排除具有匹配名称的runnables的事件。
exclude_types（可选[序列[str]]）- 排除具有匹配类型的runnables的事件。
exclude_tags（可选[序列[str]]）- 排除具有匹配标签的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]¶

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

默认实现的批处理对I/O密集型可运行函数表现良好。

子类应在其能更有效地批量处理的情况下重写此方法；例如，如果基础可运行函数使用支持批量模式的API。

参数

inputs (列表) –
config (可选[RunnableConfig, List]) –
return_exceptions (bool) –
kwargs (可选) –

返回类型

列表[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，按完成顺序产生结果。

参数

inputs (Sequence[Input]) –
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) –
return_exceptions (bool) –
kwargs (可选) –

返回类型

迭代器[元组[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 实例的可调用对象字典。

返回

配置了替代方案的新可执行对象。

返回类型

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
)

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 (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")

raw_results(query: str, **kwargs: Any) → Dict¶

通过you.com搜索引擎运行查询并返回命中结果。

参数

query (str) – 要搜索的查询。
kwargs (Any) –

返回类型

字典

返回：YouAPIOutput

async raw_results_async(query: str, **kwargs: Any) → Dict¶

通过异步方式从you.com搜索引擎API获取结果。

参数

query (str) –
kwargs (Any) –

返回类型

字典

results(query: str, **kwargs: Any) → List[Document]¶

通过you.com搜索引擎运行查询并将结果解析为Documents。

参数

query (str) –
kwargs (Any) –

返回类型

List[Document]

async results_async(query: str, **kwargs: Any) → List[Document]¶

参数

query (str) –
kwargs (Any) –

返回类型

List[Document]

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]

使用 YouRetriever 的示例¶

You.com

langchain_community.retrievers.you.YouRetriever¶

使用 YouRetriever 的示例¶

`langchain_community.retrievers.you`.YouRetriever¶