`langchain_qdrant.qdrant`.QdrantVectorStore¶

class langchain_qdrant.qdrant.QdrantVectorStore(client: QdrantClient, collection_name: str, embedding: Optional[Embeddings] = None, retrieval_mode: RetrievalMode = RetrievalMode.DENSE, vector_name: str = '', content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', distance: Distance = Distance.COSINE, sparse_embedding: Optional[SparseEmbeddings] = None, sparse_vector_name: str = 'langchain-sparse', validate_embeddings: bool = True, validate_collection_config: bool = True)[source]¶

QdrantVectorStore - 使用 https://qdrant.tech/ 的向量存储实现

示例

from langchain_qdrant import QdrantVectorStore

store = QdrantVectorStore.from_existing_collection(“my-collection”, embedding, url=”http://localhost:6333”)

初始化 QdrantVectorStore 的新实例。

示例: .. code-block:: python qdrant = Qdrant(

client=client, collection_name=”my-collection”, embedding=OpenAIEmbeddings(), retrieval_mode=RetrievalMode.HYBRID, sparse_embedding=FastEmbedSparse(),

)

属性

`CONTENT_KEY`
`METADATA_KEY`
`SPARSE_VECTOR_NAME`
`VECTOR_NAME`
`client`	获取正在使用的 Qdrant 客户端实例。
`embeddings`	获取正在使用的密集嵌入实例。
`sparse_embeddings`	获取正在使用的稀疏嵌入实例。

方法

`__init__`(client, collection_name[, ...])	初始化 QdrantVectorStore 的新实例。
`aadd_documents`(documents, **kwargs)	异步地通过嵌入运行更多文档并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	异步地通过嵌入运行更多文本并添加到向量存储中。
`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])	异步返回从文本和嵌入初始化的 VectorStore。
`aget_by_ids`(ids, /)	通过 ID 异步获取文档。
`amax_marginal_relevance_search`(query[, k, ...])	异步返回使用最大边际相关性选择的文档。
`amax_marginal_relevance_search_by_vector`(...)	异步返回使用最大边际相关性选择的文档。
`as_retriever`(**kwargs)	返回从该 VectorStore 初始化的 VectorStoreRetriever。
`asearch`(query, search_type, **kwargs)	异步返回使用指定的搜索类型与查询最相似的文档。
`asimilarity_search`(query[, k])	异步返回与查询最相似的文档。
`asimilarity_search_by_vector`(embedding[, k])	异步返回与嵌入向量最相似的文档。
`asimilarity_search_with_relevance_scores`(query)	异步返回文档和相关性评分，范围为 [0, 1]。
`asimilarity_search_with_score`(args, *kwargs)	异步运行带距离的相似性搜索。
`astreaming_upsert`(items, /, batch_size, **kwargs)
`aupsert`(items, /, **kwargs)
`construct_instance`([embedding, ...])
`delete`([ids])	通过 ID 删除文档。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的 VectorStore。
`from_existing_collection`(collection_name[, ...])	从现有集合构造 QdrantVectorStore 的实例，无需添加任何数据。
`from_texts`(texts[, embedding, metadatas, ...])	从文本列表构造 QdrantVectorStore 的实例。
`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`(...)	返回使用最大边际相关性选择的文档。
`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, ...])	返回与查询最相似的文档。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

参数

client (QdrantClient) –
collection_name (str) –
embedding (Optional[Embeddings]) –
retrieval_mode (RetrievalMode) –
vector_name (str) –
content_payload_key (str) –
metadata_payload_key (str) –
distance (models.Distance) –
sparse_embedding (Optional[SparseEmbeddings]) –
sparse_vector_name (str) –
validate_embeddings (bool) –
validate_collection_config (bool) –

__init__(client: QdrantClient, collection_name: str, embedding: Optional[Embeddings] = None, retrieval_mode: RetrievalMode = RetrievalMode.DENSE, vector_name: str = '', content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', distance: Distance = Distance.COSINE, sparse_embedding: Optional[SparseEmbeddings] = None, sparse_vector_name: str = 'langchain-sparse', validate_embeddings: bool = True, validate_collection_config: bool = True)[source]¶

初始化 QdrantVectorStore 的新实例。

示例: .. code-block:: python qdrant = Qdrant(

client=client, collection_name=”my-collection”, embedding=OpenAIEmbeddings(), retrieval_mode=RetrievalMode.HYBRID, sparse_embedding=FastEmbedSparse(),

)

参数

client (QdrantClient) –
collection_name (str) –
embedding (Optional[Embeddings]) –
retrieval_mode (RetrievalMode) –
vector_name (str) –
content_payload_key (str) –
metadata_payload_key (str) –
distance (Distance) –
sparse_embedding (Optional[SparseEmbeddings]) –
sparse_vector_name (str) –
validate_embeddings (bool) –
validate_collection_config (bool) –

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, **kwargs: Any) → List[(str)]¶

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

