`langchain_community.retrievers.qdrant_sparse_vector_retriever`.QdrantSparseVectorRetriever¶

注意

QdrantSparseVectorRetriever实现了标准的Runnable Interface接口。🏃

Runnable Interface具有运行时额外的可用方法，例如with_types、with_retry、assign、bind、get_graph等。

class langchain_community.retrievers.qdrant_sparse_vector_retriever.QdrantSparseVectorRetriever[source]¶

基类: BaseRetriever

Qdrant稀疏向量检索器。

param client: Any = None¶: 要使用的‘qdrant_client’实例。

param collection_name: str [Required]¶: Qdrant集合名称。

param content_payload_key : str = 'content'¶: 包含文档内容的有效载荷字段。默认为‘content’

param filter : 可选[Any] = None¶: 用于查询的Qdrant qdrant_client.models.Filter。默认为None。

param k : int = 4¶: 每次查询返回的文档数量。默认为4。

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

param metadata_payload_key : str = 'metadata'¶: 包含文档元数据的有效负载字段。默认为‘metadata’。

param search_options : Dict[str, Any] = {}¶: 传递给qdrant_client.QdrantClient.search()的额外搜索选项。

param sparse_encoder : Callable[[str], Tuple[List[int], List[float]]] [必需]¶: 要使用的稀疏编码器函数。

param sparse_vector_name: str [Required]¶: 要使用的稀疏向量名称。

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

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

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

默认的批量实现对I/O密集型runnables运行良好。

子类应覆盖此方法，如果它们可以更有效地批量处理；例如，如果底层Runnable使用的API支持批量模式。

参数

inputs (List[Input]) – Runnable的输入列表。
config (可选：联合体[RunnableConfig，列表[RunnableConfig]]]) – 调用Runnable时要使用的配置。该配置支持用于追踪的标准键，如‘tags’、‘metadata’，以及控制并行工作量的‘max_concurrency’等键。请参阅RunnableConfig获取更多详细资料。默认值为无。
return_exceptions (布尔) – 是否返回异常而不是抛出异常。默认为False。
kwargs (可选：任意类型) – 传递给Runnable的额外关键字参数。

返回

Runnable的输出列表。

返回类型

列表[输出]

async abatch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]], *, return_exceptions: bool = False, **kwargs: Optional[Any]) → AsyncIterator[Tuple[int, Union[Output, Exception]]]¶

并行对输入列表中的多个输入执行invoke，并以完成顺序产生结果。

参数

inputs (Sequence[输入]) – Runnable的输入列表。
config （可选[联合[RunnableConfig，Sequence[RunnableConfig]]]） - 在调用Runnable时使用的配置。配置支持标准的键，如‘tags’（标签）、‘metadata’（元数据）用于追踪目的，‘max_concurrency’（最大并发数）用于控制并行工作的数量，以及其他键。请参阅RunnableConfig获取更多详细信息。默认值为None。默认值为None。
return_exceptions (布尔) – 是否返回异常而不是抛出异常。默认为False。
kwargs (可选：任意类型) – 传递给Runnable的额外关键字参数。

生成

从Runnable中获取输入和输出的索引的元组。

返回类型

AsyncIterator[Tuple[int, Union[Output, Exception]]]

add_documents(documents: List[Document], **kwargs: Any) → List[str][source]¶

将更多文档通过嵌入并添加到向量存储中。

参数

(List[Document] （documents））- 要添加到向量存储中的文档。
documents （List[Document]）-
kwargs （Any）-

返回

添加的文本ID的列表。

返回类型

List[str]

add_texts()

参数

texts (可迭代对象[str]) –
metadatas (可选[列表[dict]]) –
ids (可选[序列[str]]) –
batch_size (整型) –
kwargs （Any）-

返回类型

列表[字符串]

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 (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]] = None) → BaseTool¶

测试版

该API处于测试版，将来可能会发生变化。

从可执行功祘创建BaseTool。

as_tool 从一个Runnable中实例化一个具有名称、描述和 args_schema 的 BaseTool。尽可能从 runnable.get_input_schema 推断方案。或者（例如，如果 Runnable 以字典作为输入且字典键没有类型），可以直接使用 args_schema 指定方案。您还可以传递 arg_types 以仅指定所需的参数及其类型。

参数

