langchain_community.vectorstores.qdrant.Qdrant

class langchain_community.vectorstores.qdrant.Qdrant(client: Any, collection_name: str, embeddings: Optional[Embeddings] = None, content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', distance_strategy: str = 'COSINE', vector_name: Optional[str] = None, async_client: Optional[Any] = None, embedding_function: Optional[Callable] = None)[源代码]

0.0.37 版本后已弃用: 请使用 langchain_qdrant.Qdrant 代替。

Qdrant 向量存储。

要使用，您应该安装 qdrant-client 包。

示例

from qdrant_client import QdrantClient
from langchain_community.vectorstores import Qdrant

client = QdrantClient()
collection_name = "MyCollection"
qdrant = Qdrant(client, collection_name, embedding_function)

使用必要的组件初始化。

属性

CONTENT_KEY

METADATA_KEY

VECTOR_NAME

embeddings

访问查询嵌入对象（如果可用）。

方法

__init__(client, collection_name[, ...])

使用必要的组件初始化。

aadd_documents(documents, **kwargs)

异步地通过嵌入运行更多文档并添加到向量存储。

aadd_texts(texts[, metadatas, ids, batch_size])

通过嵌入运行更多文本并添加到向量存储。

aconstruct_instance(texts, embedding[, ...])

add_documents(documents, **kwargs)

在向量存储中添加或更新文档。

add_texts(texts[, metadatas, ids, batch_size])

通过嵌入运行更多文本并添加到向量存储。

adelete([ids])

按向量 ID 或其他条件删除。

afrom_documents(documents, embedding, **kwargs)

异步地从文档和嵌入初始化 VectorStore 并返回。

afrom_texts(texts, embedding[, metadatas, ...])

从文本列表构建 Qdrant 包装器。

aget_by_ids(ids, /)

异步地通过 ID 获取文档。

amax_marginal_relevance_search(query[, k, ...])

返回使用最大边际相关性选择的文档。

amax_marginal_relevance_search_by_vector(...)

返回使用最大边际相关性选择的文档。最大边际相关性优化了与查询的相似性以及所选文档之间的多样性。 :param query: 要查找相似文档的文本。 :param k: 要返回的文档数量。默认为 4。 :param fetch_k: 要获取并传递给 MMR 算法的文档数量。默认为 20。 :param lambda_mult: 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。 :param filter: 按元数据过滤。默认为 None。 :param search_params: 附加搜索参数 :param score_threshold: 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回较高的分数。 :param consistency: 搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有查询的副本中 - 'majority' - 查询所有副本，但返回大多数副本中存在的值 - 'quorum' - 查询大多数副本，返回所有副本中存在的值 - 'all' - 查询所有副本，并返回所有副本中存在的值 :param **kwargs: 要传递给 AsyncQdrantClient.Search() 的任何其他命名参数。

amax_marginal_relevance_search_with_score_by_vector(...)

返回使用最大边际相关性选择的文档。最大边际相关性优化了与查询的相似性以及所选文档之间的多样性。 :param query: 要查找相似文档的文本。 :param k: 要返回的文档数量。默认为 4。 :param fetch_k: 要获取并传递给 MMR 算法的文档数量。默认为 20。 :param lambda_mult: 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。

as_retriever(**kwargs)

返回由此 VectorStore 初始化的 VectorStoreRetriever。

asearch(query, search_type, **kwargs)

异步地返回与使用指定搜索类型查询最相似的文档。

asimilarity_search(query[, k, filter])

返回与查询最相似的文档。

asimilarity_search_by_vector(embedding[, k, ...])

返回与嵌入向量最相似的文档。

asimilarity_search_with_relevance_scores(query)

异步地返回范围在 [0, 1] 内的文档和相关性分数。

asimilarity_search_with_score(query[, k, ...])

返回与查询最相似的文档。

asimilarity_search_with_score_by_vector(...)

返回与嵌入向量最相似的文档。

astreaming_upsert(items, /, batch_size, **kwargs)

aupsert(items, /, **kwargs)

construct_instance(texts, embedding[, ...])

delete([ids])

按向量 ID 或其他条件删除。

from_documents(documents, embedding, **kwargs)

从文档和嵌入初始化 VectorStore 并返回。

from_existing_collection(embedding, path, ...)

获取现有 Qdrant 集合的实例。

from_texts(texts, embedding[, metadatas, ...])

从文本列表构建 Qdrant 包装器。

get_by_ids(ids, /)

通过 ID 获取文档。

max_marginal_relevance_search(query[, k, ...])

返回使用最大边际相关性选择的文档。

max_marginal_relevance_search_by_vector(...)

返回使用最大边际相关性选择的文档。

max_marginal_relevance_search_with_score_by_vector(...)

返回使用最大边际相关性选择的文档。最大边际相关性优化了与查询的相似性以及所选文档之间的多样性。 :param query: 要查找相似文档的文本。 :param k: 要返回的文档数量。默认为 4。 :param fetch_k: 要获取并传递给 MMR 算法的文档数量。默认为 20。 :param lambda_mult: 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。 :param filter: 按元数据过滤。默认为 None。 :param search_params: 附加搜索参数 :param score_threshold: 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回较高的分数。 :param consistency: 搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有查询的副本中 - 'majority' - 查询所有副本，但返回大多数副本中存在的值 - 'quorum' - 查询大多数副本，返回所有副本中存在的值 - 'all' - 查询所有副本，并返回所有副本中存在的值 :param **kwargs: 要传递给 QdrantClient.search() 的任何其他命名参数。

search(query, search_type, **kwargs)

返回与使用指定搜索类型查询最相似的文档。

similarity_search(query[, k, filter, ...])

返回与查询最相似的文档。

similarity_search_by_vector(embedding[, k, ...])

返回与嵌入向量最相似的文档。

similarity_search_with_relevance_scores(query)

返回范围在 [0, 1] 内的文档和相关性分数。

similarity_search_with_score(query[, k, ...])

返回与查询最相似的文档。

similarity_search_with_score_by_vector(embedding)

返回与嵌入向量最相似的文档。

streaming_upsert(items, /, batch_size, **kwargs)

upsert(items, /, **kwargs)

参数

  • client (Any) –

  • collection_name (str) –

  • embeddings (Optional[Embeddings]) –

  • content_payload_key (str) –

  • metadata_payload_key (str) –

  • distance_strategy (str) –

  • vector_name (Optional[str]) –

  • async_client (Optional[Any]) –

  • embedding_function (Optional[Callable]) –

__init__(client: Any, collection_name: str, embeddings: Optional[Embeddings] = None, content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', distance_strategy: str = 'COSINE', vector_name: Optional[str] = None, async_client: Optional[Any] = None, embedding_function: Optional[Callable] = None)[源代码]

使用必要的组件初始化。

参数

  • client (Any) –

  • collection_name (str) –

  • embeddings (Optional[Embeddings]) –

  • content_payload_key (str) –

  • metadata_payload_key (str) –

  • distance_strategy (str) –

  • vector_name (Optional[str]) –

  • async_client (Optional[Any]) –

  • embedding_function (Optional[Callable]) –

async aadd_documents(documents: List[Document], **kwargs: Any) → List[str]

异步地通过嵌入运行更多文档并添加到向量存储。

参数

  • documents (List[Document]) – 要添加到向量存储的文档。

  • kwargs (Any) – 附加关键字参数。

返回

添加的文本的 ID 列表。

引发

ValueError – 如果 ID 数量与文档数量不匹配。

返回类型

List[str]

async aadd_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, ids: Optional[Sequence[str]] = None, batch_size: int = 64, **kwargs: Any) → List[str][源代码]

通过嵌入运行更多文本并添加到向量存储。

参数

  • texts (Iterable[str]) – 要添加到向量存储的字符串的可迭代对象。

  • metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。

  • ids (Optional[Sequence[str]]) – 与文本关联的可选 ID 列表。ID 必须是类似 uuid 的字符串。

  • batch_size (int) – 每次请求上传的向量数量。默认值：64

  • kwargs (Any) –

返回

从将文本添加到向量存储中获得的 ID 列表。

返回类型

List[str]

async classmethod aconstruct_instance(texts: List[str], embedding: Embeddings, location: Optional[str] = None, url: Optional[str] = None, port: Optional[int] = 6333, grpc_port: int = 6334, prefer_grpc: bool = False, https: Optional[bool] = None, api_key: Optional[str] = None, prefix: Optional[str] = None, timeout: Optional[float] = None, host: Optional[str] = None, path: Optional[str] = None, collection_name: Optional[str] = None, distance_func: str = 'Cosine', content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', vector_name: Optional[str] = None, shard_number: Optional[int] = None, replication_factor: Optional[int] = None, write_consistency_factor: Optional[int] = None, on_disk_payload: Optional[bool] = None, hnsw_config: Optional[common_types.HnswConfigDiff] = None, optimizers_config: Optional[common_types.OptimizersConfigDiff] = None, wal_config: Optional[common_types.WalConfigDiff] = None, quantization_config: Optional[common_types.QuantizationConfig] = None, init_from: Optional[common_types.InitFrom] = None, on_disk: Optional[bool] = None, force_recreate: bool = False, **kwargs: Any) → Qdrant[source]
参数

  • texts (List[str]) – 文本列表

  • embedding (Embeddings) – 嵌入模型

  • location (Optional[str]) – 位置

  • url (Optional[str]) – URL

  • port (Optional[int]) – 端口

  • grpc_port (int) – gRPC 端口

  • prefer_grpc (bool) – 优先使用 gRPC

  • https (Optional[bool]) – 使用 HTTPS

  • api_key (Optional[str]) – API 密钥

  • prefix (Optional[str]) – 前缀

  • timeout (Optional[float]) – 超时时间

  • host (Optional[str]) – 主机名

  • path (Optional[str]) – 路径

  • collection_name (Optional[str]) – 集合名称

  • distance_func (str) – 距离函数

  • content_payload_key (str) –

  • metadata_payload_key (str) –

  • vector_name (Optional[str]) –

  • shard_number (Optional[int]) – 分片数量

  • replication_factor (Optional[int]) – 副本因子

  • write_consistency_factor (Optional[int]) – 写一致性因子

  • on_disk_payload (Optional[bool]) – 磁盘有效负载

  • hnsw_config (Optional[common_types.HnswConfigDiff]) – HNSW 配置

  • optimizers_config (Optional[common_types.OptimizersConfigDiff]) – 优化器配置

  • wal_config (Optional[common_types.WalConfigDiff]) – WAL 配置

  • quantization_config (Optional[common_types.QuantizationConfig]) – 量化配置

  • init_from (Optional[common_types.InitFrom]) – 从...初始化

  • on_disk (Optional[bool]) – 磁盘存储

  • force_recreate (bool) – 强制重新创建

  • kwargs (Any) –

返回类型

Qdrant

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

在向量存储中添加或更新文档。

参数

  • documents (List[Document]) – 要添加到向量存储的文档。

  • kwargs (Any) – 附加的关键字参数。如果 kwargs 包含 ids 且 documents 包含 ids，则 kwargs 中的 ids 将优先。

返回

添加的文本的 ID 列表。

引发

ValueError – 如果 ids 的数量与 documents 的数量不匹配，则抛出 ValueError 异常。

返回类型

List[str]

add_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, ids: Optional[Sequence[str]] = None, batch_size: int = 64, **kwargs: Any) → List[str][source]

通过嵌入运行更多文本并添加到向量存储。

参数

  • texts (Iterable[str]) – 要添加到向量存储的字符串的可迭代对象。

  • metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。

  • ids (Optional[Sequence[str]]) – 与文本关联的可选 ID 列表。ID 必须是类似 uuid 的字符串。

  • batch_size (int) – 每次请求上传的向量数量。默认值：64

  • kwargs (Any) –

返回

从将文本添加到向量存储中获得的 ID 列表。

返回类型

List[str]

async adelete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool][source]

