QdrantVectorStore#

class langchain_qdrant.qdrant.QdrantVectorStore(client: QdrantClient, collection_name: str, embedding: Embeddings | None = 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: SparseEmbeddings | None = None, sparse_vector_name: str = 'langchain-sparse', validate_embeddings: bool = True, validate_collection_config: bool = True)[来源]#

Qdrant 向量存储集成。

Setup:

安装 langchain-qdrant 包。

pip install -qU langchain-qdrant

Key init args — indexing params:

collection_name: str: 集合的名称。
embedding: Embeddings: 使用的嵌入函数。
sparse_embedding: SparseEmbeddings: 可选的稀疏嵌入函数。

Key init args — client params:

client: QdrantClient: 使用的Qdrant客户端。
retrieval_mode: RetrievalMode: 使用的检索模式。

Instantiate:

from langchain_qdrant import QdrantVectorStore
from qdrant_client import QdrantClient
from qdrant_client.http.models import Distance, VectorParams
from langchain_openai import OpenAIEmbeddings

client = QdrantClient(":memory:")

client.create_collection(
    collection_name="demo_collection",
    vectors_config=VectorParams(size=1536, distance=Distance.COSINE),
)

vector_store = QdrantVectorStore(
    client=client,
    collection_name="demo_collection",
    embedding=OpenAIEmbeddings(),
)

Add Documents:

from langchain_core.documents import Document
from uuid import uuid4

document_1 = Document(page_content="foo", metadata={"baz": "bar"})
document_2 = Document(page_content="thud", metadata={"bar": "baz"})
document_3 = Document(page_content="i will be deleted :(")

documents = [document_1, document_2, document_3]
ids = [str(uuid4()) for _ in range(len(documents))]
vector_store.add_documents(documents=documents, ids=ids)

Delete Documents:

vector_store.delete(ids=[ids[-1]])

Search:

results = vector_store.similarity_search(query="thud",k=1)
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

* thud [{'bar': 'baz', '_id': '0d706099-6dd9-412a-9df6-a71043e020de', '_collection_name': 'demo_collection'}]

Search with filter:

from qdrant_client.http import models

results = vector_store.similarity_search(query="thud",k=1,filter=models.Filter(must=[models.FieldCondition(key="metadata.bar", match=models.MatchValue(value="baz"),)]))
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

* thud [{'bar': 'baz', '_id': '0d706099-6dd9-412a-9df6-a71043e020de', '_collection_name': 'demo_collection'}]

Search with score:

results = vector_store.similarity_search_with_score(query="qux",k=1)
for doc, score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

* [SIM=0.832268] foo [{'baz': 'bar', '_id': '44ec7094-b061-45ac-8fbf-014b0f18e8aa', '_collection_name': 'demo_collection'}]

Async:

# add documents
# await vector_store.aadd_documents(documents=documents, ids=ids)

# delete documents
# await vector_store.adelete(ids=["3"])

# search
# results = vector_store.asimilarity_search(query="thud",k=1)

# search with score
results = await vector_store.asimilarity_search_with_score(query="qux",k=1)
for doc,score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

* [SIM=0.832268] foo [{'baz': 'bar', '_id': '44ec7094-b061-45ac-8fbf-014b0f18e8aa', '_collection_name': 'demo_collection'}]

Use as Retriever:

retriever = vector_store.as_retriever(
    search_type="mmr",
    search_kwargs={"k": 1, "fetch_k": 2, "lambda_mult": 0.5},
)
retriever.invoke("thud")

[Document(metadata={'bar': 'baz', '_id': '0d706099-6dd9-412a-9df6-a71043e020de', '_collection_name': 'demo_collection'}, page_content='thud')]

初始化一个新的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, ids])	异步运行更多文本通过嵌入并添加到向量存储中。
`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, ids])	异步返回从文本和嵌入初始化的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)	异步运行带距离的相似性搜索。
`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, ...])	返回与查询最相似的文档。

Parameters:

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

__init__(client: QdrantClient, collection_name: str, embedding: Embeddings | None = 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: SparseEmbeddings | None = 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(),

)

Parameters:

client (QdrantClient)
collection_name (str)
embedding (Embeddings | None)
retrieval_mode (RetrievalMode)
vector_name (str)
content_payload_key (str)
metadata_payload_key (str)
distance (距离)
sparse_embedding (SparseEmbeddings | None)
sparse_vector_name (str)
validate_embeddings (布尔值)
validate_collection_config (bool)

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

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

Parameters:

documents (list[Document]) – 要添加到向量存储中的文档。
kwargs (Any) – 额外的关键字参数。

Returns:

已添加文本的ID列表。

Raises:

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

Return type:

列表[字符串]

async aadd_texts(texts: Iterable[str], metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) → list[str]#

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

Parameters:

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

Returns:

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

Raises:

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

Return type:

列表[字符串]

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

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

Parameters:

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

Returns:

