Skip to main content
Open In ColabOpen on GitHub

Google Cloud SQL for MySQL

Cloud SQL 是一个完全托管的关系数据库服务，提供高性能、无缝集成和令人印象深刻的扩展性。它提供 PostgreSQL、MySQL 和 SQL Server 数据库引擎。通过利用 Cloud SQL 的 LangChain 集成，扩展您的数据库应用程序以构建由 AI 驱动的体验。

本笔记本介绍了如何使用Cloud SQL for MySQL与MySQLVectorStore类来存储向量嵌入。

了解更多关于该包的信息，请访问GitHub。

在Colab中打开

开始之前​

要运行此笔记本，您需要执行以下操作：

🦜🔗 库安装​

安装集成库，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 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}

基本用法​

设置 Cloud SQL 数据库值​

在Cloud SQL 实例页面中找到您的数据库值。

注意： MySQL 向量支持仅在版本 >= 8.0.36 的 MySQL 实例上可用。

对于现有实例，您可能需要执行自助维护更新，将您的维护版本更新到MYSQL_8_0_36.R20240401.03_00或更高版本。更新后，配置您的数据库标志，将新的cloudsql_vector标志设置为“开启”。

# @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.from_instance()创建MySQLEngine，你只需要提供4样东西：

  1. project_id : Google Cloud 项目中 Cloud SQL 实例所在的项目 ID。
  2. region : Cloud SQL 实例所在的区域。
  3. instance : Cloud SQL 实例的名称。
  4. database : 要连接的 Cloud SQL 实例上的数据库名称。

默认情况下，IAM 数据库认证将用作数据库认证的方法。该库使用属于从环境中获取的应用程序默认凭据 (ADC)的 IAM 主体。

有关IAM数据库认证的更多信息，请参阅：

可选地，也可以使用内置数据库认证，通过用户名和密码访问Cloud SQL数据库。只需提供可选的user和password参数给MySQLEngine.from_instance()：

  • 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嵌入模型。 你可能需要启用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
)

初始化一个默认的MySQLVectorStore​

要初始化一个MySQLVectorStore类，你只需要提供3样东西：

  1. engine - 一个 MySQLEngine 引擎的实例。
  2. embedding_service - LangChain嵌入模型的一个实例。
  3. 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向量索引的信息。

注意： 对于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()

高级用法​

使用自定义元数据创建MySQLVectorStore​

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

创建一个表和一个带有自定义元数据列的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})]

这个页面有帮助吗？