langchain_qdrant.vectorstores.Qdrant

class langchain_qdrant.vectorstores.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)[source]

自版本 0.1.2 起已弃用: 请使用 QdrantVectorStore 代替。

Qdrant 矢量存储。

示例

from qdrant_client import QdrantClient
from langchain_qdrant 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 (任何) –

  • collection_name (字符串) –

  • embeddings (可选[Embeddings]) –

  • content_payload_key (字符串) –

  • metadata_payload_key (字符串) –

  • distance_strategy (字符串) –

  • vector_name (可选[字符串]) –

  • async_client (可选[任何]) –

  • embedding_function (可选[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)[source]

使用必要组件初始化。

参数

  • client (任何) –

  • collection_name (字符串) –

  • embeddings (可选[Embeddings]) –

  • content_payload_key (字符串) –

  • metadata_payload_key (字符串) –

  • distance_strategy (字符串) –

  • vector_name (可选[字符串]) –

  • async_client (可选[任何]) –

  • embedding_function (可选[Callable]) –

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

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

参数

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

  • kwargs (任意) – 额外的关键字参数。

返回

添加文本的ID列表。

引发

值错误 – 如果ID的数量与文档的数量不匹配。

返回类型

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

将更多文本通过嵌入并添加到向量库中。

参数

  • texts (Iterable[

  • metadatas (Optional[

  • ids (Optional[

  • batch_size (int) – 每个请求上传多少个向量。默认：64

  • kwargs (Any) –

返回

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

返回类型

列表[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[int] = 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[HnswConfigDiff] = None, optimizers_config: Optional[OptimizersConfigDiff] = None, wal_config: Optional[WalConfigDiff] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, init_from: Optional[InitFrom] = None, on_disk: Optional[bool] = None, force_recreate: bool = False, **kwargs: Any) → Qdrant[source]
参数

  • texts (列表[str]> ) –

  • embedding (Embeddings) –

  • location (Optional[

  • url (Optional[

  • port (Optional[

  • grpc_port (int) –

  • prefer_grpc (bool) –

  • https (Optional[

  • api_key (Optional[

  • prefix (Optional[

  • timeout (Optional[

  • host (Optional[

  • path (Optional[

  • collection_name (Optional[

  • distance_func (str) –

  • content_payload_key (字符串) –

  • metadata_payload_key (字符串) –

  • vector_name (可选[字符串]) –

  • shard_number (Optional[

  • replication_factor (Optional[

  • write_consistency_factor (Optional[

  • on_disk_payload (Optional[

  • hnsw_config (Optional[

  • optimizers_config (Optional[

  • wal_config (Optional[

  • quantization_config (可选[联合[ScalarQuantization, ProductQuantization, BinaryQuantization]]) –

  • init_from (可选[InitFrom]) –

  • on_disk (可选[布尔]) –

  • force_recreate (布尔) –

  • kwargs (Any) –

返回类型

Qdrant

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

向向量库中添加或更新文档。

参数

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

  • kwargs (任意的) – 其他关键字参数。如果kwargs包含ids且documents也包含ids，kwargs中的ids将具有优先权。

返回

添加文本的ID列表。

引发

ValueError – 如果ids的数量不匹配文档的数量。

返回类型

列表[str]

add_texts(texts: 可迭代[str], metadatas: 可选[List[dict]] = None, ids: 可选[序列[str]] = None, batch_size: int = 64, **kwargs: 任意的) → List[str][source]

将更多文本通过嵌入并添加到向量库中。

参数

  • texts (Iterable[

  • metadatas (Optional[

  • ids (Optional[

  • batch_size (int) – 每个请求上传多少个向量。默认：64

  • kwargs (Any) –

返回

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

返回类型

列表[str]

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

根据向量ID或其他标准删除。

参数

  • ids (可选[str列表]) – 要删除的id列表。

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

返回

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

返回类型

可选[bool]

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

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

参数

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

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

  • kwargs (任意) – 额外的关键字参数。

返回

从文档和嵌入初始化的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[int] = 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[HnswConfigDiff] = None, optimizers_config: Optional[OptimizersConfigDiff] = None, wal_config: Optional[WalConfigDiff] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, init_from: Optional[InitFrom] = None, on_disk: Optional[bool] = None, force_recreate: bool = False, **kwargs: Any) → Qdrant[source]

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

参数

  • texts (字符串列表) – 要在Qdrant中索引的文本列表。

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

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

  • ids (Optional[

  • location (可选[字符串]) – 如果为‘:memory:’，则使用内存中的Qdrant实例。如果为字符串，则将其作为URL参数使用。如果为None，则回退到依赖于host和port参数。

  • url (可选[字符串]) – 要么是主机，要么是“Optional[scheme], host, Optional[port], Optional[prefix]”的字符串。默认：None

  • 端口号 (可选[int]) – REST API 接口的端口号。默认：6333

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

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

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

  • api_key (可选[str]) – Qdrant 云中的认证 API 密钥。默认：None。也可以通过环境变量 QDRANT_API_KEY 设置。

  • prefix (Optional[

    如果非 None - 添加前缀到 REST URL 路径。示例：service/v1 将会变为

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

    默认：None

  • timeout (可选[int]) – REST 和 gRPC API 请求的超时时间。默认：REST 为 5.0 秒，gRPC 无限制。

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

  • path (可选[str]) – 在使用本地模式时存储矢量的路径。默认：None

  • collection_name (可选[str]) – 要使用的 Qdrant 集合的名称。如果不提供，则会随机创建。默认：None

  • distance_func (str) – 距离函数。其中一个： “余弦” / “欧几里得” / “点积”。默认： “余弦”

  • content_payload_key (str) – 用于存储文档内容的一个负载密钥。默认： “page_content”

  • metadata_payload_key (str) – 用于存储文档元数据的一个负载密钥。默认： “metadata”

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

  • batch_size (int) – 每个请求上传多少个向量。默认：64

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

  • replication_factor (可选[int]) – 集合的复制因子。默认为 1，最小值为 1。定义了每个分片将被创建多少份副本。仅在分布式模式中生效。

  • write_consistency_factor (可选[int]) – 集合的写一致性因子。默认为 1，最小值为 1。定义了应该有多少个副本应用操作才能使我们认为它是成功的。增加这个数字会使集合对不一致性更加具有弹性，但如果没有足够的副本，它也会失败。不会对性能产生影响。仅在分布式模式中生效。

  • on_disk_payload (可选[bool]) – 如果为 true - 点的负载不会存储在内存中。每次请求时都会从磁盘读取。这个设置通过（略微）增加响应时间来节省内存。注意：那些涉及过滤和索引的负载值仍然保留在 RAM 中。

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

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

  • wal_config (可选[WalConfigDiff]) – 写前记录的参数

  • quantization_config (可选[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]]) – 量化的参数，如果为 None - 量化将被禁用

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

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

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

  • on_disk (可选[布尔]) –

返回类型

Qdrant

这是一个用户友好的界面，具有以下功能：1. 为每个文本创建嵌入 2. 默认初始化Qdrant数据库作为内存中的文档存储器

（可以覆盖为远程文档存储）

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

这是一个快速开始的便捷方式。

示例

from langchain_qdrant import Qdrant
from langchain_openai 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 () – 返回的文档数量。默认为4。

  • fetch_k () – 获取用于传递给MMR算法的文档数。默认为20。

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

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

  • consistency (Optional[models.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[models.SearchParams] = None, score_threshold: Optional[float] = None, consistency: Optional[models.ReadConsistency] = None, **kwargs: Any) → List[Document][source]

通过最大边际相关性返回选择的文档。最大边际相关性优化查询相似度以及所选文档之间的多样性。：参数 query：查找与文本相似的文档的文本。：参数 k：返回的文档数量。默认为4。：参数 fetch_k：传递给MMR算法的文档数量。

默认为20。

参数

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

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

  • consistency (Optional[models.ReadConsistency]) –

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

    已查询的副本

    • ‘majority’ - 查询所有副本，但仅返回存在于大多数副本中的值

      的值

    • ‘quorum’ - 查询大多数副本，并返回在这些副本中都存在的值

      所有副本中都存在的值

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

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

  • 嵌入 （浮点数列表） –

  • k （整数） –

  • fetch_k （整数） –

返回

最大边际相关性和每个选择的文档的距离列表。

返回类型

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[models.SearchParams] = None, score_threshold: Optional[float] = None, consistency: Optional[models.ReadConsistency] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

通过最大边际相关性返回选择的文档。最大边际相关性优化查询相似度以及所选文档之间的多样性。：参数 query：查找与文本相似的文档的文本。：参数 k：返回的文档数量。默认为4。：参数 fetch_k：传递给MMR算法的文档数量。

默认为20。

参数

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

  • 嵌入 （浮点数列表） –

  • k （整数） –

  • fetch_k （整数） –

  • filter (可选[MetadataFilter]) –

  • search_params (可选[models.SearchParams]) –

  • score_threshold (可选[浮点数]) –

  • consistency (Optional[models.ReadConsistency]) –

  • kwargs (Any) –

返回

最大边际相关性和每个选择的文档的距离列表。

返回类型

列表[Tuple[Document, float]]

as_retriever(**kwargs: Any) → VectorStoreRetriever

从当前的VectorStore初始化VectorStoreRetriever。

参数

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包含：search_type (Optional[str]): 定义检索器应执行的类型搜索。可以是“similarity” (默认)，“mmr”，或“similarity_score_threshold”。

search_kwargs (Optional[Dict]): 传递给搜索函数的关键字参数。可以包含以下内容

，例如
k: 返回的文档数量 (默认：4)

score_threshold: 相似度得分阈值

for similarity_score_threshold

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

(默认：20)

lambda_mult: MMR返回的搜索结果多样性

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

filter: 通过文档元数据进行过滤

返回

VectorStore的检索器类。

返回类型

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 （整数） –

  • filter (可选[MetadataFilter]) –

  • kwargs (Any) –

返回类型

List[Document]

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

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

参数

  • embedding (浮点数列表) – 要查找的与文档相似的嵌入向量。

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

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

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

  • consistency (Optional[models.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 () – 返回的文档数量。默认为4。

  • **kwargs (Any) –

    传递给相似度搜索的参数 kwargs。应包括：score_threshold：可选，0 到 1 之间的浮点数值，以

    过滤检索到的文档集

返回

包含 (doc, 相似度得分) 的元组列表

返回类型

列表[Tuple[Document, float]]

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

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

参数

  • query (str) – 要查找文档相似性的文本。

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

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

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

  • consistency (Optional[models.ReadConsistency]) –

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

    已查询的副本

    • ‘majority’ - 查询所有副本，但仅返回存在于大多数副本中的值

      的值

    • ‘quorum’ - 查询大多数副本，并返回在这些副本中都存在的值

      所有副本中都存在的值

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

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

返回

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

返回类型

列表[Tuple[Document, float]]

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

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

参数

  • embedding (浮点数列表) – 要查找的与文档相似的嵌入向量。

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

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

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

  • consistency (Optional[models.ReadConsistency]) –

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

    已查询的副本

    • ‘majority’ - 查询所有副本，但仅返回存在于大多数副本中的值

      的值

    • ‘quorum’ - 查询大多数副本，并返回在这些副本中都存在的值

      所有副本中都存在的值

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

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

返回

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

返回类型

列表[Tuple[Document, float]]

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

测试版

在0.2.11版本中添加。API可能会更改。

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

参数

  • items (AsyncIterable[Document]) - 要添加到向量存储的文档序列。

  • batch_size (int) - 要更新的每个批次的尺寸。

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

产出

UpsertResponse - 一个响应对象，其中包含成功添加或更新的ID列表以及无法添加或更新的ID列表。

返回类型

AsyncIterator[UpsertResponse]

始于版本 0.2.11。

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

测试版

在0.2.11版本中添加。API可能会更改。

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

如果Document对象提供了ID字段，则upsert功能应使用该ID字段。如果没有提供ID，upsert方法有权为文档生成一个ID。

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

参数

  • items (Sequence[Document]) – 添加到向量存储的文档序列。

  • kwargs (任意) – 额外的关键字参数。

返回

包含成功添加或更新的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[int] = 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[HnswConfigDiff] = None, optimizers_config: Optional[OptimizersConfigDiff] = None, wal_config: Optional[WalConfigDiff] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, init_from: Optional[InitFrom] = None, on_disk: Optional[bool] = None, force_recreate: bool = False, **kwargs: Any) → Qdrant[source]
参数

  • texts (列表[str]> ) –

  • embedding (Embeddings) –

  • location (Optional[

  • url (Optional[

  • port (Optional[

  • grpc_port (int) –

  • prefer_grpc (bool) –

  • https (Optional[

  • api_key (Optional[

  • prefix (Optional[

  • timeout (Optional[

  • host (Optional[

  • path (Optional[

  • collection_name (Optional[

  • distance_func (str) –

  • content_payload_key (字符串) –

  • metadata_payload_key (字符串) –

  • vector_name (可选[字符串]) –

  • shard_number (Optional[

  • replication_factor (Optional[

  • write_consistency_factor (Optional[

  • on_disk_payload (Optional[

  • hnsw_config (Optional[

  • optimizers_config (Optional[

  • wal_config (Optional[

  • quantization_config (可选[联合[ScalarQuantization, ProductQuantization, BinaryQuantization]]) –

  • init_from (可选[InitFrom]) –

  • on_disk (可选[布尔]) –

  • force_recreate (布尔) –

  • kwargs (Any) –

返回类型

Qdrant

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

根据向量ID或其他标准删除。

参数

  • ids (可选[str列表]) – 要删除的id列表。

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

返回

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

返回类型

可选[bool]

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

从文档和嵌入初始化VectorStore。

参数

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

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

  • kwargs (任意) – 额外的关键字参数。

返回

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

返回类型

VectorStore

classmethod from_existing_collection(embedding: Embeddings, path: Optional[str] = None, collection_name: Optional[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[int] = None, host: Optional[str] = None, content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', distance_strategy: str = 'COSINE', vector_name: Optional[str] = None, **kwargs: Any) → Qdrant[source]

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

参数

  • embedding (Embeddings) –

  • path (Optional[

  • collection_name (Optional[

  • location (Optional[

  • url (Optional[

  • port (Optional[

  • grpc_port (int) –

  • prefer_grpc (bool) –

  • https (Optional[

  • api_key (Optional[

  • prefix (Optional[

  • timeout (Optional[

  • host (Optional[

  • content_payload_key (字符串) –

  • metadata_payload_key (字符串) –

  • distance_strategy (字符串) –

  • vector_name (可选[字符串]) –

  • 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[int] = 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[HnswConfigDiff] = None, optimizers_config: Optional[OptimizersConfigDiff] = None, wal_config: Optional[WalConfigDiff] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, init_from: Optional[InitFrom] = None, on_disk: Optional[bool] = None, force_recreate: bool = False, **kwargs: Any) → Qdrant[source]

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

参数

  • texts (字符串列表) – 要在Qdrant中索引的文本列表。

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

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

  • ids (Optional[

  • location (可选[字符串]) – 如果为‘:memory:’，则使用内存中的Qdrant实例。如果为字符串，则将其作为URL参数使用。如果为None，则回退到依赖于host和port参数。

  • url (可选[字符串]) – 要么是主机，要么是“Optional[scheme], host, Optional[port], Optional[prefix]”的字符串。默认：None

  • 端口号 (可选[int]) – REST API 接口的端口号。默认：6333

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

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

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

  • api_key (可选[str]) – Qdrant 云中的认证 API 密钥。默认：None。也可以通过环境变量 QDRANT_API_KEY 设置。

  • prefix (Optional[

    如果非 None - 添加前缀到 REST URL 路径。示例：service/v1 将会变为

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

    默认：None

  • timeout (可选[int]) – REST 和 gRPC API 请求的超时时间。默认：REST 为 5.0 秒，gRPC 无限制。

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

  • path (可选[str]) – 在使用本地模式时存储矢量的路径。默认：None

  • collection_name (可选[str]) – 要使用的 Qdrant 集合的名称。如果不提供，则会随机创建。默认：None

  • distance_func (str) – 距离函数。其中一个： “余弦” / “欧几里得” / “点积”。默认： “余弦”

  • content_payload_key (str) – 用于存储文档内容的一个负载密钥。默认： “page_content”

  • metadata_payload_key (str) – 用于存储文档元数据的一个负载密钥。默认： “metadata”

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

  • batch_size (int) – 每个请求上传多少个向量。默认：64

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

  • replication_factor (可选[int]) – 集合的复制因子。默认为 1，最小值为 1。定义了每个分片将被创建多少份副本。仅在分布式模式中生效。

  • write_consistency_factor (可选[int]) – 集合的写一致性因子。默认为 1，最小值为 1。定义了应该有多少个副本应用操作才能使我们认为它是成功的。增加这个数字会使集合对不一致性更加具有弹性，但如果没有足够的副本，它也会失败。不会对性能产生影响。仅在分布式模式中生效。

  • on_disk_payload (可选[bool]) – 如果为 true - 点的负载不会存储在内存中。每次请求时都会从磁盘读取。这个设置通过（略微）增加响应时间来节省内存。注意：那些涉及过滤和索引的负载值仍然保留在 RAM 中。

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

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

  • wal_config (可选[WalConfigDiff]) – 写前记录的参数

  • quantization_config (可选[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]]) – 量化的参数，如果为 None - 量化将被禁用

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

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

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

  • on_disk (可选[布尔]) –

返回类型

Qdrant

这是一个用户友好的界面，具有以下功能：1. 为每个文本创建嵌入 2. 默认初始化Qdrant数据库作为内存中的文档存储器

（可以覆盖为远程文档存储）

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

这是一个快速开始的便捷方式。

示例

from langchain_qdrant import Qdrant
from langchain_openai 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 () – 返回的文档数量。默认为4。

  • fetch_k () – 获取用于传递给MMR算法的文档数。默认为20。

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

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

  • consistency (Optional[models.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[models.SearchParams] = None, score_threshold: Optional[float] = None, consistency: Optional[models.ReadConsistency] = None, **kwargs: Any) → List[Document][source]

使用最大边缘相关性选择文档。

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

参数

  • embedding (列表[浮点数]) – 要查找类似文档的嵌入。

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

  • fetch_k (整数) – 向MMR算法传递要获取的文档数量。

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

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

  • consistency (Optional[models.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[models.SearchParams] = None, score_threshold: Optional[float] = None, consistency: Optional[models.ReadConsistency] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

通过最大边际相关性返回选择的文档。最大边际相关性优化查询相似度以及所选文档之间的多样性。：参数 query：查找与文本相似的文档的文本。：参数 k：返回的文档数量。默认为4。：参数 fetch_k：传递给MMR算法的文档数量。

默认为20。

参数

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

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

  • consistency (Optional[models.ReadConsistency]) –

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

    已查询的副本

    • ‘majority’ - 查询所有副本，但仅返回存在于大多数副本中的值

      的值

    • ‘quorum’ - 查询大多数副本，并返回在这些副本中都存在的值

      所有副本中都存在的值

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

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

  • 嵌入 （浮点数列表） –

  • k （整数） –

  • fetch_k （整数） –

返回

最大边际相关性和每个选择的文档的距离列表。

返回类型

列表[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 () – 返回的文档数量。默认为4。

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

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

  • consistency (Optional[models.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[models.SearchParams] = None, offset: int = 0, score_threshold: Optional[float] = None, consistency: Optional[models.ReadConsistency] = None, **kwargs: Any) → List[Document][source]

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

参数

  • embedding (浮点数列表) – 要查找的与文档相似的嵌入向量。

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

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

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

  • consistency (Optional[models.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 () – 返回的文档数量。默认为4。

  • **kwargs (Any) –

    传递给相似度搜索的参数 kwargs。应包括：score_threshold：可选，0 到 1 之间的浮点数值，以

    筛选检索到的文档集合。

返回

文档和相似度分数的元组列表。

返回类型

列表[Tuple[Document, float]]

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

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

参数

  • query (str) – 要查找文档相似性的文本。

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

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

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

  • consistency (Optional[models.ReadConsistency]) –

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

    已查询的副本

    • ‘majority’ - 查询所有副本，但仅返回存在于大多数副本中的值

      的值

    • ‘quorum’ - 查询大多数副本，并返回在这些副本中都存在的值

      所有副本中都存在的值

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

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

返回

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

返回类型

列表[Tuple[Document, float]]

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

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

参数

  • embedding (浮点数列表) – 要查找的与文档相似的嵌入向量。

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

  • filter (Optional[MetadataFilter]) – 通过元数据过滤。默认为None。

  • search_params (Optional[models.SearchParams]) – 额外的搜索参数

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

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

  • consistency (Optional[models.ReadConsistency]) –

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

    已查询的副本

    • ‘majority’ - 查询所有副本，但仅返回存在于大多数副本中的值

      的值

    • ‘quorum’ - 查询大多数副本，并返回在这些副本中都存在的值

      所有副本中都存在的值

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

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

返回

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

返回类型

列表[Tuple[Document, float]]

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

测试版

在0.2.11版本中添加。API可能会更改。

以流式方式UPSERT文档。

参数

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

  • batch_size (int) - 要更新的每个批次的尺寸。

  • kwargs (任意的) – 添加的额外关键字参数。kwargs 应仅包含所有文档都共有的参数（例如，索引的超时时间，重试策略等）。kwargs 应该不包含 ID 以避免模糊的意义。相反，ID 应作为文档对象的一部分提供。

产出

UpsertResponse - 一个响应对象，其中包含成功添加或更新的ID列表以及无法添加或更新的ID列表。

返回类型

迭代器[UpsertResponse]

始于版本 0.2.11。

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

测试版

在0.2.11版本中添加。API可能会更改。

向向量库中添加或更新文档。

如果Document对象提供了ID字段，则upsert功能应使用该ID字段。如果没有提供ID，upsert方法有权为文档生成一个ID。

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

参数

  • items (Sequence[Document]) – 添加到向量存储的文档序列。

  • kwargs (任意) – 额外的关键字参数。

返回

包含成功添加或更新的ID列表以及未能添加或更新的ID列表的响应对象。

返回类型

UpsertResponse

始于版本 0.2.11。

使用 Qdrant 的示例