按向量 ID 或其他条件删除。

参数

  • ids (Optional[List[str]]) – 要删除的 ids 列表。

  • **kwargs (Any) – 子类可能使用的其他关键字参数。

返回

如果删除成功，则返回 True，否则返回 False。

返回类型

Optional[bool]

async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST

异步地从文档和嵌入初始化 VectorStore 并返回。

参数

  • documents (List[Document]) – 要添加到向量存储的文档列表。

  • embedding (Embeddings) – 要使用的嵌入函数。

  • kwargs (Any) – 附加关键字参数。

返回

从文档和嵌入初始化的 VectorStore。

返回类型

VectorStore

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, ids: Optional[Sequence[str]] = None, location: Optional[str] = None, url: Optional[str] = None, port: Optional[int] = 6333, grpc_port: int = 6334, prefer_grpc: bool = False, https: Optional[bool] = None, api_key: Optional[str] = None, prefix: Optional[str] = None, timeout: Optional[float] = None, host: Optional[str] = None, path: Optional[str] = None, collection_name: Optional[str] = None, distance_func: str = 'Cosine', content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', vector_name: Optional[str] = None, batch_size: int = 64, shard_number: Optional[int] = None, replication_factor: Optional[int] = None, write_consistency_factor: Optional[int] = None, on_disk_payload: Optional[bool] = None, hnsw_config: Optional[common_types.HnswConfigDiff] = None, optimizers_config: Optional[common_types.OptimizersConfigDiff] = None, wal_config: Optional[common_types.WalConfigDiff] = None, quantization_config: Optional[common_types.QuantizationConfig] = None, init_from: Optional[common_types.InitFrom] = None, on_disk: Optional[bool] = None, force_recreate: bool = False, **kwargs: Any) → Qdrant[source]

