`langchain_community.retrievers.remote_retriever`.RemoteLangChainRetriever¶

注意

RemoteLangChainRetriever 实现了标准 Runnable 接口。🏃

Runnable 接口提供了额外的在可运行的元素中可用的方法，如 with_types、with_retry、assign、bind、get_graph 等。

class langchain_community.retrievers.remote_retriever.RemoteLangChainRetriever[源代码]¶

继承自： BaseRetriever

LangChain API 检索器。

param headers: Optional[dict] = None¶: 请求中要使用的头信息。

param input_key: str = 'message'¶: 请求中要使用的输入键。

param metadata: Optional[Dict[str, Any]] = None¶: 与检索器关联的可选元数据。默认值为None。这些元数据将关联到对检索器的每次调用，并作为参数传递给在callbacks中定义的处理程序。您可以利用这些元数据来识别特定检索器的使用情况，例如。

参数 metadata_key: str= 'metadata'¶: 响应中使用此关键字作为元数据的键。

参数 page_content_key: str= 'page_content'¶: 在响应中使用此关键字作为页面内容的键。

参数 response_key: str= 'response'¶: 在请求中使用此关键字作为响应的键。

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

参数 url: str [Required]¶: 远程LangChain API的URL。

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

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

默认的批量实现适用于IO密集型runnables。

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

参数

inputs (列表[输入]) – 可用于Runnable的输入列表。
config (可选[Union[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]]]]¶

在输入列表上并行运行ainvoke，并在完成时产生结果。

参数

inputs (Sequence[Input]) – Runnable的输入列表。
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用Runnable时要使用的配置。配置支持标记、元数据等标准键用于跟踪目的，'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 （Any）- 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

列表[Document]

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

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

异步检索调用的主入口。

参数

input (str) – 查询字符串。
config (Optional[RunnableConfig]) – 检索器的配置。默认为 None。
kwargs （Any）- 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

列表 [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 正处于测试版，未来可能会发生变化。

从可运行实例创建 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, config: Optional[RunnableConfig], **kwargs: Optional[Any]) → AsyncIterator[Output]¶

默认的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: str - 事件名称的格式为
：on_[runnable_type]_(start|stream|end)。
name: str - 生成事件的Runnable的名称。
run_id: str - 与给定执行相关联的随机生成的ID。
触发事件的可运行对象。作为父可运行对象执行部分而被调用的子可运行对象被分配其唯一标识。
parent_ids: 列表[str] - 生成事件的父可运行对象的ID。
根可运行对象将有一个空列表。父ID的顺序是从根到直接父对象。仅在API的第2版中提供。API的第1版将返回空列表。
tags: Optional[List[str]] - 生成事件的可运行对象的标签。
metadata: Optional[Dict[str, Any]] - 生成事件的可运行对象的元数据。
data: Dict[str, Any]

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

注意此参考表适用于 schemas 的 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!, goodbye world!”
on_chain_end	format_docs		[Document(…)]	“Hello world!, goodbye 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: [SystemMessage, …])

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

自定义事件只有在使用API的第2版时才会出现！

自定义事件具有以下格式

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

某些工具:

@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']) – 要使用的schema版本，要么是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 (Optional[Sequence[str]]) – 排除具有匹配名称的runnables的事件。
exclude_types (Optional[Sequence[str]]) – 排除具有匹配类型的runnables的事件。
exclude_tags (可选[序列[str]]) – 排除具有匹配标签的可执行事件的程序。
kwargs (任意) – 传递给 Runnable 的额外关键字参数。这些参数将被传递给 astream_log，因为 astream_events 的实现建立在 astream_log 的基础上。

产生

异步流中的 StreamEvents。

引发

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

返回类型

AsyncIterator[联合[StandardStreamEvent, CustomStreamEvent]]

batch(inputs: 列表[输入], config: 可选[联合[RunnableConfig, 列表[RunnableConfig]]]] = None, *, return_exceptions: bool = False, **kwargs: 可选[任意]) → 列表[输出]¶

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

默认的批量实现适用于IO密集型runnables。

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

参数

inputs (列表[输入]) –
config (可选[联合[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]]]¶

并行地在输入列表中运行调用，按完成顺序产生结果。

参数

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

配置可在运行时设置的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]

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

参数: **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（回调）- 回调管理器或回调列表。默认为None。
tags （可选[列表[str]]）- 与检索器关联的可选标签列表。这些标签将与每次调用此检索器相关联，并作为参数传递到 callbacks 中定义的处理程序。默认值为 None。
metadata （可选[字典[str, Any]]）- 与检索器关联的可选元数据。这些元数据将与每次调用此检索器相关联，并作为参数传递到 callbacks 中定义的处理程序。默认值为 None。
run_name （可选[str]）- 运行的可选名称。默认值为 None。
kwargs （Any）- 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

列表[Document]

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

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

同步检索调用主入口。

参数

input (str) – 查询字符串。
config (Optional[RunnableConfig]) – 检索器的配置。默认为 None。
kwargs （Any）- 传递给检索器的附加参数。

返回

相关文档列表。

返回类型

列表 [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]¶

将Runnable序列化为JSON。

返回: Runnable的JSON序列化表示。
返回类型: Union[SerializedConstructor, SerializedNotImplemented]

langchain_community.retrievers.remote_retriever.RemoteLangChainRetriever¶

`langchain_community.retrievers.remote_retriever`.RemoteLangChainRetriever¶