Google Cloud SQL for PostgreSQL
Cloud SQL 是一种完全托管的关系型数据库服务，提供高性能、无缝集成和出色的可扩展性。它提供 PostgreSQL、PostgreSQL 和 SQL Server 数据库引擎。通过利用 Cloud SQL 的 Langchain 集成，将您的数据库应用程序扩展到构建 AI 驱动的体验。
本笔记本演示了如何使用 Cloud SQL for PostgreSQL 通过 PostgresVectorStore 类存储向量嵌入。
有关该软件包的更多信息，请参见 GitHub。
开始之前
要运行此笔记本，您需要执行以下操作
🦜🔗 库安装
安装集成库 langchain-google-cloud-sql-pg 和嵌入服务库 langchain-google-vertexai。
%pip install --upgrade --quiet langchain-google-cloud-sql-pg langchain-google-vertexai
仅限 Colab： 解除以下单元格的注释以重新启动内核，或使用按钮重新启动内核。对于 Vertex AI 工作台，您可以使用顶部的按钮重新启动终端。
# # 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 工作台，请查看 此处 的设置说明。
from google.colab import auth
auth.authenticate_user()
☁ 设置您的 Google Cloud 项目
设置您的 Google Cloud 项目，以便您可以在此笔记本中利用 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}
基本用法
设置 Cloud SQL 数据库值
在 Cloud SQL 实例页面 中查找您的数据库值。
# @title Set Your Values Here { display-mode: "form" }
REGION = "us-central1" # @param {type: "string"}
INSTANCE = "my-pg-instance" # @param {type: "string"}
DATABASE = "my-database" # @param {type: "string"}
TABLE_NAME = "vector_store" # @param {type: "string"}
PostgresEngine 连接池
将 Cloud SQL 作为向量存储建立的一个要求和参数是 PostgresEngine 对象。PostgresEngine 配置与您的 Cloud SQL 数据库的连接池，从而使您的应用程序能够成功连接并遵循行业最佳实践。
要使用 PostgresEngine.from_instance() 创建 PostgresEngine，您只需要提供 4 个内容
project_id：位于 Cloud SQL 实例的 Google Cloud 项目的项目 ID。region：Cloud SQL 实例所在的区域。instance：Cloud SQL 实例的名称。database：要连接到的 Cloud SQL 实例上的数据库的名称。
默认情况下，将使用 IAM 数据库身份验证 作为数据库身份验证方法。此库使用属于 应用程序默认凭据 (ADC) 的 IAM 主体，这些凭据来自环境。
有关 IAM 数据库身份验证的更多信息，请参见
或者，还可以使用 内置数据库身份验证，使用用户名和密码访问 Cloud SQL 数据库。只需将可选的 user 和 password 参数提供给 PostgresEngine.from_instance() 即可
user：用于内置数据库身份验证和登录的数据库用户password：用于内置数据库身份验证和登录的数据库密码。
"注意：本教程演示了异步接口。所有异步方法都有相应的同步方法。"
from langchain_google_cloud_sql_pg import PostgresEngine
engine = await PostgresEngine.afrom_instance(
project_id=PROJECT_ID, region=REGION, instance=INSTANCE, database=DATABASE
)
初始化表格
PostgresVectorStore 类需要一个数据库表格。PostgresEngine 引擎有一个辅助方法 init_vectorstore_table()，可用于创建具有正确架构的表格。
from langchain_google_cloud_sql_pg import PostgresEngine
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
)
初始化默认 PostgresVectorStore
from langchain_google_cloud_sql_pg import PostgresVectorStore
store = await PostgresVectorStore.create( # Use .create() to initialize an async vector store
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_cloud_sql_pg.indexes import IVFFlatIndex
index = IVFFlatIndex()
await store.aapply_vector_index(index)
重新索引
await store.areindex() # Re-index using default index name
删除索引
await store.aadrop_vector_index() # Delete index using default name
创建自定义向量存储
向量存储可以利用关系数据来过滤相似性搜索。
创建一个包含自定义元数据列的表格。
from langchain_google_cloud_sql_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 PostgresVectorStore
custom_store = await PostgresVectorStore.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)