从文本列表构建 Qdrant 包装器。

参数

  • texts (List[str]) – 要在 Qdrant 中索引的文本列表。

  • embedding (Embeddings) – Embeddings 的子类，负责文本向量化。

  • metadatas (Optional[List[dict]]) – 元数据的可选列表。如果提供，则其长度必须与文本列表的长度相同。

  • ids (Optional[Sequence[str]]) – 与文本关联的可选 ID 列表。ID 必须是类似 uuid 的字符串。

  • location (Optional[str]) – 如果为 :memory: - 使用内存中的 Qdrant 实例。 如果为 str - 将其用作 url 参数。 如果为 None - 回退到依赖 host 和 port 参数。

  • url (Optional[str]) – host 或 “Optional[scheme], host, Optional[port], Optional[prefix]” 字符串。 默认值：None

  • port (Optional[int]) – REST API 接口的端口。 默认值：6333

  • grpc_port (int) – gRPC 接口的端口。 默认值：6334

  • prefer_grpc (bool) – 如果为 true - 在自定义方法中尽可能使用 gRPC 接口。 默认值：False

  • https (Optional[bool]) – 如果为 true - 使用 HTTPS(SSL) 协议。 默认值：None

  • api_key (Optional[str]) – 用于 Qdrant Cloud 中身份验证的 API 密钥。 默认值：None

  • prefix (Optional[str]) – 前缀

    如果不为 None - 将前缀添加到 REST URL 路径。 示例：service/v1 将导致

    http://localhost:6333/service/v1/{qdrant-endpoint} 用于 REST API。

    默认值：None

  • timeout (Optional[float]) – REST 和 gRPC API 请求的超时时间。 REST 默认值：5.0 秒，gRPC 默认值：无限制

  • host (Optional[str]) – Qdrant 服务的主机名。 如果 url 和 host 均为 None，则设置为 ‘localhost’。 默认值：None

  • path (Optional[str]) – 在本地模式下存储向量的路径。 默认值：None

  • collection_name (Optional[str]) – 要使用的 Qdrant 集合的名称。 如果未提供，将随机创建。 默认值：None

  • distance_func (str) – 距离函数。选项包括：“Cosine” / “Euclid” / “Dot”。 默认值：“Cosine”

  • content_payload_key (str) – 用于存储文档内容的有效负载键。 默认值：“page_content”

  • metadata_payload_key (str) – 用于存储文档元数据的有效负载键。 默认值：“metadata”

  • vector_name (Optional[str]) – 在 Qdrant 内部使用的向量名称。 默认值：None

  • batch_size (int) – 每次请求上传的向量数量。默认值：64

  • shard_number (Optional[int]) – 集合中的分片数量。 默认值为 1，最小值为 1。

  • replication_factor (Optional[int]) – 集合的副本因子。 默认值为 1，最小值为 1。 定义将创建的每个分片的副本数量。 仅在分布式模式下有效。

  • write_consistency_factor (Optional[int]) – 集合的写入一致性因子。 默认值为 1，最小值为 1。 定义应应用操作以使我们认为操作成功的副本数。 增加此数字将使集合对不一致性更具弹性，但如果可用副本不足，也会使其失败。 不会产生任何性能影响。 仅在分布式模式下有效。

  • on_disk_payload (Optional[bool]) – 如果为 true - point 的有效负载将不会存储在内存中。 每次请求时，都将从磁盘读取。 此设置通过（稍微）增加响应时间来节省 RAM。 注意：参与过滤且已索引的那些有效负载值仍保留在 RAM 中。

  • hnsw_config (可选[common_types.HnswConfigDiff]) – HNSW 索引的参数

  • optimizers_config (可选[common_types.OptimizersConfigDiff]) – 优化器的参数

  • wal_config (可选[common_types.WalConfigDiff]) – 预写日志的参数

  • quantization_config (可选[common_types.QuantizationConfig]) – 量化参数，如果为 None - 量化将被禁用

  • init_from (可选[common_types.InitFrom]) – 使用存储在另一个集合中的数据来初始化此集合

  • force_recreate (bool) – 强制重新创建集合

  • **kwargs (Any) – 直接传递到 REST 客户端初始化的附加参数

  • on_disk (Optional[bool]) – 磁盘存储

