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

适用于 MySQL 的 Google SQL

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

此笔记本介绍了如何使用Google Cloud SQL for MySQL要使用MySQLChatMessageHistory类。

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

Open In Colab

准备工作

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

🦜🔗 库安装

集成存在于自己的langchain-google-cloud-sql-mysql包中，因此我们需要安装它。

%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}

💡 API 支持

这langchain-google-cloud-sql-mysql软件包要求您在 Google Cloud 项目中启用 Cloud SQL Admin API。

# enable Cloud SQL Admin API
!gcloud services enable sqladmin.googleapis.com

基本用法

设置 Cloud SQL 数据库值

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

# @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 = "message_store"  # @param {type: "string"}

MySQLEngine 连接池

将 Cloud SQL 建立为 ChatMessageHistory 内存存储的要求和参数之一是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
)

初始化表

这MySQLChatMessageHistoryclass 需要一个具有特定架构的 Database Table 来存储聊天消息历史记录。

这MySQLEngineengine 具有 helper 方法init_chat_history_table()，可用于创建具有适合您的架构的表。

engine.init_chat_history_table(table_name=TABLE_NAME)

MySQLChatMessage历史记录

要初始化MySQLChatMessageHistoryclass 你只需要提供 3 件事：

  1. engine- 一个MySQLEngine发动机。
  2. session_id- 一个唯一标识符字符串，用于指定会话的 ID。
  3. table_name：Cloud SQL 数据库中用于存储聊天消息历史记录的表的名称。
from langchain_google_cloud_sql_mysql import MySQLChatMessageHistory

history = MySQLChatMessageHistory(
    engine, session_id="test_session", table_name=TABLE_NAME
)
history.add_user_message("hi!")
history.add_ai_message("whats up?")
history.messages
[HumanMessage(content='hi!'), AIMessage(content='whats up?')]

清理

当特定会话的历史记录过时并且可以删除时，可以按以下方式完成。

注意：删除后，数据将不再存储在 Cloud SQL 中，而是永远消失。

history.clear()

🔗 链接

我们可以轻松地将此消息历史类与 LCEL Runnables 结合使用

为此，我们将使用 Google 的 Vertex AI 聊天模型之一，该模型要求您在 Google Cloud 项目中启用 Vertex AI API。

# enable Vertex AI API
!gcloud services enable aiplatform.googleapis.com
from langchain_core.prompts import ChatPromptTemplate, MessagesPlaceholder
from langchain_core.runnables.history import RunnableWithMessageHistory
from langchain_google_vertexai import ChatVertexAI
prompt = ChatPromptTemplate.from_messages(
    [
        ("system", "You are a helpful assistant."),
        MessagesPlaceholder(variable_name="history"),
        ("human", "{question}"),
    ]
)

chain = prompt | ChatVertexAI(project=PROJECT_ID)
chain_with_history = RunnableWithMessageHistory(
    chain,
    lambda session_id: MySQLChatMessageHistory(
        engine,
        session_id=session_id,
        table_name=TABLE_NAME,
    ),
    input_messages_key="question",
    history_messages_key="history",
)
# This is where we configure the session id
config = {"configurable": {"session_id": "test_session"}}
chain_with_history.invoke({"question": "Hi! I'm bob"}, config=config)
AIMessage(content=' Hello Bob, how can I help you today?')
chain_with_history.invoke({"question": "Whats my name"}, config=config)
AIMessage(content=' Your name is Bob.')