Google AlloyDB for PostgreSQL

Google Cloud AlloyDB for PostgreSQL is a fully managed PostgreSQL compatible database service for your most demanding enterprise workloads. AlloyDB combines the best of Google Cloud with PostgreSQL, for superior performance, scale, and availability. Extend your database application to build AI-powered experiences leveraging AlloyDB Langchain integrations.

本笔记本介绍了如何使用 Google Cloud AlloyDB for PostgreSQL 与 AlloyDBChatMessageHistory 类来存储聊天消息历史记录。

在 GitHub 上了解更多关于该包的信息。

开始之前

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

🦜🔗 库安装

该集成位于其独立的 langchain-google-alloydb-pg 包中，因此我们需要安装它。

%pip install --upgrade --quiet langchain-google-alloydb-pg 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-alloydb-pg 包需要您在 Google Cloud 项目中启用 AlloyDB 管理 API。

# enable AlloyDB API
!gcloud services enable alloydb.googleapis.com

基本用法

设置 AlloyDB 数据库值

在 AlloyDB 群集页面中查找您的数据库值。

# @title Set Your Values Here { display-mode: "form" }
REGION = "us-central1"  # @param {type: "string"}
CLUSTER = "my-alloydb-cluster"  # @param {type: "string"}
INSTANCE = "my-alloydb-instance"  # @param {type: "string"}
DATABASE = "my-database"  # @param {type: "string"}
TABLE_NAME = "message_store"  # @param {type: "string"}

AlloyDBEngine 连接池

建立 AlloyDB 作为 ChatMessageHistory 内存存储的一个要求和参数是 AlloyDBEngine 对象。AlloyDBEngine 配置了与您的 AlloyDB 数据库的连接池，使您的应用程序能够成功连接，并遵循行业最佳实践。

要使用 AlloyDBEngine.from_instance() 创建一个 AlloyDBEngine，您只需提供 5 件事：

project_id : 托管 AlloyDB 实例的 Google Cloud 项目的项目 ID。
region : AlloyDB 实例所在的区域。
cluster: AlloyDB 集群的名称。
instance : AlloyDB 实例的名称。
database : 要连接的 AlloyDB 实例上的数据库名称。

默认情况下，将使用IAM 数据库身份验证作为数据库身份验证方法。此库使用属于从环境获取的应用默认凭据 (ADC)的 IAM 主体。

或者，也可以使用用户名和密码进行内置数据库身份验证来访问 AlloyDB 数据库。只需向AlloyDBEngine.from_instance()提供可选的user和password参数：

user : 用于内置数据库认证和登录的数据库用户
password : 用于内置数据库认证和登录的数据库密码。

from langchain_google_alloydb_pg import AlloyDBEngine

engine = AlloyDBEngine.from_instance(
    project_id=PROJECT_ID,
    region=REGION,
    cluster=CLUSTER,
    instance=INSTANCE,
    database=DATABASE,
)

初始化表格

AlloyDBChatMessageHistory 类需要一个具有特定模式的数据库表，以便存储聊天消息历史记录。

AlloyDBEngine 引擎有一个辅助方法 init_chat_history_table()，可以用来为您创建具有正确模式的表格。

engine.init_chat_history_table(table_name=TABLE_NAME)

AlloyDBChatMessageHistory

要初始化 AlloyDBChatMessageHistory 类，您只需要提供以下三项内容：

engine - 一个 AlloyDBEngine 引擎的实例。
session_id - 一个唯一的标识符字符串，用于指定会话的ID。
table_name : AlloyDB 数据库中用于存储聊天消息历史的表的名称。

from langchain_google_alloydb_pg import AlloyDBChatMessageHistory

history = AlloyDBChatMessageHistory.create_sync(
    engine, session_id="test_session", table_name=TABLE_NAME
)
history.add_user_message("hi!")
history.add_ai_message("whats up?")

history.messages

正在清理

当特定会话的历史记录已过时且可以删除时，可以通过以下方式进行。

注意： 一旦删除，数据将不再存储在 AlloyDB 中，并且将永久丢失。

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: AlloyDBChatMessageHistory.create_sync(
        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)

chain_with_history.invoke({"question": "Whats my name"}, config=config)

开始之前​

🦜🔗 库安装​

🔐 身份验证

☁ 设置您的 Google Cloud 项目​

💡 API 启用​

基本用法​

设置 AlloyDB 数据库值​

AlloyDBEngine 连接池​

初始化表格​

AlloyDBChatMessageHistory​

正在清理​

🔗 链式调用​