返回类型

Qdrant

这是一个用户友好的界面，它：1. 为每个文本创建嵌入 2. 默认将 Qdrant 数据库初始化为内存文档存储

(并且可以覆盖为远程文档存储)

  1. 将文本嵌入添加到 Qdrant 数据库

这旨在成为快速入门的方法。

示例

from langchain_community.vectorstores import Qdrant
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
qdrant = await Qdrant.afrom_texts(texts, embeddings, "localhost")
async aget_by_ids(ids: Sequence[str], /) → List[Document]

异步地通过 ID 获取文档。

返回的文档应将 ID 字段设置为向量存储中文档的 ID。

如果某些 ID 未找到或存在重复 ID，则返回的文档可能少于请求的文档。

用户不应假设返回文档的顺序与输入 ID 的顺序匹配。相反，用户应依赖返回文档的 ID 字段。

如果某些 ID 未找到文档，则此方法不应引发异常。

参数

ids (Sequence[str]) – 要检索的 ID 列表。

返回

文档列表。

返回类型

List[Document]

0.2.11 版本新增功能。

返回使用最大边际相关性选择的文档。

最大边际相关性优化查询的相似性和所选文档之间的多样性。

参数

  • query (str) – 用于查找相似文档的文本。

  • k (int) – 要返回的文档数量。默认为 4。

  • fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。

  • lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 要传递给 AsyncQdrantClient.Search() 的任何其他命名参数。

返回

通过最大边际相关性选择的文档列表。

返回类型

List[Document]

async amax_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[MetadataFilter] = None, search_params: Optional[common_types.SearchParams] = None, score_threshold: Optional[float] = None, consistency: Optional[common_types.ReadConsistency] = None, **kwargs: Any) → List[Document][source]

返回使用最大边际相关性选择的文档。最大边际相关性优化查询的相似性和所选文档之间的多样性。 :param query: 用于查找相似文档的文本。 :param k: 要返回的文档数量。默认为 4。 :param fetch_k: 要获取并传递给 MMR 算法的文档数量。

默认为 20。

参数

  • lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 要传递给 AsyncQdrantClient.Search() 的任何其他命名参数。

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

返回

通过最大边际相关性选择的文档列表以及每个文档的距离。

返回类型

List[Document]

async amax_marginal_relevance_search_with_score_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[MetadataFilter] = None, search_params: Optional[common_types.SearchParams] = None, score_threshold: Optional[float] = None, consistency: Optional[common_types.ReadConsistency] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

返回使用最大边际相关性选择的文档。最大边际相关性优化查询的相似性和所选文档之间的多样性。 :param query: 用于查找相似文档的文本。 :param k: 要返回的文档数量。默认为 4。 :param fetch_k: 要获取并传递给 MMR 算法的文档数量。

默认为 20。

参数

  • lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • filter (Optional[MetadataFilter]) –

  • search_params (Optional[common_types.SearchParams]) –

  • score_threshold (Optional[float]) –

  • consistency (Optional[common_types.ReadConsistency]) –

  • kwargs (Any) –

返回

通过最大边际相关性选择的文档列表以及每个文档的距离。

返回类型

List[Tuple[Document, float]]

as_retriever(**kwargs: Any) → VectorStoreRetriever

返回由此 VectorStore 初始化的 VectorStoreRetriever。

参数

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括： search_type (Optional[str]): 定义搜索类型的

Retriever 应执行的搜索类型。可以是 “similarity”（默认）、“mmr” 或 “similarity_score_threshold”。

search_kwargs (Optional[Dict]): 传递给
搜索函数的关键字参数。可以包括诸如

k: 要返回的文档数量（默认值：4） score_threshold: 相似度分数阈值的最小相关性阈值

对于 similarity_score_threshold

fetch_k: 要传递给 MMR 算法的文档数量

（默认值：20）

lambda_mult: MMR 返回结果的多样性；

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

filter: 按文档元数据筛选

返回

VectorStore 的 Retriever 类。

返回类型

VectorStoreRetriever

示例

# Retrieve more documents with higher diversity
# Useful if your dataset has many similar documents
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# Fetch more documents for the MMR algorithm to consider
# But only return the top 5
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# Only retrieve documents that have a relevance score
# Above a certain threshold
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# Only get the single most similar document from the dataset
docsearch.as_retriever(search_kwargs={'k': 1})

# Use a filter to only retrieve documents from a specific paper
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)
async asearch(query: str, search_type: str, **kwargs: Any) → List[Document]

异步地返回与使用指定搜索类型查询最相似的文档。

参数

  • query (str) – 输入文本。

  • search_type (str) – 要执行的搜索类型。可以是 “similarity”、“mmr” 或 “similarity_score_threshold”。

  • **kwargs (Any) – 传递给搜索方法的参数。

返回

与查询最相似的文档列表。

引发

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

返回类型

List[Document]

返回与查询最相似的文档。 :param query: 用于查找相似文档的文本。 :param k: 要返回的文档数量。默认为 4。 :param filter: 按元数据筛选。默认为 None。

