Qdrant

Qdrant (“象限” 的发音) 是一个向量相似性搜索引擎。它提供了一个生产就绪的服务，拥有便捷的 API，用于存储、搜索和管理带有附加 payload 和扩展过滤支持的向量。这使其适用于各种神经网络或基于语义的匹配、分面搜索和其他应用。

本文档演示了如何将 Qdrant 与 LangChain 结合用于稠密（即，基于嵌入）、稀疏（即，文本搜索）和混合检索。QdrantVectorStore 类通过 Qdrant 的新 Query API 支持多种检索模式。它要求您运行 Qdrant v1.10.0 或更高版本。

设置

有多种模式可以运行 Qdrant，具体取决于您选择的模式，会存在一些细微的差别。选项包括：

本地模式，无需服务器
Docker 部署
Qdrant Cloud

请在此处查看安装说明：https://qdrant.tech/documentation/install/

pip install -qU langchain-qdrant

凭证

运行此笔记本中的代码不需要任何凭证。

如果您想获得同类最佳的自动化模型调用跟踪，您还可以通过取消注释下面的内容来设置您的 LangSmith API 密钥：

# os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
# os.environ["LANGSMITH_TRACING"] = "true"

初始化

本地模式

Python 客户端提供了一种不在 Qdrant 服务器上运行代码而是本地运行代码的选项。这对于测试、调试或只存储少量向量非常有用。嵌入可以完全保留在内存中，也可以持久化到磁盘上。

内存中

对于一些测试场景和快速实验，你可能希望只将所有数据保留在内存中，这样当客户端被销毁时（通常在脚本/笔记本结束时）数据就会被清除。

Select embeddings model:

pip install -qU langchain-openai

import getpass
import os

if not os.environ.get("OPENAI_API_KEY"):
  os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter API key for OpenAI: ")

from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings(model="text-embedding-3-large")

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

client = QdrantClient(":memory:")

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

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

API Reference:QdrantVectorStore

磁盘存储

本地模式（不使用 Qdrant 服务器）也可以将您的向量存储在磁盘上，以便在运行之间持久化。

client = QdrantClient(path="/tmp/langchain_qdrant")

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

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

本地服务器部署

无论您是选择使用 Docker 容器在本地启动 Qdrant，还是通过官方 Helm Chart 选择 Kubernetes 部署，连接到此类实例的方式都将是相同的。您需要提供一个指向该服务的 URL。

url = "<---qdrant url here --->"
docs = []  # put docs here
qdrant = QdrantVectorStore.from_documents(
    docs,
    embeddings,
    url=url,
    prefer_grpc=True,
    collection_name="my_documents",
)

Qdrant Cloud

如果您不想费心管理基础设施，可以选择在 Qdrant Cloud 上设置一个全托管的 Qdrant 集群。其中包含一个永久免费的 1GB 集群供您试用。使用托管版 Qdrant 的主要区别在于，您需要提供一个 API 密钥来保护您的部署不被公开访问。该值也可以设置为 QDRANT_API_KEY 环境变量。

url = "<---qdrant cloud cluster url here --->"
api_key = "<---api key here--->"
qdrant = QdrantVectorStore.from_documents(
    docs,
    embeddings,
    url=url,
    prefer_grpc=True,
    api_key=api_key,
    collection_name="my_documents",
)

使用现有集合

This example shows how to use an existing collection with the

要获取 langchain_qdrant.Qdrant 的实例，而不加载任何新文档或文本，您可以使用 Qdrant.from_existing_collection() 方法。

qdrant = QdrantVectorStore.from_existing_collection(
    embedding=embeddings,
    collection_name="my_documents",
    url="http://localhost:6333",
)

管理向量存储

创建向量存储后，我们可以通过添加和删除不同的项目来与之进行交互。

向向量存储添加项目

我们可以使用 add_documents 函数向向量存储添加项目。

from uuid import uuid4

from langchain_core.documents import Document

document_1 = Document(
    page_content="I had chocolate chip pancakes and scrambled eggs for breakfast this morning.",
    metadata={"source": "tweet"},
)

document_2 = Document(
    page_content="The weather forecast for tomorrow is cloudy and overcast, with a high of 62 degrees Fahrenheit.",
    metadata={"source": "news"},
)

document_3 = Document(
    page_content="Building an exciting new project with LangChain - come check it out!",
    metadata={"source": "tweet"},
)

document_4 = Document(
    page_content="Robbers broke into the city bank and stole $1 million in cash.",
    metadata={"source": "news"},
)

document_5 = Document(
    page_content="Wow! That was an amazing movie. I can't wait to see it again.",
    metadata={"source": "tweet"},
)

document_6 = Document(
    page_content="Is the new iPhone worth the price? Read this review to find out.",
    metadata={"source": "website"},
)

document_7 = Document(
    page_content="The top 10 soccer players in the world right now.",
    metadata={"source": "website"},
)

document_8 = Document(
    page_content="LangGraph is the best framework for building stateful, agentic applications!",
    metadata={"source": "tweet"},
)

