跳到主要内容
Cloud SQL 是一种完全托管的关系型数据库服务,提供高性能、无缝集成和出色的可伸缩性。它提供 PostgreSQL、MySQL 和 SQL Server 数据库引擎。通过利用 Cloud SQL 的 LangChain 集成,扩展您的数据库应用程序以构建 AI 驱动的体验。
本笔记本介绍了如何使用 Cloud SQL for MySQL 通过 MySQLVectorStore 类存储向量嵌入。 GitHub 上了解有关该包的更多信息。 在 Colab 中打开

开始之前

要运行此 notebook,您需要执行以下操作

🦜🔗 库安装

安装集成库 langchain-google-cloud-sql-mysql 和嵌入服务库 langchain-google-vertexai
pip install -qU 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)

🔐 身份验证

以登录到此 notebook 的 IAM 用户身份向 Google Cloud 进行身份验证,以访问您的 Google Cloud 项目。
  • 如果您正在使用 Colab 运行此 notebook,请使用下面的单元格并继续。
  • 如果您正在使用 Vertex AI Workbench,请查看此处的设置说明。
from google.colab import auth

auth.authenticate_user()

☁ 设置您的 Google Cloud 项目

设置您的 Google Cloud 项目,以便您可以在此 notebook 中利用 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 向量支持仅在 MySQL 版本 >= 8.0.36 的实例上可用。 对于现有实例,您可能需要执行自助维护更新,将维护版本更新为 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"}

MySQL 引擎连接池

将 Cloud SQL 建立为向量存储的其中一个要求和参数是 MySQLEngine 对象。MySQLEngine 为您的 Cloud SQL 数据库配置连接池,从而实现您的应用程序的成功连接并遵循行业最佳实践。 要使用 MySQLEngine.from_instance() 创建 MySQLEngine,您只需提供 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 数据库。只需向 MySQLEngine.from_instance() 提供可选的 userpassword 参数。
  • 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})]

以编程方式连接这些文档到 Claude、VSCode 等,通过 MCP 获取实时答案。
© . This site is unofficial and not affiliated with LangChain, Inc.