Skip to main content
Open In ColabOpen on GitHub

Google SQL for MySQL

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

本笔记本介绍如何使用Google Cloud SQL for MySQL与MySQLChatMessageHistory类来存储聊天消息历史。

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

在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。
  • 查看支持页面：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}

💡 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.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数据库。只需提供可选的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
)

初始化一个表格​

MySQLChatMessageHistory 类需要一个具有特定模式的数据库表来存储聊天消息历史。

MySQLEngine 引擎有一个辅助方法 init_chat_history_table()，可以用来为你创建一个具有适当模式的表。

engine.init_chat_history_table(table_name=TABLE_NAME)

MySQL聊天消息历史​

要初始化MySQLChatMessageHistory类，你只需要提供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.')

这个页面有帮助吗？