返回

与查询最相似的文档列表。

参数

  • query (str) –

  • k (int) –

  • filter (Optional[MetadataFilter]) –

  • kwargs (Any) –

返回类型

List[Document]

async asimilarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[MetadataFilter] = None, search_params: Optional[common_types.SearchParams] = None, offset: int = 0, score_threshold: Optional[float] = None, consistency: Optional[common_types.ReadConsistency] = None, **kwargs: Any) → List[Document][source]

返回与嵌入向量最相似的文档。

参数

  • embedding (List[float]) – 用于查找相似文档的嵌入向量。

  • k (int) – 要返回的文档数量。默认为 4。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • offset (int) – 要返回的第一个结果的偏移量。可用于分页结果。注意：较大的偏移值可能会导致性能问题。

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 要传递给 AsyncQdrantClient.Search() 的任何其他命名参数。

返回

与查询最相似的文档列表。

返回类型

List[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]

异步地返回范围在 [0, 1] 内的文档和相关性分数。

0 表示不相似，1 表示最相似。

参数

  • query (str) – 输入文本。

  • k (int) – 要返回的文档数量。默认为 4。

  • **kwargs (Any) –

    要传递给相似性搜索的 kwargs。应包括： score_threshold: 可选，介于 0 到 1 之间的浮点值，用于

    筛选检索到的文档结果集

返回

元组列表 (doc, similarity_score)

返回类型

List[Tuple[Document, float]]

