Skip to main content
AlloyDB 是一款全托管的关系型数据库服务，提供高性能、无缝集成和卓越的可扩展性。AlloyDB 与 PostgreSQL 100% 兼容。利用 AlloyDB 的 LangChain 集成，可扩展您的数据库应用，构建 AI 驱动的体验。
本 Notebook 介绍如何使用 AlloyDB for PostgreSQL 通过 AlloyDBVectorStore 类存储向量嵌入。 了解更多关于该包的信息，请访问 GitHub。 在 Colab 中打开

​
开始之前

要运行本 Notebook，您需要完成以下步骤：

​
🦜🔗 库安装

安装集成库 langchain-google-alloydb-pg 和嵌入服务库 langchain-google-vertexai。 
pip install -qU  langchain-google-alloydb-pg langchain-google-vertexai
仅限 Colab： 取消注释以下单元格以重启内核，或使用按钮重启内核。对于 Vertex AI Workbench，可以使用顶部的按钮重启终端。 
# # 安装后自动重启内核，以便环境可以访问新包
# import IPython

# app = IPython.Application.instance()
# app.kernel.do_shutdown(True)

​
🔐 身份验证

以登录本 Notebook 的 IAM 用户身份向 Google Cloud 进行身份验证，以访问您的 Google Cloud 项目。
  • 如果您使用 Colab 运行本 Notebook，请使用以下单元格并继续。
  • 如果您使用 Vertex AI Workbench，请查看此处的设置说明。
from google.colab import auth

auth.authenticate_user()

​
☁ 设置您的 Google Cloud 项目

设置您的 Google Cloud 项目，以便在本 Notebook 中使用 Google Cloud 资源。 如果您不知道项目 ID，请尝试以下方法：
  • 运行 gcloud config list。
  • 运行 gcloud projects list。
  • 参阅支持页面：查找项目 ID。
# @markdown 请在下方填写您的 Google Cloud 项目 ID，然后运行该单元格。

PROJECT_ID = "my-project-id"  # @param {type:"string"}

# 设置项目 ID
!gcloud config set project {PROJECT_ID}

​
基本用法

​
设置 AlloyDB 数据库值

在 AlloyDB 实例页面中查找您的数据库值。 
# @title 在此设置您的值 { display-mode: "form" }
REGION = "us-central1"  # @param {type: "string"}
CLUSTER = "my-cluster"  # @param {type: "string"}
INSTANCE = "my-primary"  # @param {type: "string"}
DATABASE = "my-database"  # @param {type: "string"}
TABLE_NAME = "vector_store"  # @param {type: "string"}

​
AlloyDBEngine 连接池

将 AlloyDB 用作向量存储的要求之一是 AlloyDBEngine 对象。AlloyDBEngine 为您的 AlloyDB 数据库配置连接池，从而实现应用程序的成功连接，并遵循行业最佳实践。 要使用 AlloyDBEngine.from_instance() 创建 AlloyDBEngine，您只需提供以下 5 项信息：
  1. project_id：AlloyDB 实例所在的 Google Cloud 项目 ID。
  2. region：AlloyDB 实例所在的区域。
  3. cluster：AlloyDB 集群的名称。
  4. instance：AlloyDB 实例的名称。
  5. database：要连接的 AlloyDB 实例上的数据库名称。
默认情况下，将使用 IAM 数据库身份验证 作为数据库身份验证方式。该库使用来自环境的 应用默认凭据 (ADC) 所属的 IAM 主体。 也可以选择使用内置数据库身份验证，通过用户名和密码访问 AlloyDB 数据库。只需向 AlloyDBEngine.from_instance() 提供可选的 user 和 password 参数：
  • user：用于内置数据库身份验证和登录的数据库用户
  • password：用于内置数据库身份验证和登录的数据库密码
注意： 本教程演示的是异步接口。所有异步方法都有对应的同步方法。 
from langchain_google_alloydb_pg import AlloyDBEngine

