Google Cloud SQL for MySQL
Cloud SQL 是一个完全托管的关系数据库服务，提供高性能、无缝集成和卓越的可扩展性。它提供了 PostgreSQL、MySQL 和 SQL Server 数据库引擎。通过利用 Cloud SQL 的 LangChain 集成扩展您的数据库应用程序，构建 AI 功能化的体验。
这个笔记本介绍了如何使用Cloud SQL for MySQL类来存储向量嵌入。
Learn more about the package on GitHub.
开始之前
要运行此笔记本，您需要执行以下操作：
- 创建一个Google云项目
- 启用 Cloud SQL Admin API。
- 创建一个云 SQL 实例。 (版本必须 >= 8.0.36，并配置了 cloudsql_vector 数据库标志为 "On")
- 创建一个 Cloud SQL 数据库。
- 将用户添加到数据库中。
🦜🔗 库安装
安装集成库，langchain-google-cloud-sql-mysql，以及嵌入式服务库，langchain-google-vertexai。
%pip install --upgrade --quiet langchain-google-cloud-sql-mysql 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 实例页面中查找您的数据库值。
Note: MySQL向量支持仅在版本>= 8.0.36的MySQL实例中可用。
对于现有实例，您可能需要执行一个自助服务维护更新以将维护版本更新到MYSQL_8_0_36.R20240401.03_00或更高版本。完成更新后，请配置数据库标志，使新的cloudsql_vector标志为“On”。
# @title Set Your Values Here { display-mode: "form" }
REGION = "us-central1" # @param {type: "string"}
INSTANCE = "my-mysql-instance" # @param {type: "string"}
DATABASE = "my-database" # @param {type: "string"}
TABLE_NAME = "vector_store" # @param {type: "string"}
MySQLEngine 连接池
将 Cloud SQL 设为向量存储的一个要求和参数是 MySQLEngine 对象。MySQLEngine 用于配置到您的 Cloud SQL 数据库的连接池，从而实现应用程序的成功连接，并遵循行业最佳实践。
要使用MySQLEngine创建一个MySQLEngine.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 数据库。只需向 MySQLEngine.from_instance() 提供可选的 user 和 password 参数：
user: 使用内置数据库进行身份验证和登录时要使用的数据库用户password: 使用内置数据库身份验证和登录时的数据库密码。
from langchain_google_cloud_sql_mysql import MySQLEngine
engine = MySQLEngine.from_instance(
project_id=PROJECT_ID, region=REGION, instance=INSTANCE, database=DATABASE
)
初始化表格
MySQLVectorStore 类需要一个数据库表。MySQLEngine 类有一个辅助方法init_vectorstore_table()，可以用来为你创建具有正确架构的表格。
engine.init_vectorstore_table(
table_name=TABLE_NAME,
vector_size=768, # Vector size for VertexAI model(textembedding-gecko@latest)
)
创建一个嵌入类实例
您可以使用任何LangChain嵌入模型。
要使用VertexAIEmbeddings，您可能需要启用Vertex AI API。
我们建议为生产环境固定嵌入模型的版本，了解关于文本嵌入模型的更多信息。
# 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
)
初始化默认的MySQL向量存储
要初始化一个MySQLVectorStore类，您只需要提供3个东西：
engine- 一个MySQLEngine引擎的实例。embedding_service- 一个LangChain嵌入模型的实例。table_name: 在Cloud SQL数据库中使用的向量存储的表格名称。
from langchain_google_cloud_sql_mysql import MySQLVectorStore
store = MySQLVectorStore(
engine=engine,
embedding_service=embedding,
table_name=TABLE_NAME,
)
添加文本
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]
store.add_texts(all_texts, metadatas=metadatas, ids=ids)
删除文本
通过ID从向量存储中删除向量。
store.delete([ids[1]])
搜索文档
query = "I'd like a fruit."
docs = store.similarity_search(query)
print(docs[0].page_content)
Pineapple
按向量搜索文档
也可以通过使用 similarity_search_by_vector 来搜索与给定嵌入向量相似的文档，它接受嵌入向量作为参数而不是字符串。
query_vector = embedding.embed_query(query)
docs = store.similarity_search_by_vector(query_vector, k=2)
print(docs)
[Document(page_content='Pineapple', metadata={'len': 9}), Document(page_content='Banana', metadata={'len': 6})]
添加索引
通过应用向量索引来加快向量搜索查询。了解有关MySQL 向量索引的更多信息。
Note: 对于IAM数据库认证（默认使用方式），需要由特权数据库用户为IAM数据库用户授予权限，以便完全控制向量索引。
GRANT EXECUTE ON PROCEDURE mysql.create_vector_index TO '<IAM_DB_USER>'@'%';
GRANT EXECUTE ON PROCEDURE mysql.alter_vector_index TO '<IAM_DB_USER>'@'%';
GRANT EXECUTE ON PROCEDURE mysql.drop_vector_index TO '<IAM_DB_USER>'@'%';
GRANT SELECT ON mysql.vector_indexes TO '<IAM_DB_USER>'@'%';
from langchain_google_cloud_sql_mysql import VectorIndex
store.apply_vector_index(VectorIndex())
移除一个索引
store.drop_vector_index()
高级用法
使用自定义元数据创建一个MySQL向量存储
向量存储可以通过利用关系数据来过滤相似搜索。
创建一个表格并使用自定义元数据列实例化MySQLVectorStore个实例。
from langchain_google_cloud_sql_mysql import Column
# set table name
CUSTOM_TABLE_NAME = "vector_store_custom"
engine.init_vectorstore_table(
table_name=CUSTOM_TABLE_NAME,
vector_size=768, # VertexAI model: textembedding-gecko@latest
metadata_columns=[Column("len", "INTEGER")],
)
# initialize MySQLVectorStore with custom metadata columns
custom_store = MySQLVectorStore(
engine=engine,
embedding_service=embedding,
table_name=CUSTOM_TABLE_NAME,
metadata_columns=["len"],
# connect to an existing VectorStore by customizing the table schema:
# id_column="uuid",
# content_column="documents",
# embedding_column="vectors",
)
搜索具有元数据过滤的文档
可以先筛选文档，然后再进行处理。
例如，可以使用filter参数根据元数据过滤文档。
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]
custom_store.add_texts(all_texts, metadatas=metadatas, ids=ids)
# use filter on search
query_vector = embedding.embed_query("I'd like a fruit.")
docs = custom_store.similarity_search_by_vector(query_vector, filter="len >= 6")
print(docs)
[Document(page_content='Pineapple', metadata={'len': 9}), Document(page_content='Banana', metadata={'len': 6}), Document(page_content='Apples and oranges', metadata={'len': 18}), Document(page_content='Cars and airplanes', metadata={'len': 18})]