async asimilarity_search_with_score(query: str, k: int = 4, filter: Optional[MetadataFilter] = None, search_params: Optional[common_types.SearchParams] = None, offset: int = 0, score_threshold: Optional[float] = None, consistency: Optional[common_types.ReadConsistency] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

返回与查询最相似的文档。

参数

  • query (str) – 用于查找相似文档的文本。

  • k (int) – 要返回的文档数量。默认为 4。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • offset (int) – 要返回的第一个结果的偏移量。可用于分页结果。注意：较大的偏移值可能会导致性能问题。

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 要传递给 AsyncQdrantClient.Search() 的任何其他命名参数。

返回

与查询文本最相似的文档列表以及每个文档的距离。

返回类型

List[Tuple[Document, float]]

async asimilarity_search_with_score_by_vector(embedding: List[float], k: int = 4, filter: Optional[MetadataFilter] = None, search_params: Optional[common_types.SearchParams] = None, offset: int = 0, score_threshold: Optional[float] = None, consistency: Optional[common_types.ReadConsistency] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

返回与嵌入向量最相似的文档。

参数

  • embedding (List[float]) – 用于查找相似文档的嵌入向量。

  • k (int) – 要返回的文档数量。默认为 4。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • offset (int) – 要返回的第一个结果的偏移量。可用于分页结果。注意：较大的偏移值可能会导致性能问题。

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 要传递给 AsyncQdrantClient.Search() 的任何其他命名参数。

返回

与查询文本最相似的文档列表以及每个文档的距离。

返回类型

List[Tuple[Document, float]]

astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) → AsyncIterator[UpsertResponse]

Beta

在 0.2.11 中添加。API 可能会发生变化。

以流式方式 Upsert 文档。streaming_upsert 的异步版本。

参数

  • items (AsyncIterable[Document]) – 要添加到向量存储的文档的可迭代对象。

  • batch_size (int) – 每次 upsert 的批次大小。

  • kwargs (Any) – 附加关键字参数。kwargs 应仅包含所有文档通用的参数。（例如，索引超时、重试策略等）kwargs 不应包含 ids 以避免语义模糊。相反，ID 应作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

返回类型

AsyncIterator[UpsertResponse]

0.2.11 版本新增功能。

async aupsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse

Beta

在 0.2.11 中添加。API 可能会发生变化。

在向量存储中添加或更新文档。upsert 的异步版本。

Upsert 功能应使用提供的 Document 对象的 ID 字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

当指定了 ID 并且该文档已存在于向量数据库中时，upsert 方法应使用新数据更新该文档。如果该文档不存在，则 upsert 方法应将该文档添加到向量数据库。

参数

  • items (Sequence[Document]) – 要添加到向量数据库的 Document 序列。

  • kwargs (Any) – 附加关键字参数。

返回

一个响应对象，其中包含已成功添加或更新到向量数据库的 ID 列表，以及添加或更新失败的 ID 列表。

返回类型

UpsertResponse

0.2.11 版本新增功能。

classmethod construct_instance(texts: List[str], embedding: Embeddings, location: Optional[str] = None, url: Optional[str] = None, port: Optional[int] = 6333, grpc_port: int = 6334, prefer_grpc: bool = False, https: Optional[bool] = None, api_key: Optional[str] = None, prefix: Optional[str] = None, timeout: Optional[float] = None, host: Optional[str] = None, path: Optional[str] = None, collection_name: Optional[str] = None, distance_func: str = 'Cosine', content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', vector_name: Optional[str] = None, shard_number: Optional[int] = None, replication_factor: Optional[int] = None, write_consistency_factor: Optional[int] = None, on_disk_payload: Optional[bool] = None, hnsw_config: Optional[common_types.HnswConfigDiff] = None, optimizers_config: Optional[common_types.OptimizersConfigDiff] = None, wal_config: Optional[common_types.WalConfigDiff] = None, quantization_config: Optional[common_types.QuantizationConfig] = None, init_from: Optional[common_types.InitFrom] = None, on_disk: Optional[bool] = None, force_recreate: bool = False, **kwargs: Any) → Qdrant[source]
参数

  • texts (List[str]) – 文本列表

  • embedding (Embeddings) – 嵌入模型

  • location (Optional[str]) – 位置

  • url (Optional[str]) – URL

  • port (Optional[int]) – 端口

  • grpc_port (int) – gRPC 端口

  • prefer_grpc (bool) – 优先使用 gRPC

  • https (Optional[bool]) – 使用 HTTPS

  • api_key (Optional[str]) – API 密钥

  • prefix (Optional[str]) – 前缀

  • timeout (Optional[float]) – 超时时间

  • host (Optional[str]) – 主机名

  • path (Optional[str]) – 路径

  • collection_name (Optional[str]) – 集合名称

  • distance_func (str) – 距离函数

  • content_payload_key (str) –

  • metadata_payload_key (str) –

  • vector_name (Optional[str]) –

  • shard_number (Optional[int]) – 分片数量

  • replication_factor (Optional[int]) – 副本因子

  • write_consistency_factor (Optional[int]) – 写一致性因子

  • on_disk_payload (Optional[bool]) – 磁盘有效负载

  • hnsw_config (Optional[common_types.HnswConfigDiff]) – HNSW 配置

  • optimizers_config (Optional[common_types.OptimizersConfigDiff]) – 优化器配置

  • wal_config (Optional[common_types.WalConfigDiff]) – WAL 配置

  • quantization_config (Optional[common_types.QuantizationConfig]) – 量化配置

  • init_from (Optional[common_types.InitFrom]) – 从...初始化

  • on_disk (Optional[bool]) – 磁盘存储

  • force_recreate (bool) – 强制重新创建

  • kwargs (Any) –

返回类型

Qdrant

delete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool][source]

按向量 ID 或其他条件删除。

参数

  • ids (Optional[List[str]]) – 要删除的 ids 列表。

  • **kwargs (Any) – 子类可能使用的其他关键字参数。

返回

如果删除成功，则返回 True，否则返回 False。

返回类型

Optional[bool]

classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST

从文档和嵌入初始化 VectorStore 并返回。

参数

  • documents (List[Document]) – 要添加到向量存储的文档列表。

  • embedding (Embeddings) – 要使用的嵌入函数。

  • kwargs (Any) – 附加关键字参数。

返回

从文档和嵌入初始化的 VectorStore。

返回类型

VectorStore

classmethod from_existing_collection(embedding: Embeddings, path: str, collection_name: str, location: Optional[str] = None, url: Optional[str] = None, port: Optional[int] = 6333, grpc_port: int = 6334, prefer_grpc: bool = False, https: Optional[bool] = None, api_key: Optional[str] = None, prefix: Optional[str] = None, timeout: Optional[float] = None, host: Optional[str] = None, **kwargs: Any) → Qdrant[source]

获取现有 Qdrant 集合的实例。此方法将返回存储的实例，而无需插入任何新的嵌入。

参数

  • embedding (Embeddings) – 嵌入模型

  • path (str) –

  • collection_name (str) –

  • location (Optional[str]) – 位置

  • url (Optional[str]) – URL

  • port (Optional[int]) – 端口

  • grpc_port (int) – gRPC 端口

  • prefer_grpc (bool) – 优先使用 gRPC

  • https (Optional[bool]) – 使用 HTTPS

  • api_key (Optional[str]) – API 密钥

  • prefix (Optional[str]) – 前缀

  • timeout (Optional[float]) – 超时时间

  • host (Optional[str]) – 主机名

  • kwargs (Any) –

返回类型

Qdrant

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, ids: Optional[Sequence[str]] = None, location: Optional[str] = None, url: Optional[str] = None, port: Optional[int] = 6333, grpc_port: int = 6334, prefer_grpc: bool = False, https: Optional[bool] = None, api_key: Optional[str] = None, prefix: Optional[str] = None, timeout: Optional[float] = None, host: Optional[str] = None, path: Optional[str] = None, collection_name: Optional[str] = None, distance_func: str = 'Cosine', content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', vector_name: Optional[str] = None, batch_size: int = 64, shard_number: Optional[int] = None, replication_factor: Optional[int] = None, write_consistency_factor: Optional[int] = None, on_disk_payload: Optional[bool] = None, hnsw_config: Optional[common_types.HnswConfigDiff] = None, optimizers_config: Optional[common_types.OptimizersConfigDiff] = None, wal_config: Optional[common_types.WalConfigDiff] = None, quantization_config: Optional[common_types.QuantizationConfig] = None, init_from: Optional[common_types.InitFrom] = None, on_disk: Optional[bool] = None, force_recreate: bool = False, **kwargs: Any) → Qdrant[source]

从文本列表构建 Qdrant 包装器。

参数

  • texts (List[str]) – 要在 Qdrant 中索引的文本列表。

  • embedding (Embeddings) – Embeddings 的子类，负责文本向量化。

  • metadatas (Optional[List[dict]]) – 元数据的可选列表。如果提供，则其长度必须与文本列表的长度相同。

  • ids (Optional[Sequence[str]]) – 与文本关联的可选 ID 列表。ID 必须是类似 uuid 的字符串。

  • location (Optional[str]) – 如果为 :memory: - 使用内存中的 Qdrant 实例。 如果为 str - 将其用作 url 参数。 如果为 None - 回退到依赖 host 和 port 参数。

  • url (Optional[str]) – host 或 “Optional[scheme], host, Optional[port], Optional[prefix]” 字符串。 默认值：None

  • port (Optional[int]) – REST API 接口的端口。 默认值：6333

  • grpc_port (int) – gRPC 接口的端口。 默认值：6334

  • prefer_grpc (bool) – 如果为 true - 在自定义方法中尽可能使用 gRPC 接口。 默认值：False

  • https (Optional[bool]) – 如果为 true - 使用 HTTPS(SSL) 协议。 默认值：None

  • api_key (Optional[str]) – 用于 Qdrant Cloud 中身份验证的 API 密钥。 默认值：None

  • prefix (Optional[str]) – 前缀

    如果不为 None - 将前缀添加到 REST URL 路径。 示例：service/v1 将导致

    http://localhost:6333/service/v1/{qdrant-endpoint} 用于 REST API。

    默认值：None

  • timeout (Optional[float]) – REST 和 gRPC API 请求的超时时间。 REST 默认值：5.0 秒，gRPC 默认值：无限制

  • host (Optional[str]) – Qdrant 服务的主机名。 如果 url 和 host 均为 None，则设置为 ‘localhost’。 默认值：None

  • path (Optional[str]) – 在本地模式下存储向量的路径。 默认值：None

  • collection_name (Optional[str]) – 要使用的 Qdrant 集合的名称。 如果未提供，将随机创建。 默认值：None

  • distance_func (str) – 距离函数。选项包括：“Cosine” / “Euclid” / “Dot”。 默认值：“Cosine”

  • content_payload_key (str) – 用于存储文档内容的有效负载键。 默认值：“page_content”

  • metadata_payload_key (str) – 用于存储文档元数据的有效负载键。 默认值：“metadata”

  • vector_name (Optional[str]) – 在 Qdrant 内部使用的向量名称。 默认值：None

  • batch_size (int) – 每次请求上传的向量数量。默认值：64

  • shard_number (Optional[int]) – 集合中的分片数量。 默认值为 1，最小值为 1。

  • replication_factor (Optional[int]) – 集合的副本因子。 默认值为 1，最小值为 1。 定义将创建的每个分片的副本数量。 仅在分布式模式下有效。

  • write_consistency_factor (Optional[int]) – 集合的写入一致性因子。 默认值为 1，最小值为 1。 定义应应用操作以使我们认为操作成功的副本数。 增加此数字将使集合对不一致性更具弹性，但如果可用副本不足，也会使其失败。 不会产生任何性能影响。 仅在分布式模式下有效。

  • on_disk_payload (Optional[bool]) – 如果为 true - point 的有效负载将不会存储在内存中。 每次请求时，都将从磁盘读取。 此设置通过（稍微）增加响应时间来节省 RAM。 注意：参与过滤且已索引的那些有效负载值仍保留在 RAM 中。

  • hnsw_config (可选[common_types.HnswConfigDiff]) – HNSW 索引的参数

  • optimizers_config (可选[common_types.OptimizersConfigDiff]) – 优化器的参数

  • wal_config (可选[common_types.WalConfigDiff]) – 预写日志的参数

  • quantization_config (可选[common_types.QuantizationConfig]) – 量化参数，如果为 None - 量化将被禁用

  • init_from (可选[common_types.InitFrom]) – 使用存储在另一个集合中的数据来初始化此集合

  • force_recreate (bool) – 强制重新创建集合

  • **kwargs (Any) – 直接传递到 REST 客户端初始化的附加参数

  • on_disk (Optional[bool]) – 磁盘存储

返回类型

Qdrant

这是一个用户友好的界面，它：1. 为每个文本创建嵌入 2. 默认将 Qdrant 数据库初始化为内存文档存储

(并且可以覆盖为远程文档存储)

  1. 将文本嵌入添加到 Qdrant 数据库

这旨在成为快速入门的方法。

示例

from langchain_community.vectorstores import Qdrant
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
qdrant = Qdrant.from_texts(texts, embeddings, "localhost")
get_by_ids(ids: Sequence[str], /) → List[Document]

通过 ID 获取文档。

返回的文档应将 ID 字段设置为向量存储中文档的 ID。

如果某些 ID 未找到或存在重复 ID，则返回的文档可能少于请求的文档。

用户不应假设返回文档的顺序与输入 ID 的顺序匹配。相反，用户应依赖返回文档的 ID 字段。

如果某些 ID 未找到文档，则此方法不应引发异常。

参数

ids (Sequence[str]) – 要检索的 ID 列表。

返回

文档列表。

返回类型

List[Document]

0.2.11 版本新增功能。

返回使用最大边际相关性选择的文档。

最大边际相关性优化查询的相似性和所选文档之间的多样性。

参数

  • query (str) – 用于查找相似文档的文本。

  • k (int) – 要返回的文档数量。默认为 4。

  • fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。

  • lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 传递给 QdrantClient.search() 的任何其他命名参数

返回

通过最大边际相关性选择的文档列表。

返回类型

List[Document]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[MetadataFilter] = None, search_params: Optional[common_types.SearchParams] = None, score_threshold: Optional[float] = None, consistency: Optional[common_types.ReadConsistency] = None, **kwargs: Any) → List[Document][source]