已添加文本的ID列表。

Raises:

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

Return type:

列表[字符串]

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

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

Returns:

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

Parameters:

texts (可迭代对象[字符串])
metadatas (列表[字典] | 无)
ids (序列[字符串 | 整数] | 无)
batch_size (int)
kwargs (Any)

Return type:

列表[str | int]

async adelete(ids: list[str] | None = None, **kwargs: Any) → bool | None#

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

Parameters:

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

Returns:

如果删除成功则为真，否则为假，如果未实现则为无。

Return type:

可选[布尔]

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

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

Parameters:

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

Returns:

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

Return type:

VectorStore

async classmethod afrom_texts(texts: list[str], embedding: Embeddings, metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) → VST#

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

Parameters:

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

Returns:

VectorStore 从文本和嵌入初始化。

Return type:

VectorStore

async aget_by_ids(ids: Sequence[str], /) → list[Document]#

通过ID异步获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

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

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

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

Parameters:: ids (Sequence[str]) – 要检索的ID列表。
Returns:: 文档列表。
Return type:: 列表[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]#

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

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

Parameters:

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

Returns:

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

Return type:

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

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

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

Parameters:

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

Returns:

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

Return type:

列表[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever#

返回从此VectorStore初始化的VectorStoreRetriever。

Parameters:

**kwargs (Any) –

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

检索器应执行的搜索类型。可以是“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: 按文档元数据过滤

Returns:

VectorStore的检索器类。

Return type:

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]#

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

Parameters:

query (str) – 输入文本。
search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

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

Raises:

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

Return type:

列表[Document]

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

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

Parameters:

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

Returns:

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

Return type:

列表[Document]

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

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

Parameters:

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

Returns:

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

Return type:

列表[Document]

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

异步返回文档和相关度分数，范围在[0, 1]之间。

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

Parameters:

query (str) – 输入文本。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) –
传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

过滤检索到的文档集

Returns:

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

Return type:

列表[元组[Document, 浮点数]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → list[tuple[Document, float]]#

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

Parameters:

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

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

classmethod construct_instance(embedding: Embeddings | None = None, retrieval_mode: RetrievalMode = RetrievalMode.DENSE, sparse_embedding: SparseEmbeddings | None = None, client_options: Dict[str, Any] = {}, collection_name: str | None = 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]#

Parameters:

embedding (Embeddings | None)
retrieval_mode (RetrievalMode)
sparse_embedding (SparseEmbeddings | None)
client_options (Dict[str, Any])
collection_name (str | None)
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 (布尔值)
validate_collection_config (bool)

Return type:

QdrantVectorStore

delete(ids: List[str | int] | None = None, **kwargs: Any) → bool | None[来源]#

通过ID删除文档。

Parameters:

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

Returns:

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

Return type:

布尔值 | 无

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

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

Parameters:

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

Returns:

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

Return type:

VectorStore

classmethod from_existing_collection(collection_name: str, embedding: Embeddings | None = None, retrieval_mode: RetrievalMode = RetrievalMode.DENSE, location: str | None = None, url: str | None = None, port: int | None = 6333, grpc_port: int = 6334, prefer_grpc: bool = False, https: bool | None = None, api_key: str | None = None, prefix: str | None = None, timeout: int | None = None, host: str | None = None, path: str | None = 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: SparseEmbeddings | None = None, validate_embeddings: bool = True, validate_collection_config: bool = True, **kwargs: Any) → QdrantVectorStore[来源]#

从现有集合中构造一个QdrantVectorStore的实例，而不添加任何数据。

Returns:

QdrantVectorStore 的新实例。

Return type:

QdrantVectorStore

Parameters:

collection_name (str)
embedding (Embeddings | None)
retrieval_mode (RetrievalMode)
位置 (字符串 | 无)
url (str | None)
port (int | None)
grpc_port (int)
prefer_grpc (bool)
https (bool | None)
api_key (str | None)
prefix (str | None)
timeout (int | None)
host (str | None)
path (str | None)
distance (距离)
content_payload_key (str)
metadata_payload_key (str)
vector_name (str)
sparse_vector_name (str)
sparse_embedding (SparseEmbeddings | None)
validate_embeddings (布尔值)
validate_collection_config (bool)
kwargs (Any)

classmethod from_texts(texts: List[str], embedding: Embeddings | None = None, metadatas: List[dict] | None = None, ids: Sequence[str | int] | None = None, collection_name: str | None = None, location: str | None = None, url: str | None = None, port: int | None = 6333, grpc_port: int = 6334, prefer_grpc: bool = False, https: bool | None = None, api_key: str | None = None, prefix: str | None = None, timeout: int | None = None, host: str | None = None, path: str | None = 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: SparseEmbeddings | None = 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数据库中

这是快速入门的一种方式。

示例

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

Parameters:

文本 (列表[字符串])
embedding (Embeddings | None)
metadatas (列表[字典] | 无)
ids (序列[字符串 | 整数] | 无)
collection_name (str | None)
位置 (字符串 | 无)
url (str | None)
port (int | None)
grpc_port (int)
prefer_grpc (bool)
https (bool | None)
api_key (str | None)
prefix (str | None)
timeout (int | None)
host (str | None)
path (str | None)
distance (距离)
content_payload_key (str)
metadata_payload_key (str)
vector_name (str)
retrieval_mode (RetrievalMode)
sparse_embedding (SparseEmbeddings | None)
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 (布尔值)
validate_collection_config (bool)
kwargs (Any)

Return type:

QdrantVectorStore

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

通过ID获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

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

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

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

Parameters:: ids (Sequence[str | int]) – 要检索的ID列表。
Returns:: 文档列表。
Return type:: 列表[文档]

在版本0.2.11中添加。

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Filter | None = None, search_params: SearchParams | None = None, score_threshold: float | None = None, consistency: Annotated[int, Strict(strict=True)] | ReadConsistencyType | None = None, **kwargs: Any) → List[Document][来源]#

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

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

Returns:

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

Parameters:

query (str)
k (整数)
fetch_k (int)
lambda_mult (float)
filter (过滤器 | 无)
search_params (SearchParams | None)
score_threshold (float | None)
一致性 (注释[整数, 严格(严格=True)] | 读取一致性类型 | 无)
kwargs (Any)

Return type:

列表[文档]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Filter | None = None, search_params: SearchParams | None = None, score_threshold: float | None = None, consistency: Annotated[int, Strict(strict=True)] | ReadConsistencyType | None = None, **kwargs: Any) → List[Document][来源]#

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

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

