`langchain_community.vectorstores.azuresearch`.AzureSearchVectorStoreRetriever¶

注意

AzureSearchVectorStoreRetriever 实现了标准 Runnable 接口。🏃

Runnable 接口 有额外的在可运行对象中可用的方法，例如 with_types，with_retry，assign，bind，get_graph 等。

class langchain_community.vectorstores.azuresearch.AzureSearchVectorStoreRetriever[source]¶

Bases: BaseRetriever

使用 Azure 智能搜索的检索器。

param k: int = 4¶: 返回的文档数量。

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

param search_kwargs: dict = {}¶

搜索参数。score_threshold: 相似度分数阈值的最小相关性阈值。

用于 similarity_score_threshold

fetch_k：传递给MMR算法的文档数量（默认：20）lambda_mult：MMR返回结果的多样性；

1表示最小多样性，0表示最大多样性。（默认：0.5）

filter：根据文档元数据过滤；

参数 search_type: str = 'hybrid'¶: 要执行搜索的类型。选项包括“similarity”，“hybrid”，“semantic_hybrid”，“similarity_score_threshold”，“hybrid_score_threshold”，或“semantic_hybrid_score_threshold”。

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

参数 vectorstore: AzureSearch [必须]¶: 用于查找相似文档的Azure Search实例。

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 (可选[联合[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 时的配置。配置支持标准键，如用于跟踪的 '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 (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 （字符串） - 查询字符串。
config （可选） - 检索器配置。默认为 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处于测试阶段，未来可能会有所改变。

从Runnable创建BaseTool。

as_tool将从Runnable中实例化一个BaseTool，它包含名称、描述以及args_schema。在可能的情况下，架构是通过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] = None, **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处于测试阶段，未来可能会有所改变。

生成事件流。

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

StreamEvent是一个具有以下架构的字典

event： str - 事件名称是以下格式：
on_[runnable_type]_(start|stream|end)。
代码名：name - 触发事件的 Runnable 的名字。
运行 ID：run_id - 与给定执行相关的随机生成的 ID。
Runnable 触发事件时，其子 Runnable 会被分配自己的唯一 ID。
parent_ids：字符串列表 - 生成事件的父 Runnable 的 ID 列表。根 Runnable 将有一个空列表。父 ID 的顺序是从根到直接父级。仅适用于 API 的 v2 版本。API 的 v1 版本将返回一个空列表。
标签：tags：可选[字符串列表] - 触发事件的 Runnable 的标签。
元数据：metadata：可选[字符串到任何类型的字典] - 触发事件的 Runnable 的元数据。
数据：data：字符串到任何类型的字典
以下是一个表格，说明了各种链可能发出的某些事件。为了简洁，表中年份字段已被省略。表后包含链定义。
注意：此参考表是为 V2 版本的架构。
事件

名称

块

输入	输出	触发聊天模型开始	模型名称	{“消息”：[[系统消息，人类消息]]}
触发聊天模型流	AIMessageChunk(content="hello")		触发聊天模型结束
AIMessageChunk(content="hello world")	AIMessageChunk(content="hello")	触发暗语言模型开始
{‘输入’：‘hello’}	AIMessageChunk(content="hello")		触发聊天模型结束	触发暗语言模型流
'Hello'	AIMessageChunk(content="hello")		触发暗语言模型结束
'Hello human！'	AIMessageChunk(content="hello")	触发链开始
格式化文档	AIMessageChunk(content="hello")		触发链流
"hello world！，再见世界！"	触发链结束
[文档(…)]	触发链结束	触发工具开始
某个工具	触发链结束		{“x”：1，"y"："2"}	触发工具开始
触发工具结束	触发检索器开始		检索器名称
{“查询”：“hello”}	触发检索器开始			检索器名称
触发检索器结束	[Document(…), ..]		触发提示开始
模板名称	[Document(…), ..]		触发提示开始	{“问题”：“hello”}
触发提示结束	ChatPromptValue(messages: [SystemMessage, …])		除了标准事件外，用户还可以分发自定义事件（请参见下面的示例）。
自定义事件仅限于 API 的 v2 版本！	ChatPromptValue(messages: [SystemMessage, …])		除了标准事件外，用户还可以分发自定义事件（请参见下面的示例）。	自定义事件的格式如下

属性

类型

描述

str	事件的用户定义名称。	数据
输出	Any	与事件关联的数据。这可以是一切，尽管我们建议使其可 JSON 序列化。
以下是与上述标准事件相关的声明	提示	例子

例子：分发自定义事件

触发链结束:

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"]})

(Any) – Runnable 的输入。

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)

参数

(Optional[List[langchain_core.runnables.config.RunnableConfig]]) – 使用 Runnable 的配置。
版本
(Literal['v1', 'v2']) – 要使用的架构版本，要么是 v2，要么是 v1。用户应使用 v2。 v1 用于向后兼容，将在 0.4.0 中弃用。默认值将直到 API 稳定后才分配。自定义事件仅在 v2 中呈现。
只包括名称
(Optional[Sequence[str]]) – 只包括具有匹配名称的 runnables 的事件。
只包括类型
(Optional[Sequence[str]]) – 只包括具有匹配类型的 runnables 的事件。
exclude_types (可选[序列[str]]) – 排除与匹配类型一致的运行事件。
exclude_tags (可选[序列[str]]) – 排除与匹配标签一致的运行事件。
kwargs (任何) – 传递给 Runnable 的附加关键字参数。这些参数将传递给 astream_log，因为 astream_events 的实现基于 astream_log。

生成

StreamEvent 的异步流。

抛出异常

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。

默认批量实现对IO密集型runnables工作得很好。

如果子类能更高效地批量处理，则应覆盖此方法；例如，如果底层的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]]]¶

在输入列表上并行运行调用，结果是完成时产生的。

参数

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实例的callables的字典。

返回

一个新的已配置备选方案的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
)

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 （字符串） - 查询字符串。
config （可选） - 检索器配置。默认为 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的输出。

返回类型

迭代器[输出]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将 Runnable 序列化为 JSON。

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

allowed_search_types: ClassVar[Collection[str]] = ('similarity', 'similarity_score_threshold', 'hybrid', 'hybrid_score_threshold', 'semantic_hybrid', 'semantic_hybrid_score_threshold')¶

langchain_community.vectorstores.azuresearch.AzureSearchVectorStoreRetriever¶

`langchain_community.vectorstores.azuresearch`.AzureSearchVectorStoreRetriever¶