Qdrant

Qdrant（读作：quadrant）是一个向量相似度搜索引擎。它提供了一个生产就绪的服务，带有方便的 API 来存储、搜索和管理向量，并提供额外的负载和扩展过滤支持。这使得它适用于各种神经网络或语义匹配、多方面搜索和其他应用程序。

本文档演示了如何在 Langchain 中使用 Qdrant 进行密集/稀疏和混合检索。

本页记录了QdrantVectorStore 类，该类通过 Qdrant 的新查询 API 支持多种检索模式。它需要您运行 Qdrant v1.10.0 或更高版本。

设置

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

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

%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 服务器。这非常适合测试、调试或仅存储少量向量。嵌入可以完全保存在内存中或持久化到磁盘。

内存中

对于一些测试场景和快速实验，您可能更喜欢将所有数据仅保存在内存中，这样当客户端销毁时（通常在您的脚本/笔记本结束时）数据就会丢失。

OpenAI
HuggingFace
虚假嵌入

pip install -qU langchain-openai

import getpass

    os.environ["OPENAI_API_KEY"] = getpass.getpass()

from langchain_openai import OpenAIEmbeddings

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

pip install -qU langchain-huggingface

from langchain_huggingface import HuggingFaceEmbeddings

embeddings = HuggingFaceEmbeddings(model="sentence-transformers/all-mpnet-base-v2")

pip install -qU langchain-core

from langchain_core.embeddings import FakeEmbeddings

embeddings = FakeEmbeddings(size=4096)

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,
)

磁盘存储

本地模式，不使用 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 图表选择 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 云

如果您不想花时间管理基础设施，可以选择在Qdrant 云上设置一个完全托管的 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",
)

使用现有集合

要获取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 chocalate 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.",
    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))]

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

API 参考：文档

['c04134c3-273d-4766-949a-eee46052ad32',
 '9e6ba50c-794f-4b88-94e5-411f15052a02',
 'd3202666-6f2b-4186-ac43-e35389de8166',
 '50d8d6ee-69bf-4173-a6a2-b254e9928965',
 'bd2eae02-74b5-43ec-9fcf-09e9d9db6fd3',
 '6dae6b37-826d-4f14-8376-da4603b35de3',
 'b0964ab5-5a14-47b4-a983-37fa5c5bd154',
 '91ed6c56-fe53-49e2-8199-c3bb3c33c3eb',
 '42a580cb-7469-4324-9927-0febab57ce92',
 'ff774e5c-f158-4d12-94e2-0a0162b22f27']

从向量存储中删除项目

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 RetrievalMode

qdrant = QdrantVectorStore.from_documents(
    docs,
    embedding=embeddings,
    location=":memory:",
    collection_name="my_documents",
    retrieval_mode=RetrievalMode.DENSE,
)

query = "What did the president say about Ketanji Brown Jackson"
found_docs = qdrant.similarity_search(query)

稀疏向量搜索

要仅使用稀疏向量进行搜索，

retrieval_mode 参数应设置为RetrievalMode.SPARSE。
使用任何稀疏嵌入提供程序实现SparseEmbeddings 接口必须作为值提供给sparse_embedding 参数。

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

要使用它，请安装 FastEmbed 包。

%pip install fastembed

from langchain_qdrant import FastEmbedSparse, RetrievalMode

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

qdrant = QdrantVectorStore.from_documents(
    docs,
    sparse_embedding=sparse_embeddings,
    location=":memory:",
    collection_name="my_documents",
    retrieval_mode=RetrievalMode.SPARSE,
)

query = "What did the president say about Ketanji Brown Jackson"
found_docs = qdrant.similarity_search(query)

混合向量搜索

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

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

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

from langchain_qdrant import FastEmbedSparse, RetrievalMode

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

qdrant = QdrantVectorStore.from_documents(
    docs,
    embedding=embeddings,
    sparse_embedding=sparse_embeddings,
    location=":memory:",
    collection_name="my_documents",
    retrieval_mode=RetrievalMode.HYBRID,
)

query = "What did the president say about Ketanji Brown Jackson"
found_docs = qdrant.similarity_search(query)

如果您想执行相似性搜索并接收相应的分数，可以运行

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 具有丰富的过滤系统，支持多种类型。也可以在 Langchain 中使用过滤器，通过将额外的参数传递给similarity_search_with_score 和similarity_search 方法。

from qdrant_client.http 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 集合。在这种情况下，您可能需要定义如何将 Qdrant 点映射到 Langchain Document。

命名向量

Qdrant 支持每个点多个向量，通过命名向量。如果您使用外部创建的集合，或者想要使用不同命名的向量，您可以通过提供其名称来配置它。

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",
)

元数据

Qdrant 存储您的向量嵌入以及可选的 JSON 类负载。负载是可选的，但由于 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.ac.cn/v0.2/api_reference/qdrant/qdrant/langchain_qdrant.qdrant.QdrantVectorStore.html

向量存储概念指南
向量存储操作指南

Qdrant

设置

凭据

初始化

本地模式

内存中

磁盘存储

本地服务器部署

Qdrant 云

使用现有集合

管理向量存储

向向量存储添加项目

从向量存储中删除项目

查询向量存储

直接查询

密集向量搜索

稀疏向量搜索

混合向量搜索

元数据过滤

通过转换为检索器进行查询

用于检索增强生成的使用

自定义 Qdrant

命名向量

元数据

API 参考

此页面对您有帮助吗？

您也可以留下详细的反馈在 GitHub 上.

Qdrant

设置​

凭据​

初始化​

本地模式​

内存中​

磁盘存储​

本地服务器部署​

Qdrant 云​

使用现有集合​

管理向量存储​

向向量存储添加项目​

从向量存储中删除项目​

查询向量存储​

直接查询​

密集向量搜索​

稀疏向量搜索​

混合向量搜索​

元数据过滤​

通过转换为检索器进行查询​

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

自定义 Qdrant​

命名向量​

元数据​

API 参考​

相关​

此页面对您有帮助吗？

您也可以留下详细的反馈 在 GitHub 上.

设置

凭据

初始化

本地模式

内存中

磁盘存储

本地服务器部署

Qdrant 云

使用现有集合

管理向量存储

向向量存储添加项目

从向量存储中删除项目

查询向量存储

直接查询

密集向量搜索

稀疏向量搜索

混合向量搜索

元数据过滤

通过转换为检索器进行查询

用于检索增强生成的使用

自定义 Qdrant

命名向量

元数据

API 参考

相关

您也可以留下详细的反馈在 GitHub 上.