Google Cloud SQL for PostgreSQL
Cloud SQL 是一个完全托管的关系数据库服务，提供高性能、无缝集成和卓越的可扩展性。它提供了 PostgreSQL 和 SQL Server 数据库引擎。利用 Cloud SQL 的 Langchain 集成扩展您的数据库应用程序以构建 AI 动力化的体验。
这个笔记本介绍了如何使用Cloud SQL for PostgreSQL类来存储向量嵌入。
Learn more about the package on GitHub.
开始之前
要运行此笔记本，您需要执行以下操作：
🦜🔗 库安装
安装集成库，langchain-google-cloud-sql-pg，以及嵌入式服务库，langchain-google-vertexai。
%pip install --upgrade --quiet langchain-google-cloud-sql-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工作区，请参阅设置说明这里。
from google.colab import auth
auth.authenticate_user()
☁ 设置您的Google云项目
设置您的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}
基本用法
设置云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创建一个PostgresEngine.from_instance()，您只需要提供4个东西:
project_id: 位于 Google Cloud 项目的 Cloud SQL 实例中的项目 ID。region: 云 SQL 实例所在的区域。instance: 云SQL实例的名称。database: 连接到Cloud SQL实例时要使用的数据库名称。
默认情况下，IAM数据库身份验证将被用作数据库认证的方法。此库使用来自环境的应用默认凭据（ADC）所属的IAM主体。
对于IAM数据库身份验证的更多信息，请参见：<br>
Optionally, 内置数据库认证 可以使用用户名和密码访问 Cloud SQL 数据库。只需向 PostgresEngine.from_instance() 提供可选的 user 和 password 参数：
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
)
初始化表格
0类需要一个数据库表。1号引擎有一个辅助方法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)
Re-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)