Skip to main content

Google AlloyDB for PostgreSQL

AlloyDB 是一个完全托管的关系型数据库服务，提供高性能、无缝集成和令人印象深刻的可伸缩性。AlloyDB 与 PostgreSQL 完全兼容。通过 AlloyDB 的 Langchain 集成，可以扩展数据库应用程序以构建基于人工智能的体验。

本笔记介绍如何使用 AlloyDB for PostgreSQL 来使用 AlloyDBVectorStore 类存储向量嵌入。

在 GitHub 上了解更多关于该包的信息。

Open In Colab

开始之前​

要运行此笔记，您需要完成以下步骤：

🦜🔗 库安装​

安装集成库 langchain-google-alloydb-pg 和嵌入式服务库 langchain-google-vertexai。

%pip install --upgrade --quiet  langchain-google-alloydb-pg langchain-google-vertexai

仅适用于 Colab： 取消下面的注释以重新启动内核，或者使用顶部的按钮重新启动内核。对于 Vertex AI Workbench，您可以使用顶部的按钮重新启动终端。

# # 自动安装后重新启动内核，以便您的环境可以访问新的包
# import IPython
# app = IPython.Application.instance()
# app.kernel.do_shutdown(True)

🔐 身份验证​

作为在此笔记本中登录的 IAM 用户，进行 Google Cloud 身份验证，以便访问您的 Google Cloud 项目。

  • 如果您使用 Colab 运行此笔记，使用下面的单元格并继续。

  • 如果您使用 Vertex AI Workbench，请查看此处的设置说明。

from google.colab import auth
auth.authenticate_user()

☁ 设置您的 Google Cloud 项目​

设置您的 Google Cloud 项目，以便您可以在此笔记本中利用 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()，可以用来为您创建具有适当模式的表。

await engine.ainit_vectorstore_table(
    table_name=TABLE_NAME,
    vector_size=768,  # VertexAI 模型的向量大小（textembedding-gecko@latest）
)

创建嵌入类实例​

您可以使用任何LangChain 嵌入模型。

您可能需要启用 Vertex AI API 来使用 VertexAIEmbeddings。我们建议为生产环境设置嵌入模型的版本，了解更多关于文本嵌入模型的信息。

# 启用 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()  # 使用默认名称删除索引

创建自定义 Vector Store​

Vector Store 可以利用关系数据来过滤相似性搜索。

创建具有自定义元数据列的表。

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"],
    # 通过自定义表模式连接到现有的 VectorStore：
    # id_column="uuid",
    # content_column="documents",
    # embedding_column="vectors",
)

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

import uuid
# 向 Vector Store 添加文本
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)

Was this page helpful?


You can leave detailed feedback on GitHub.