Skip to main content
Open In Colab在 GitHub 上打开

适用于 MySQL 的 Google Cloud SQL

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

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

在 GitHub 上了解有关该软件包的更多信息。

Open In 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.
  • 请参阅支持页面：查找项目 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 标志设置为 “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 项内容：

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

默认情况下，将使用 IAM 数据库身份验证作为数据库身份验证的方法。此库使用属于源自环境的应用程序默认凭证 （ADC） 的 IAM 委托人。

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

（可选）也可以使用使用用户名和密码访问 Cloud SQL 数据库的内置数据库身份验证。只需提供可选的user和passwordarguments 设置为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
)

初始化表

这MySQLVectorStoreclass 需要数据库表。这MySQLEngineclass 具有 helper 方法init_vectorstore_table()，可用于创建具有适合您的架构的表。

engine.init_vectorstore_table(
    table_name=TABLE_NAME,
    vector_size=768,  # Vector size for VertexAI model(textembedding-gecko@latest)
)

创建 embedding 类实例

您可以使用任何 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
)
API 参考：VertexAIEmbeddings

初始化默认 MySQLVectorStore

要初始化MySQLVectorStoreclass 你只需要提供 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})]