参数

texts (Iterable[str]) – 要添加到向量存储的字符串的可迭代对象。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
**kwargs (Any) – 向量存储特定的参数。

返回

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

引发

ValueError – 如果元数据数量与文本数量不匹配。
ValueError – 如果 ID 数量与文本数量不匹配。

返回类型

List[str]

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

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

参数

documents (List[Document]) – 要添加到向量存储的文档。
kwargs (Any) – 附加关键字参数。如果 kwargs 包含 ids 且 documents 包含 ids，则 kwargs 中的 ids 将优先。

返回

添加文本的 ID 列表。

引发

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

返回类型

List[str]

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

将带有嵌入的文本添加到向量存储中。

返回

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

参数

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
ids (Optional[Sequence[str | int]]) –
batch_size (int) –
kwargs (Any) –

返回类型

List[str | int]

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

通过向量 ID 或其他条件异步删除。

参数

ids (Optional[List[str]]) – 要删除的id列表。如果为None，则删除所有。默认为None。
**kwargs (Any) – 子类可能使用的其他关键字参数。

返回

如果删除成功，则为True，否则为False；如果未实现，则为None。

返回类型

Optional[bool]

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

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

参数

documents (List[Document]) – 要添加到向量存储的Document列表。
embedding (Embeddings) – 要使用的嵌入函数。
kwargs (Any) – 附加关键字参数。

返回

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

返回类型

VectorStore

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → VST¶

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

参数

texts (List[str]) – 要添加到向量存储的文本列表。
embedding (Embeddings) – 要使用的嵌入函数。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
kwargs (Any) – 附加关键字参数。

返回

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

返回类型

VectorStore

async aget_by_ids(ids: Sequence[str], /) → List[Document]¶

通过 ID 异步获取文档。

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

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

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

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

参数: ids (Sequence[str]) – 要检索的id列表。
返回: Document列表。
返回类型: List[Document]

0.2.11版本新增。

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的Document数量。默认为4。
fetch_k (int) – 要获取并传递给MMR算法的Document数量。默认为20。
lambda_mult (float) – 介于0和1之间的数字，用于确定结果之间多样性的程度，其中0对应于最大多样性，1对应于最小多样性。默认为0.5。
kwargs (Any) –

返回

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

返回类型

List[Document]

async amax_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的Document数量。默认为4。
fetch_k (int) – 要获取并传递给MMR算法的Document数量。默认为20。
lambda_mult (float) – 介于0和1之间的数字，用于确定结果之间多样性的程度，其中0对应于最大多样性，1对应于最小多样性。默认为0.5。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

返回类型

List[Document]

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) – 传递给搜索方法的参数。

返回

与查询最相似的Document列表。

引发

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

返回类型

List[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → List[Document]¶

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

参数

query (str) – 输入文本。
k (int) – 要返回的Document数量。默认为4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

与查询最相似的Document列表。

返回类型

List[Document]

async asimilarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document]¶

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的Document数量。默认为4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

与查询向量最相似的Document列表。

返回类型

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) – 要返回的Document数量。默认为4。
**kwargs (Any) –
要传递给相似度搜索的kwargs。应包括：score_threshold: 可选，0到1之间的浮点值，用于

过滤检索文档的结果集

返回

(doc, similarity_score) 元组的列表

返回类型

List[Tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]¶

异步运行带距离的相似性搜索。

参数

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

返回

(doc, similarity_score) 元组的列表。

返回类型

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]) – 要添加到向量存储的 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 的异步版本。

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

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

参数

items (Sequence[Document]) – 要添加到向量存储的 Document 序列。
kwargs (Any) – 附加关键字参数。

返回

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

返回类型

UpsertResponse

0.2.11版本新增。