返回使用最大边际相关性选择的文档。

最大边际相关性优化查询的相似性和所选文档之间的多样性。

参数

  • embedding (List[float]) – 用于查找相似文档的嵌入向量。

  • k (int) – 要返回的文档数量。默认为 4。

  • fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。

  • lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 传递给 QdrantClient.search() 的任何其他命名参数

返回

通过最大边际相关性选择的文档列表。

返回类型

List[Document]

max_marginal_relevance_search_with_score_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[MetadataFilter] = None, search_params: Optional[common_types.SearchParams] = None, score_threshold: Optional[float] = None, consistency: Optional[common_types.ReadConsistency] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

返回使用最大边际相关性选择的文档。最大边际相关性优化查询的相似性和所选文档之间的多样性。 :param query: 用于查找相似文档的文本。 :param k: 要返回的文档数量。默认为 4。 :param fetch_k: 要获取并传递给 MMR 算法的文档数量。

默认为 20。

参数

  • lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 传递给 QdrantClient.search() 的任何其他命名参数

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

返回

通过最大边际相关性选择的文档列表以及每个文档的距离。

返回类型

List[Tuple[Document, float]]

search(query: str, search_type: str, **kwargs: Any) → List[Document]

返回与使用指定搜索类型查询最相似的文档。

参数

  • query (str) – 输入文本

  • search_type (str) – 要执行的搜索类型。可以是 “similarity”、“mmr” 或 “similarity_score_threshold”。

  • **kwargs (Any) – 传递给搜索方法的参数。