document_9 = Document(
    page_content="The stock market is down 500 points today due to fears of a recession.",
    metadata={"source": "news"},
)

document_10 = Document(
    page_content="I have a bad feeling I am going to get deleted :(",
    metadata={"source": "tweet"},
)

documents = [
    document_1,
    document_2,
    document_3,
    document_4,
    document_5,
    document_6,
    document_7,
    document_8,
    document_9,
    document_10,
]
uuids = [str(uuid4()) for _ in range(len(documents))]

API Reference:Document

vector_store.add_documents(documents=documents, ids=uuids)

从矢量存储中删除项目

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

True

查询向量存储

一旦您的向量存储创建完成并且相关的文档已添加，您很可能希望在链或代理运行时查询它。

直接查询

使用 Qdrant 向量存储最简单的场景是执行相似性搜索。在我们底层，查询将被编码成向量嵌入，并用于在 Qdrant 集合中查找相似的文档。

results = vector_store.similarity_search(
    "LangChain provides abstractions to make working with LLMs easy", k=2
)
for res in results:
    print(f"* {res.page_content} [{res.metadata}]")

* Building an exciting new project with LangChain - come check it out! [{'source': 'tweet', '_id': 'd3202666-6f2b-4186-ac43-e35389de8166', '_collection_name': 'demo_collection'}]
* LangGraph is the best framework for building stateful, agentic applications! [{'source': 'tweet', '_id': '91ed6c56-fe53-49e2-8199-c3bb3c33c3eb', '_collection_name': 'demo_collection'}]

QdrantVectorStore 支持 3 种相似性搜索模式。可以通过 retrieval_mode 参数进行配置。

密集向量搜索（默认）
稀疏向量搜索
混合搜索

密集向量搜索

密集向量搜索通过基于向量的嵌入来计算相似性。仅使用密集向量进行搜索：

retrieval_mode 参数应设置为 RetrievalMode.DENSE。这是默认行为。
应为 embedding 参数提供密集嵌入值。

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

# Create a Qdrant client for local storage
client = QdrantClient(path="/tmp/langchain_qdrant")

# Create a collection with dense vectors
client.create_collection(
    collection_name="my_documents",
    vectors_config=VectorParams(size=3072, distance=Distance.COSINE),
)

qdrant = QdrantVectorStore(
    client=client,
    collection_name="my_documents",
    embedding=embeddings,
    retrieval_mode=RetrievalMode.DENSE,
)

qdrant.add_documents(documents=documents, ids=uuids)

query = "How much money did the robbers steal?"
found_docs = qdrant.similarity_search(query)
found_docs

API Reference:QdrantVectorStore | RetrievalMode

稀疏向量搜索

仅使用稀疏向量进行搜索：

retrieval_mode 参数应设置为 RetrievalMode.SPARSE。
必须提供一个实现了 SparseEmbeddings 接口的、使用任何稀疏向量提供商的实现，作为 sparse_embedding 参数的值。

langchain-qdrant 包提供了基于 FastEmbed 的开箱即用型实现。

要使用它，请安装 FastEmbed 包。

%pip install -qU fastembed

from langchain_qdrant import FastEmbedSparse, QdrantVectorStore, RetrievalMode
from qdrant_client import QdrantClient, models
from qdrant_client.http.models import Distance, SparseVectorParams, VectorParams

sparse_embeddings = FastEmbedSparse(model_name="Qdrant/bm25")

# Create a Qdrant client for local storage
client = QdrantClient(path="/tmp/langchain_qdrant")

# Create a collection with sparse vectors
client.create_collection(
    collection_name="my_documents",
    vectors_config={"dense": VectorParams(size=3072, distance=Distance.COSINE)},
    sparse_vectors_config={
        "sparse": SparseVectorParams(index=models.SparseIndexParams(on_disk=False))
    },
)

qdrant = QdrantVectorStore(
    client=client,
    collection_name="my_documents",
    sparse_embedding=sparse_embeddings,
    retrieval_mode=RetrievalMode.SPARSE,
    sparse_vector_name="sparse",
)

qdrant.add_documents(documents=documents, ids=uuids)

query = "How much money did the robbers steal?"
found_docs = qdrant.similarity_search(query)
found_docs

API Reference:FastEmbedSparse | QdrantVectorStore | RetrievalMode

混合向量搜索

要执行使用密集向量和稀疏向量通过分数融合进行的混合搜索，

retrieval_mode 参数应设置为 RetrievalMode.HYBRID。
应向 embedding 参数提供密集嵌入值。
必须提供一个使用任何稀疏嵌入提供程序的 SparseEmbeddings 接口实现作为 sparse_embedding 参数的值。

请注意，如果您已使用 HYBRID 模式添加了文档，则在搜索时可以切换到任何检索模式，因为密集向量和稀疏向量都可以在集合中找到。

from langchain_qdrant import FastEmbedSparse, QdrantVectorStore, RetrievalMode
from qdrant_client import QdrantClient, models
from qdrant_client.http.models import Distance, SparseVectorParams, VectorParams

sparse_embeddings = FastEmbedSparse(model_name="Qdrant/bm25")

