Skip to main content
ZeusDB 是一个由 Rust 驱动的高性能向量数据库,提供产品量化、持久化存储和企业级日志记录等高级功能。
本文档展示了如何使用 ZeusDB 为您的 LangChain 应用程序带来企业级向量搜索能力。

配置

从 PyPi 安装 ZeusDB LangChain 集成包:
pip install -qU langchain-zeusdb
在 Jupyter Notebooks 中配置
pip install -qU langchain-zeusdb

入门

此示例使用 OpenAIEmbeddings,需要 OpenAI API key:在此获取您的 OpenAI API key 如果您愿意,也可以将此包与任何其他嵌入提供商(Hugging Face、Cohere、自定义函数等)一起使用。 从 PyPi 安装 LangChain OpenAI 集成包:
pip install -qU langchain-openai

# 在 Jupyter Notebooks 中使用此命令
#pip install -qU langchain-openai

请在下方选择 OpenAI key 集成方案

方案 1:🔑 每次输入 API key 在 Jupyter 中使用 getpass 安全地为当前会话输入 key:
import os
import getpass

os.environ["OPENAI_API_KEY"] = getpass.getpass("OpenAI API Key:")
方案 2:🗂️ 使用 .env 文件 将 key 保存在本地 .env 文件中并使用 python-dotenv 自动加载
from dotenv import load_dotenv

load_dotenv()  # 读取 .env 并设置 OPENAI_API_KEY
🎉 很棒!您已准备好开始使用。

初始化

# 导入所需包和类
from langchain_zeusdb import ZeusDBVectorStore
from langchain_openai import OpenAIEmbeddings
from zeusdb import VectorDatabase
# 初始化嵌入
embeddings = OpenAIEmbeddings(model="text-embedding-3-small")

# 创建 ZeusDB 索引
vdb = VectorDatabase()
index = vdb.create(index_type="hnsw", dim=1536, space="cosine")

# 创建向量存储
vector_store = ZeusDBVectorStore(zeusdb_index=index, embedding=embeddings)

管理向量存储

2.1 向向量存储添加条目

from langchain_core.documents import Document

document_1 = Document(
    page_content="ZeusDB is a high-performance vector database",
    metadata={"source": "https://docs.zeusdb.com"},
)

document_2 = Document(
    page_content="Product Quantization reduces memory usage significantly",
    metadata={"source": "https://docs.zeusdb.com"},
)

document_3 = Document(
    page_content="ZeusDB integrates seamlessly with LangChain",
    metadata={"source": "https://docs.zeusdb.com"},
)

documents = [document_1, document_2, document_3]

vector_store.add_documents(documents=documents, ids=["1", "2", "3"])

2.2 更新向量存储中的条目

updated_document = Document(
    page_content="ZeusDB now supports advanced Product Quantization with 4x-256x compression",
    metadata={"source": "https://docs.zeusdb.com", "updated": True},
)

vector_store.add_documents([updated_document], ids=["1"])

2.3 从向量存储删除条目

vector_store.delete(ids=["3"])

查询向量存储

3.1 直接查询

执行简单的相似性搜索:
results = vector_store.similarity_search(query="high performance database", k=2)

for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")
如果您想执行相似性搜索并获取对应分数:
results = vector_store.similarity_search_with_score(query="memory optimization", k=2)

for doc, score in results:
    print(f"* [SIM={score:.3f}] {doc.page_content} [{doc.metadata}]")

3.2 转换为检索器后查询

您也可以将向量存储转换为检索器,以便在链中更轻松地使用:
retriever = vector_store.as_retriever(search_type="mmr", search_kwargs={"k": 2})

retriever.invoke("vector database features")

ZeusDB 特有功能

4.1 使用产品量化的内存高效配置

对于大型数据集,使用产品量化来减少内存使用:
# 创建内存优化的向量存储
quantization_config = {"type": "pq", "subvectors": 8, "bits": 8, "training_size": 10000}

vdb_quantized = VectorDatabase()
quantized_index = vdb_quantized.create(
    index_type="hnsw", dim=1536, quantization_config=quantization_config
)

quantized_vector_store = ZeusDBVectorStore(
    zeusdb_index=quantized_index, embedding=embeddings
)

print(f"Created quantized store: {quantized_index.info()}")

4.2 持久化

将向量存储保存到磁盘并加载: 如何保存向量存储
# 保存向量存储
vector_store.save_index("my_zeusdb_index.zdb")
如何加载向量存储
# 加载向量存储
loaded_store = ZeusDBVectorStore.load_index(
    path="my_zeusdb_index.zdb", embedding=embeddings
)

print(f"Loaded store with {loaded_store.get_vector_count()} vectors")

用于检索增强生成

有关如何将此向量存储用于检索增强生成(RAG)的指南,请参阅以下内容:

API 参考

有关所有 ZeusDBVectorStore 功能和配置的详细文档,请前往 ZeusDB 文档