engine = await AlloyDBEngine.afrom_instance(
    project_id=PROJECT_ID,
    region=REGION,
    cluster=CLUSTER,
    instance=INSTANCE,
    database=DATABASE,
)

​
初始化表

AlloyDBVectorStore 类需要一个数据库表。AlloyDBEngine 引擎提供了一个辅助方法 init_vectorstore_table()，可用于为您创建具有正确 schema 的表。 
await engine.ainit_vectorstore_table(
    table_name=TABLE_NAME,
    vector_size=768,  # VertexAI 模型（textembedding-gecko@latest）的向量大小
)

​
创建嵌入类实例

您可以使用任何 LangChain 嵌入模型。 使用 VertexAIEmbeddings 可能需要启用 Vertex AI API。我们建议为生产环境指定嵌入模型版本，详见 文本嵌入模型。 
# 启用 Vertex AI API
!gcloud services enable aiplatform.googleapis.com

from langchain_google_vertexai import VertexAIEmbeddings

embedding = VertexAIEmbeddings(
    model_name="textembedding-gecko@latest", project=PROJECT_ID
)

​
初始化默认 AlloyDBVectorStore

from langchain_google_alloydb_pg import AlloyDBVectorStore

store = await AlloyDBVectorStore.create(
    engine=engine,
    table_name=TABLE_NAME,
    embedding_service=embedding,
)

​
添加文本

import uuid

all_texts = ["Apples and oranges", "Cars and airplanes", "Pineapple", "Train", "Banana"]
metadatas = [{"len": len(t)} for t in all_texts]
ids = [str(uuid.uuid4()) for _ in all_texts]

await store.aadd_texts(all_texts, metadatas=metadatas, ids=ids)

​
删除文本

await store.adelete([ids[1]])

​
搜索文档

query = "I'd like a fruit."
docs = await store.asimilarity_search(query)
print(docs)

​
按向量搜索文档

query_vector = embedding.embed_query(query)
docs = await store.asimilarity_search_by_vector(query_vector, k=2)
print(docs)

​
添加索引

通过应用向量索引加速向量搜索查询。了解更多关于向量索引的信息。 
from langchain_google_alloydb_pg.indexes import IVFFlatIndex

index = IVFFlatIndex()
await store.aapply_vector_index(index)

​
重建索引

await store.areindex()  # 使用默认索引名称重建索引

​
删除索引

await store.adrop_vector_index()  # 使用默认名称删除索引

​
创建自定义向量存储

向量存储可以利用关系数据对相似度搜索进行过滤。 创建带有自定义元数据列的表。 
from langchain_google_alloydb_pg import Column

# 设置表名
TABLE_NAME = "vectorstore_custom"

await engine.ainit_vectorstore_table(
    table_name=TABLE_NAME,
    vector_size=768,  # VertexAI 模型：textembedding-gecko@latest
    metadata_columns=[Column("len", "INTEGER")],
)


# 初始化 AlloyDBVectorStore
custom_store = await AlloyDBVectorStore.create(
    engine=engine,
    table_name=TABLE_NAME,
    embedding_service=embedding,
    metadata_columns=["len"],
    # 通过自定义表 schema 连接到现有 VectorStore：
    # id_column="uuid",
    # content_column="documents",
    # embedding_column="vectors",
)

​
使用元数据过滤器搜索文档

import uuid

# 向向量存储添加文本
all_texts = ["Apples and oranges", "Cars and airplanes", "Pineapple", "Train", "Banana"]
metadatas = [{"len": len(t)} for t in all_texts]
ids = [str(uuid.uuid4()) for _ in all_texts]
await store.aadd_texts(all_texts, metadatas=metadatas, ids=ids)

# 在搜索中使用过滤器
docs = await custom_store.asimilarity_search_by_vector(query_vector, filter="len >= 6")

print(docs)
在 GitHub 上编辑此页面 或提交 Issue。
通过 MCP 将这些文档连接到 Claude、VSCode 等，获取实时答案。