# Create a Qdrant client for local storage
client = QdrantClient(path="/tmp/langchain_qdrant")

# Create a collection with both dense and sparse vectors
client.create_collection(
    collection_name="my_documents",
    vectors_config={"dense": VectorParams(size=3072, distance=Distance.COSINE)},
    sparse_vectors_config={
        "sparse": SparseVectorParams(index=models.SparseIndexParams(on_disk=False))
    },
)

qdrant = QdrantVectorStore(
    client=client,
    collection_name="my_documents",
    embedding=embeddings,
    sparse_embedding=sparse_embeddings,
    retrieval_mode=RetrievalMode.HYBRID,
    vector_name="dense",
    sparse_vector_name="sparse",
)

qdrant.add_documents(documents=documents, ids=uuids)

query = "How much money did the robbers steal?"
found_docs = qdrant.similarity_search(query)
found_docs

API Reference:FastEmbedSparse | QdrantVectorStore | RetrievalMode

如果你想执行相似性搜索并获取相应的得分，可以运行：

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

* [SIM=0.531834] The weather forecast for tomorrow is cloudy and overcast, with a high of 62 degrees. [{'source': 'news', '_id': '9e6ba50c-794f-4b88-94e5-411f15052a02', '_collection_name': 'demo_collection'}]

要查看 QdrantVectorStore 可用的所有搜索函数的完整列表，请阅读API 参考。

元数据过滤

Qdrant 拥有一个广泛的过滤系统，并支持丰富的数据类型。通过向 similarity_search_with_score 和 similarity_search 方法传递附加参数，也可以在 Langchain 中使用这些过滤器。

from qdrant_client import models

results = vector_store.similarity_search(
    query="Who are the best soccer players in the world?",
    k=1,
    filter=models.Filter(
        should=[
            models.FieldCondition(
                key="page_content",
                match=models.MatchValue(
                    value="The top 10 soccer players in the world right now."
                ),
            ),
        ]
    ),
)
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

* The top 10 soccer players in the world right now. [{'source': 'website', '_id': 'b0964ab5-5a14-47b4-a983-37fa5c5bd154', '_collection_name': 'demo_collection'}]

查询以检索器形式呈现

您还可以将向量存储转换为检索器，以便在您的链中更轻松地使用。

retriever = vector_store.as_retriever(search_type="mmr", search_kwargs={"k": 1})
retriever.invoke("Stealing from the bank is a crime")

[Document(metadata={'source': 'news', '_id': '50d8d6ee-69bf-4173-a6a2-b254e9928965', '_collection_name': 'demo_collection'}, page_content='Robbers broke into the city bank and stole $1 million in cash.')]

用于检索增强生成的使用方法

有关如何将此向量存储用于检索增强生成（RAG）的指南，请参阅以下几节：

自定义 Qdrant

LangChain 应用中有选项可以使用现有的 Qdrant collection。在这种情况下，您可能需要定义如何将 Qdrant point 映射到 LangChain Document。

命名向量

Qdrant 通过命名向量支持每个 point 的多个向量。如果您使用外部创建的 collection，或者希望使用命名不同的向量，可以通过提供其名称来配置。

from langchain_qdrant import RetrievalMode

QdrantVectorStore.from_documents(
    docs,
    embedding=embeddings,
    sparse_embedding=sparse_embeddings,
    location=":memory:",
    collection_name="my_documents_2",
    retrieval_mode=RetrievalMode.HYBRID,
    vector_name="custom_vector",
    sparse_vector_name="custom_sparse_vector",
)

API Reference:RetrievalMode

元数据

Qdrant 会将你的向量嵌入与可选的类 JSON 的载荷（payload）一起存储。载荷是可选的，但由于 LangChain 假定嵌入是根据文档生成的，我们会保留上下文数据，以便你也能提取原始文本。

默认情况下，你的文档将以以下载荷结构存储：

{
    "page_content": "Lorem ipsum dolor sit amet",
    "metadata": {
        "foo": "bar"
    }
}

然而，你也可以决定为页面内容和元数据使用不同的键。如果你已有想重用的集合，这会很有用。

QdrantVectorStore.from_documents(
    docs,
    embeddings,
    location=":memory:",
    collection_name="my_documents_2",
    content_payload_key="my_page_content_key",
    metadata_payload_key="my_meta",
)

API 参考

有关 QdrantVectorStore 所有功能和配置的详细文档，请访问 API 参考：https://python.langchain.com/api_reference/qdrant/qdrant/langchain_qdrant.qdrant.QdrantVectorStore.html

Vector store conceptual guide
Vector store how-to guides

设置​

凭证​

初始化​

本地模式​

内存中​

磁盘存储​

本地服务器部署​

Qdrant Cloud​

使用现有集合​

管理向量存储​

向向量存储添加项目​

从矢量存储中删除项目​

查询向量存储​

直接查询​

密集向量搜索​

稀疏向量搜索​

混合向量搜索​

元数据过滤​

查询以检索器形式呈现​

用于检索增强生成的使用方法​

自定义 Qdrant​

命名向量​

元数据​

API 参考​

Related​

设置

凭证

初始化