Skip to main content
Open In ColabOpen on GitHub

Google AlloyDB for PostgreSQL

AlloyDB 是一种完全托管的关系型数据库服务，提供高吞吐量、无缝集成和出色的可扩展性。AlloyDB 与 PostgreSQL 100% 兼容。利用 AlloyDB 的 Langchain 集成，扩展您的数据库应用程序以构建由 AI 驱动的体验。

本笔记本将介绍如何使用 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，您可以使用顶部的按钮重启终端。

# # Automatically restart kernel after installs so that your environment can access the new packages
# import IPython

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

🔐 身份验证​

通过笔记本中登录的 IAM 用户身份验证到 Google Cloud，以便访问您的 Google Cloud 项目。

from google.colab import auth

auth.authenticate_user()

☁ 设置您的 Google Cloud 项目​

设置您的 Google Cloud 项目，以便您在此 notebook 中利用 Google Cloud 资源。

如果您不知道您的项目 ID，可以尝试以下方法：

  • 运行 gcloud config list。
  • 运行 gcloud projects list。
  • 请参阅支持页面：查找项目 ID。
# @markdown Please fill in the value below with your Google Cloud project ID and then run the cell.

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

# Set the project id
!gcloud config set project {PROJECT_ID}

基本用法​

设置 AlloyDB 数据库值​

在 AlloyDB实例页面 中查找您的数据库值。

# @title Set Your Values Here { 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"}

AlloyDB 引擎连接池​

将 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,  # Vector size for VertexAI model(textembedding-gecko@latest)
)

创建嵌入类实例​

您可以使用任何 LangChain 嵌入模型。 您可能需要启用 Vertex AI API 来使用 VertexAIEmbeddings。我们建议在生产环境中设置嵌入模型的版本，详细了解 文本嵌入模型。

# enable 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
)
API Reference:VertexAIEmbeddings

初始化默认 AlloyDB 向量存储​

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()  # Re-index using default index name

删除索引​

await store.adrop_vector_index()  # Delete index using default name

创建自定义向量存储 (Vector Store)​

向量存储可以利用关系数据来过滤相似性搜索。

创建一个包含自定义元数据列的表。

from langchain_google_alloydb_pg import Column

# Set table name
TABLE_NAME = "vectorstore_custom"

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


# Initialize AlloyDBVectorStore
custom_store = await AlloyDBVectorStore.create(
    engine=engine,
    table_name=TABLE_NAME,
    embedding_service=embedding,
    metadata_columns=["len"],
    # Connect to a existing VectorStore by customizing the table schema:
    # id_column="uuid",
    # content_column="documents",
    # embedding_column="vectors",
)

按元数据筛选搜索文档​

import uuid

# Add texts to the 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)

# Use filter on search
docs = await custom_store.asimilarity_search_by_vector(query_vector, filter="len >= 6")

print(docs)