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

在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项目。

  • 如果您正在使用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
  • 查看支持页面:Locate the project 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"}

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数据库。只需提供可选的userpassword参数给AlloyDBEngine.from_instance()

  • 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
)

初始化一个默认的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()  # Re-index using default index name

删除索引

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

创建一个自定义的向量存储

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

创建一个带有自定义元数据列的表。

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)

这个页面有帮助吗?