Returns:

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

Parameters:

embedding (列表[浮点数])
k (整数)
fetch_k (int)
lambda_mult (float)
filter (过滤器 | 无)
search_params (SearchParams | None)
score_threshold (float | None)
一致性 (注释[整数, 严格(严格=True)] | 读取一致性类型 | 无)
kwargs (Any)

Return type:

列表[文档]

max_marginal_relevance_search_with_score_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Filter | None = None, search_params: SearchParams | None = None, score_threshold: float | None = None, consistency: Annotated[int, Strict(strict=True)] | ReadConsistencyType | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

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

Returns:

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

Parameters:

embedding (列表[浮点数])
k (整数)
fetch_k (int)
lambda_mult (float)
filter (过滤器 | 无)
search_params (SearchParams | None)
score_threshold (float | None)
一致性 (注释[整数, 严格(严格=True)] | 读取一致性类型 | 无)
kwargs (Any)

Return type:

列表[元组[文档, 浮点数]]

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

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

Parameters:

query (str) – 输入文本
search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

Returns:

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

Raises:

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

Return type:

列表[Document]

similarity_search(query: str, k: int = 4, filter: Filter | None = None, search_params: SearchParams | None = None, offset: int = 0, score_threshold: float | None = None, consistency: Annotated[int, Strict(strict=True)] | ReadConsistencyType | None = None, hybrid_fusion: FusionQuery | None = None, **kwargs: Any) → List[Document][source]#

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

Returns:

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

Parameters:

query (str)
k (整数)
filter (过滤器 | 无)
search_params (SearchParams | None)
offset (int)
score_threshold (float | None)
一致性 (注释[整数, 严格(严格=True)] | 读取一致性类型 | 无)
hybrid_fusion (FusionQuery | None)
kwargs (Any)

Return type:

列表[文档]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Filter | None = None, search_params: SearchParams | None = None, offset: int = 0, score_threshold: float | None = None, consistency: Annotated[int, Strict(strict=True)] | ReadConsistencyType | None = None, **kwargs: Any) → List[Document][source]#

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

Returns:

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

Parameters:

embedding (列表[浮点数])
k (整数)
filter (过滤器 | 无)
search_params (SearchParams | None)
offset (int)
score_threshold (float | None)
一致性 (注释[整数, 严格(严格=True)] | 读取一致性类型 | 无)
kwargs (Any)

Return type:

列表[文档]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

返回文档和相关度分数，范围在[0, 1]之间。

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

Parameters:

query (str) – 输入文本。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) –
传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

用于过滤检索到的文档集。

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

similarity_search_with_score(query: str, k: int = 4, filter: Filter | None = None, search_params: SearchParams | None = None, offset: int = 0, score_threshold: float | None = None, consistency: Annotated[int, Strict(strict=True)] | ReadConsistencyType | None = None, hybrid_fusion: FusionQuery | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

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

Returns:

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

Parameters:

query (str)
k (整数)
filter (过滤器 | 无)
search_params (SearchParams | None)
offset (int)
score_threshold (float | None)
一致性 (注释[整数, 严格(严格=True)] | 读取一致性类型 | 无)
hybrid_fusion (FusionQuery | None)
kwargs (Any)

Return type:

列表[元组[文档, 浮点数]]