classmethod construct_instance(embedding: Optional[Embeddings] = None, retrieval_mode: RetrievalMode = RetrievalMode.DENSE, sparse_embedding: Optional[SparseEmbeddings] = None, client_options: Dict[str, Any] = {}, collection_name: Optional[str] = None, distance: Distance = Distance.COSINE, content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', vector_name: str = '', sparse_vector_name: str = 'langchain-sparse', force_recreate: bool = False, collection_create_options: Dict[str, Any] = {}, vector_params: Dict[str, Any] = {}, sparse_vector_params: Dict[str, Any] = {}, validate_embeddings: bool = True, validate_collection_config: bool = True) → QdrantVectorStore[source]¶

参数

embedding (Optional[Embeddings]) –
retrieval_mode (RetrievalMode) –
sparse_embedding (Optional[SparseEmbeddings]) –
client_options (Dict[str, Any]) –
collection_name (Optional[str]) –
distance (Distance) –
content_payload_key (str) –
metadata_payload_key (str) –
vector_name (str) –
sparse_vector_name (str) –
force_recreate (bool) –
collection_create_options (Dict[str, Any]) –
vector_params (Dict[str, Any]) –
sparse_vector_params (Dict[str, Any]) –
validate_embeddings (bool) –
validate_collection_config (bool) –

返回类型

QdrantVectorStore

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

通过 ID 删除文档。

参数

ids (Optional[List[str | int]]) – 要删除的id列表。
**kwargs (Any) – 子类可能使用的其他关键字参数。

返回

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

返回类型

Optional[bool]

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

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

参数

documents (List[Document]) – 要添加到向量存储的Document列表。
embedding (Embeddings) – 要使用的嵌入函数。
kwargs (Any) – 附加关键字参数。

返回

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

返回类型

VectorStore

classmethod from_existing_collection(collection_name: str, embedding: Optional[Embeddings] = None, retrieval_mode: RetrievalMode = RetrievalMode.DENSE, 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, distance: Distance = Distance.COSINE, content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', vector_name: str = '', sparse_vector_name: str = 'langchain-sparse', sparse_embedding: Optional[SparseEmbeddings] = None, validate_embeddings: bool = True, validate_collection_config: bool = True, **kwargs: Any) → QdrantVectorStore[source]¶

从现有集合构造 QdrantVectorStore 的实例，无需添加任何数据。

返回

QdrantVectorStore的新实例。

返回类型

QdrantVectorStore

参数

collection_name (str) –
embedding (Optional[Embeddings]) –
retrieval_mode (RetrievalMode) –
location (Optional[str]) –
url (Optional[str]) –
port (Optional[int]) –
grpc_port (int) –
prefer_grpc (bool) –
https (Optional[bool]) –
api_key (Optional[str]) –
prefix (Optional[str]) –
timeout (Optional[int]) –
host (Optional[str]) –
path (Optional[str]) –
distance (Distance) –
content_payload_key (str) –
metadata_payload_key (str) –
vector_name (str) –
sparse_vector_name (str) –
sparse_embedding (Optional[SparseEmbeddings]) –
validate_embeddings (bool) –
validate_collection_config (bool) –
kwargs (Any) –

classmethod from_texts(texts: List[str], embedding: Optional[Embeddings] = None, metadatas: Optional[List[dict]] = None, ids: Optional[Sequence[str | int]] = 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, path: Optional[str] = None, distance: Distance = Distance.COSINE, content_payload_key: str = 'page_content', metadata_payload_key: str = 'metadata', vector_name: str = '', retrieval_mode: RetrievalMode = RetrievalMode.DENSE, sparse_embedding: Optional[SparseEmbeddings] = None, sparse_vector_name: str = 'langchain-sparse', collection_create_options: Dict[str, Any] = {}, vector_params: Dict[str, Any] = {}, sparse_vector_params: Dict[str, Any] = {}, batch_size: int = 64, force_recreate: bool = False, validate_embeddings: bool = True, validate_collection_config: bool = True, **kwargs: Any) → QdrantVectorStore[source]¶

从文本列表构造 QdrantVectorStore 的实例。

这是一个用户友好的接口，它： 1. 为每个文本创建嵌入；2. 如果 Qdrant 集合不存在，则创建它；3. 将文本嵌入添加到 Qdrant 数据库

旨在提供一种快速入门的方法。

示例

from langchain_qdrant import Qdrant from langchain_openai import OpenAIEmbeddings embeddings = OpenAIEmbeddings() qdrant = Qdrant.from_texts(texts, embeddings, url=”http://localhost:6333”)

参数

texts (List[str]) –
embedding (Optional[Embeddings]) –
metadatas (Optional[List[dict]]) –
ids (Optional[Sequence[str | int]]) –
collection_name (Optional[str]) –
location (Optional[str]) –
url (Optional[str]) –
port (Optional[int]) –
grpc_port (int) –
prefer_grpc (bool) –
https (Optional[bool]) –
api_key (Optional[str]) –
prefix (Optional[str]) –
timeout (Optional[int]) –
host (Optional[str]) –
path (Optional[str]) –
distance (Distance) –
content_payload_key (str) –
metadata_payload_key (str) –
vector_name (str) –
retrieval_mode (RetrievalMode) –
sparse_embedding (Optional[SparseEmbeddings]) –
sparse_vector_name (str) –
collection_create_options (Dict[str, Any]) –
vector_params (Dict[str, Any]) –
sparse_vector_params (Dict[str, Any]) –
batch_size (int) –
force_recreate (bool) –
validate_embeddings (bool) –
validate_collection_config (bool) –
kwargs (Any) –

返回类型

QdrantVectorStore

get_by_ids(ids: Sequence[str | int], /) → List[Document][source]¶

通过 ID 获取文档。

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

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

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

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

参数: ids (Sequence[str | int]) – 要检索的 ID 列表。
返回: Document列表。
返回类型: List[Document]

0.2.11版本新增。

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[Filter] = None, search_params: Optional[SearchParams] = None, score_threshold: Optional[float] = None, consistency: Optional[Union[StrictInt, ReadConsistencyType]] = None, **kwargs: Any) → List[Document][source]¶

返回使用带有密集向量的最大边际相关性选择的文档。

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

返回

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

参数

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[Filter]) –
search_params (Optional[SearchParams]) –
score_threshold (Optional[float]) –
consistency (Optional[Union[StrictInt, ReadConsistencyType]]) –
kwargs (Any) –

返回类型

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[Filter] = None, search_params: Optional[SearchParams] = None, score_threshold: Optional[float] = None, consistency: Optional[Union[StrictInt, ReadConsistencyType]] = None, **kwargs: Any) → List[Document][source]¶

