Google SQL for SQL Server

Google Cloud SQL 是一項全受管關聯式資料庫服務，可提供高效能、無縫整合和令人印象深刻的可擴展性。它提供 MySQL、PostgreSQL 和 SQL Server 資料庫引擎。擴展您的資料庫應用程式，利用 Cloud SQL 的 Langchain 整合來建構 AI 驅動的體驗。

本筆記本介紹如何使用 Google Cloud SQL for SQL Server，透過 MSSQLChatMessageHistory 類別儲存聊天訊息歷史記錄。

在 GitHub 上了解更多關於此套件的資訊。

開始之前

若要執行此筆記本，您需要執行以下操作

• 建立 Google Cloud 專案
• 啟用 Cloud SQL Admin API。
• 建立 Cloud SQL for SQL Server 執行個體
• 建立 Cloud SQL 資料庫
• 建立資料庫使用者（如果您選擇使用 sqlserver 使用者，則為選填）

🦜🔗 程式庫安裝

此整合存在於其自身的 langchain-google-cloud-sql-mssql 套件中，因此我們需要安裝它。

%pip install --upgrade --quiet langchain-google-cloud-sql-mssql 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-mssql 套件要求您在您的 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-mssql-instance"  # @param {type: "string"}
DATABASE = "my-database"  # @param {type: "string"}
DB_USER = "my-username"  # @param {type: "string"}
DB_PASS = "my-password"  # @param {type: "string"}
TABLE_NAME = "message_store"  # @param {type: "string"}

MSSQLEngine 連線集區

將 Cloud SQL 建立為 ChatMessageHistory 記憶體儲存區的要求和引數之一是 MSSQLEngine 物件。 MSSQLEngine 會設定到您的 Cloud SQL 資料庫的連線集區，從而實現從您的應用程式成功連線，並遵循業界最佳實務。

若要使用 MSSQLEngine.from_instance() 建立 MSSQLEngine，您只需要提供 6 個項目

1. project_id：Cloud SQL 執行個體所在的 Google Cloud 專案的專案 ID。
2. region：Cloud SQL 執行個體所在的區域。
3. instance：Cloud SQL 執行個體的名稱。
4. database：要連線到 Cloud SQL 執行個體上的資料庫的名稱。
5. user：用於內建資料庫身份驗證和登入的資料庫使用者。
6. password：用於內建資料庫身份驗證和登入的資料庫密碼。

預設情況下，使用使用者名稱和密碼存取 Cloud SQL 資料庫的內建資料庫身份驗證用於資料庫身份驗證。

from langchain_google_cloud_sql_mssql import MSSQLEngine

engine = MSSQLEngine.from_instance(
    project_id=PROJECT_ID,
    region=REGION,
    instance=INSTANCE,
    database=DATABASE,
    user=DB_USER,
    password=DB_PASS,
)

初始化表格

MSSQLChatMessageHistory 類別需要具有特定結構描述的資料庫表格，才能儲存聊天訊息歷史記錄。

MSSQLEngine 引擎有一個輔助方法 init_chat_history_table()，可用於為您建立具有正確結構描述的表格。

engine.init_chat_history_table(table_name=TABLE_NAME)

MSSQLChatMessageHistory

若要初始化 MSSQLChatMessageHistory 類別，您只需要提供 3 個項目

1. engine - MSSQLEngine 引擎的執行個體。
2. session_id - 一個唯一的識別字串，用於指定會話的 ID。
3. table_name：Cloud SQL 資料庫中用於儲存聊天訊息歷史記錄的表格名稱。

from langchain_google_cloud_sql_mssql import MSSQLChatMessageHistory

history = MSSQLChatMessageHistory(
    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

API 參考：ChatPromptTemplate | MessagesPlaceholder | RunnableWithMessageHistory | 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: MSSQLChatMessageHistory(
        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.')