Skip to main content
Open In ColabOpen on GitHub

openGauss 向量存储

本笔记本介绍了如何开始使用 openGauss VectorStore。openGauss 是一种具有原生向量存储和检索能力的高性能关系型数据库。此集成使 LangChain 应用程序能够在 ACID 兼容的环境中进行向量操作,将传统 SQL 功能与现代 AI 驱动的相似性搜索相结合。 向量存储。

设置

启动 openGauss 容器

docker run --name opengauss \
-d \
-e GS_PASSWORD='MyStrongPass@123' \
-p 8888:5432 \
opengauss/opengauss-server:latest

安装 langchain-opengauss

pip install langchain-opengauss

系统要求

  • openGauss ≥ 7.0.0
  • Python ≥ 3.8
  • psycopg2-binary

凭据

使用您的 openGauss 凭据

初始化

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_opengauss import OpenGauss, OpenGaussSettings

# Configure with schema validation
config = OpenGaussSettings(
table_name="test_langchain",
embedding_dimension=384,
index_type="HNSW",
distance_strategy="COSINE",
)
vector_store = OpenGauss(embedding=embeddings, config=config)

管理向量存储

将项目添加到向量存储

from langchain_core.documents import Document

document_1 = Document(page_content="foo", metadata={"source": "https://example.com"})

document_2 = Document(page_content="bar", metadata={"source": "https://example.com"})

document_3 = Document(page_content="baz", metadata={"source": "https://example.com"})

documents = [document_1, document_2, document_3]

vector_store.add_documents(documents=documents, ids=["1", "2", "3"])
API 参考:文档

更新向量存储中的项目

updated_document = Document(
page_content="qux", metadata={"source": "https://another-example.com"}
)

# If the id is already exist, will update the document
vector_store.add_documents(document_id="1", document=updated_document)

从向量存储中删除项目

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

查询向量存储

一旦您的向量存储已创建并添加了相关文档,您很可能希望在链或代理运行期间对其进行查询。

直接查询

执行简单的相似度搜索可以按以下方式完成:

  • TODO:编辑并运行代码单元格以生成输出
results = vector_store.similarity_search(
query="thud", k=1, filter={"source": "https://another-example.com"}
)
for doc in results:
print(f"* {doc.page_content} [{doc.metadata}]")

如果您想执行相似度搜索并获取相应的分数,可以运行:

results = vector_store.similarity_search_with_score(
query="thud", k=1, filter={"source": "https://example.com"}
)
for doc, score in results:
print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

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

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

  • TODO:编辑并运行代码单元格以生成输出
retriever = vector_store.as_retriever(search_type="mmr", search_kwargs={"k": 1})
retriever.invoke("thud")

检索增强生成的用法

有关如何使用此向量存储进行检索增强生成 (RAG) 的指南,请参阅以下部分:

配置

连接设置

参数默认描述
hostlocalhostDatabase server address
port8888Database connection port
usergaussdbDatabase username
password-Complex password string
databasepostgresDefault database name
min_connections1Connection pool minimum size
max_connections5Connection pool maximum size
table_namelangchain_docsName of the table for storing vector data and metadata
index_typeIndexType.HNSWVector index algorithm type. Options: HNSW or IVFFLAT\nDefault is HNSW.
vector_typeVectorType.vectorType of vector representation to use. Default is Vector.
distance_strategyDistanceStrategy.COSINEVector similarity metric to use for retrieval. Options: euclidean (L2 distance), cosine (angular distance, ideal for text embeddings), manhattan (L1 distance for sparse data), negative_inner_product (dot product for normalized vectors).\n Default is cosine.
embedding_dimension1536Dimensionality of the vector embeddings.

支持的组合

向量类型维度索引类型支持的距离策略
vector≤2000HNSW/IVFFLATCOSINE/EUCLIDEAN/MANHATTAN/INNER_PROD

性能优化

索引调优指南

HNSW 参数

  • m: 16-100(召回与记忆之间的平衡)
  • ef_construction: 64-1000(必须大于2*m)

IVFFLAT 推荐

import math

lists = min(
int(math.sqrt(total_rows)) if total_rows > 1e6 else int(total_rows / 1000),
2000, # openGauss maximum
)

连接池

OpenGaussSettings(min_connections=3, max_connections=20)

限制

  • bitsparsevec 向量类型目前正在开发中
  • 最大向量维度:类型为 vector 时为 2000

API 参考

有关 __ModuleName__VectorStore 的所有功能和配置的详细文档,请访问 API 参考: https://python.langchain.com/api_reference/zh/latest/vectorstores/opengauss.OpenGuass.html