返回使用带有密集向量的最大边际相关性选择的文档。

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

返回

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

参数

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[Filter]) –
search_params (Optional[SearchParams]) –
score_threshold (Optional[float]) –
consistency (Optional[Union[StrictInt, ReadConsistencyType]]) –
kwargs (Any) –

返回类型

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[Filter] = None, search_params: Optional[SearchParams] = None, score_threshold: Optional[float] = None, consistency: Optional[Union[StrictInt, ReadConsistencyType]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

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

返回

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

参数

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[Filter]) –
search_params (Optional[SearchParams]) –
score_threshold (Optional[float]) –
consistency (Optional[Union[StrictInt, ReadConsistencyType]]) –
kwargs (Any) –

返回类型

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) – 传递给搜索方法的参数。

返回

与查询最相似的Document列表。

引发

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

返回类型

List[Document]

similarity_search(query: str, k: int = 4, filter: Optional[Filter] = None, search_params: Optional[SearchParams] = None, offset: int = 0, score_threshold: Optional[float] = None, consistency: Optional[Union[StrictInt, ReadConsistencyType]] = None, hybrid_fusion: Optional[FusionQuery] = None, **kwargs: Any) → List[Document][source]¶

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

返回

与查询最相似的Document列表。

参数

query (str) –
k (int) –
filter (Optional[Filter]) –
search_params (Optional[SearchParams]) –
offset (int) –
score_threshold (Optional[float]) –
consistency (Optional[Union[StrictInt, ReadConsistencyType]]) –
hybrid_fusion (Optional[FusionQuery]) –
kwargs (Any) –

返回类型

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[Filter] = None, search_params: Optional[SearchParams] = None, offset: int = 0, score_threshold: Optional[float] = None, consistency: Optional[Union[StrictInt, ReadConsistencyType]] = None, **kwargs: Any) → List[Document][source]¶

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

返回

与查询最相似的Document列表。

参数

embedding (List[float]) –
k (int) –
filter (Optional[Filter]) –
search_params (Optional[SearchParams]) –
offset (int) –
score_threshold (Optional[float]) –
consistency (Optional[Union[StrictInt, ReadConsistencyType]]) –
kwargs (Any) –

返回类型

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) – 要返回的Document数量。默认为4。
**kwargs (Any) –
要传递给相似度搜索的kwargs。应包括：score_threshold: 可选，0到1之间的浮点值，用于

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

返回

(doc, similarity_score) 元组的列表。

返回类型

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, filter: Optional[Filter] = None, search_params: Optional[SearchParams] = None, offset: int = 0, score_threshold: Optional[float] = None, consistency: Optional[Union[StrictInt, ReadConsistencyType]] = None, hybrid_fusion: Optional[FusionQuery] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

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

返回

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

参数

query (str) –
k (int) –
filter (Optional[Filter]) –
search_params (Optional[SearchParams]) –
offset (int) –
score_threshold (Optional[float]) –
consistency (Optional[Union[StrictInt, ReadConsistencyType]]) –
hybrid_fusion (Optional[FusionQuery]) –
kwargs (Any) –

返回类型

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不应包含ids以避免语义模糊。相反，ID应作为Document对象的一部分提供。

Yields

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

返回类型

Iterator[UpsertResponse]

0.2.11版本新增。

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

Beta

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

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

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

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

参数

items (Sequence[Document]) – 要添加到向量存储的 Document 序列。
kwargs (Any) – 附加关键字参数。

返回

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

返回类型

UpsertResponse

0.2.11版本新增。

langchain_qdrant.qdrant.QdrantVectorStore¶

`langchain_qdrant.qdrant`.QdrantVectorStore¶