返回

与查询最相似的文档列表。

引发

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

返回类型

List[Document]

返回与查询最相似的文档。

参数

  • query (str) – 用于查找相似文档的文本。

  • k (int) – 要返回的文档数量。默认为 4。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • offset (int) – 要返回的第一个结果的偏移量。可用于分页结果。注意：较大的偏移值可能会导致性能问题。

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 传递给 QdrantClient.search() 的任何其他命名参数

返回

与查询最相似的文档列表。

返回类型

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[MetadataFilter] = None, search_params: Optional[common_types.SearchParams] = None, offset: int = 0, score_threshold: Optional[float] = None, consistency: Optional[common_types.ReadConsistency] = None, **kwargs: Any) → List[Document][source]

返回与嵌入向量最相似的文档。

参数

  • embedding (List[float]) – 用于查找相似文档的嵌入向量。

  • k (int) – 要返回的文档数量。默认为 4。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • offset (int) – 要返回的第一个结果的偏移量。可用于分页结果。注意：较大的偏移值可能会导致性能问题。

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 传递给 QdrantClient.search() 的任何其他命名参数

返回

与查询最相似的文档列表。

返回类型

List[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]

返回范围在 [0, 1] 内的文档和相关性分数。

0 表示不相似，1 表示最相似。

参数

  • query (str) – 输入文本。

  • k (int) – 要返回的文档数量。默认为 4。

  • **kwargs (Any) –

    要传递给相似性搜索的 kwargs。应包括： score_threshold: 可选，介于 0 到 1 之间的浮点值，用于

    过滤检索到的文档结果集。

返回

（文档，相似度评分）元组的列表。

返回类型

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, filter: Optional[MetadataFilter] = None, search_params: Optional[common_types.SearchParams] = None, offset: int = 0, score_threshold: Optional[float] = None, consistency: Optional[common_types.ReadConsistency] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

返回与查询最相似的文档。

参数

  • query (str) – 用于查找相似文档的文本。

  • k (int) – 要返回的文档数量。默认为 4。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • offset (int) – 要返回的第一个结果的偏移量。可用于分页结果。注意：较大的偏移值可能会导致性能问题。

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 传递给 QdrantClient.search() 的任何其他命名参数

返回

与查询文本最相似的文档列表以及每个文档的距离。

返回类型

List[Tuple[Document, float]]

similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, filter: Optional[MetadataFilter] = None, search_params: Optional[common_types.SearchParams] = None, offset: int = 0, score_threshold: Optional[float] = None, consistency: Optional[common_types.ReadConsistency] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

返回与嵌入向量最相似的文档。

参数

  • embedding (List[float]) – 用于查找相似文档的嵌入向量。

  • k (int) – 要返回的文档数量。默认为 4。

  • filter (Optional[MetadataFilter]) – 按元数据筛选。默认为 None。

  • search_params (Optional[common_types.SearchParams]) – 附加搜索参数

  • offset (int) – 要返回的第一个结果的偏移量。可用于分页结果。注意：较大的偏移值可能会导致性能问题。

  • score_threshold (Optional[float]) – 定义结果的最小分数阈值。如果已定义，则不会返回相似度较低的结果。返回结果的分数可能高于或低于阈值，具体取决于使用的距离函数。例如，对于余弦相似度，只会返回更高的分数。

  • consistency (Optional[common_types.ReadConsistency]) –

    搜索的读取一致性。定义在返回结果之前应查询多少个副本。值：- int - 要查询的副本数，值应存在于所有

    查询的副本中

    • ’majority’ - 查询所有副本，但返回存在于

      大多数副本中的值

    • ’quorum’ - 查询大多数副本，返回存在于

      所有副本中的值

    • ’all’ - 查询所有副本，并返回存在于所有副本中的值

  • **kwargs (Any) – 传递给 QdrantClient.search() 的任何其他命名参数

返回

与查询文本最相似的文档列表以及每个文档的距离。

返回类型

List[Tuple[Document, float]]

streaming_upsert(items: Iterable[Document], /, batch_size: int, **kwargs: Any) → Iterator[UpsertResponse]

Beta

在 0.2.11 中添加。API 可能会发生变化。

以流式方式更新文档。

参数

  • items (Iterable[Document]) – 要添加到向量存储的可迭代文档。

  • batch_size (int) – 每次 upsert 的批次大小。

  • kwargs (Any) – 额外的关键字参数。kwargs 应该只包含所有文档通用的参数。（例如，索引超时、重试策略等）kwargs 不应包含 id 以避免语义模糊。相反，ID 应该作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

返回类型

Iterator[UpsertResponse]

0.2.11 版本新增功能。

upsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse

Beta

在 0.2.11 中添加。API 可能会发生变化。

在向量存储中添加或更新文档。

Upsert 功能应使用提供的 Document 对象的 ID 字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

当指定了 ID 并且该文档已存在于向量数据库中时，upsert 方法应使用新数据更新该文档。如果该文档不存在，则 upsert 方法应将该文档添加到向量数据库。

参数

  • items (Sequence[Document]) – 要添加到向量数据库的 Document 序列。

  • kwargs (Any) – 附加关键字参数。

返回

一个响应对象，其中包含已成功添加或更新到向量数据库的 ID 列表，以及添加或更新失败的 ID 列表。

返回类型

UpsertResponse

0.2.11 版本新增功能。

Qdrant 使用示例