args_schema（《可选》）[类型[BaseModel＜em>]＜em>] – 工具的方案。默认为 None。
name（《可选》）[str＜em>] – 工具的名称。默认为 None。
description（《可选》）[str＜em>] – 工具的描述。默认为 None。
arg_types（《可选》）[Dict＜em>][str＜em>,＜em>类型＜em>]＜em>] – 参数名称到类型的字典。默认为 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]¶

aStream 的默认实现，它调用 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处于测试版，将来可能会发生变化。

生成事件流。

用于创建一个迭代器，遍历提供Runnable进度实时信息的 StreamEvents，包括来自中间结果的 StreamEvents。

StreamEvent 是一个具有以下方案的字典

event：＜strong>str – 事件名称采用以下格式：
格式：on_[runnable_type]_(start|stream|end)。
name：＜strong>str – 生成事件的 Runnable 的名称。
run_id： str - 与给定可运行实例相关的随机生成的ID。
由引发事件的可运行实例生成。作为父可运行实例执行部分调用的子可运行实例会分配其唯一的ID。
parent_ids： List[str] - 生成事件的父可运行实例的ID。
根可运行实例将为空列表。父ID的顺序是从根到直接父级。仅适用于API的v2版本。API的v1版本将返回空列表。
tags： Optional[List[str]] - 生成事件的可运行实例的标记。
metadata： Optional[Dict[str, Any]] - 生成事件的可运行实例的元数据。
data： Dict[str, Any]

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

注意：此参考表针对的是架构的V2版本。

事件	名称	块	输入	输出
on_chat_model_start	[模型名称]		{“消息”： [[系统消息，人类消息]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content="hello")
on_chat_model_end	[模型名称]		{“消息”： [[系统消息，人类消息]]}	AIMessageChunk(content="hello world")
on_llm_start	[模型名称]		{‘输入’： ‘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	[检索器名称]		{“查询”： “hello”}
on_retriever_end	[检索器名称]		{“查询”： “hello”}	[Document(…), ..]
on_prompt_start	[模板名称]		{“问题”： “hello”}
on_prompt_end	[模板名称]		{“问题”： “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)

参数

输入（任何内容） - 可运行实例的输入。
配置（Optional[RunnableConfig]） - 用于可运行实例的配置。
版本（Literal['v1', 'v2']） - 要使用的架构版本；默认为《v2》，v1是为向后兼容而提供的，并在0.4.0版本中将被弃用。在API稳定之前不会分配默认值。自定义事件仅在《v2》中可见。
包含名称 （Optional[Sequence[str]]） - 仅包含具有匹配名称的可运行实例的事件。
包含类型 （Optional[Sequence[str]]） - 仅包含具有匹配类型的可运行实例的事件。
包含标签 （Optional[Sequence[str]]） - 仅包含具有匹配标签的可运行实例的事件。
排除名称 （Optional[Sequence[str]]） - 排除具有匹配名称的可运行实例的事件。
exclude_types (可选[序列[字符串]]) – 从匹配类型的事件中排除可运行事件。
exclude_tags (可选[序列[字符串]]) – 从匹配标签的事件中排除可运行事件。
kwargs (任何) – 传递给 Runnable 的额外关键字参数。这些参数将被传递给 astream_log，因为 astream_events 的实现是建立在 astream_log 之上的。

生成

异步流式传输的 StreamEvents。

抛出异常

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

返回类型

AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]

batch(inputs: 列表[输入], config: 可选[Union[RunnableConfig, 列表[RunnableConfig]]] = None, *, return_exceptions: 布尔值 = False, **kwargs: 可选[任何]) → 列表[输出]¶

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

默认的批量实现对I/O密集型runnables运行良好。

子类应覆盖此方法，如果它们可以更有效地批量处理；例如，如果底层Runnable使用的API支持批量模式。

参数

inputs (列表[输入]) –
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 (序列[输入]) –
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]¶

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

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

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]

使用QdrantSparseVectorRetriever的示例¶

Qdrant稀疏向量

langchain_community.retrievers.qdrant_sparse_vector_retriever.QdrantSparseVectorRetriever¶

使用QdrantSparseVectorRetriever的示例¶

`langchain_community.retrievers.qdrant_sparse_vector_retriever`.QdrantSparseVectorRetriever¶