Google Firestore (Datastore 模式)

Google Cloud Firestore in Datastore 是一个无服务器的面向文档的数据库，可以扩展以满足任何需求。扩展您的数据库应用程序，以构建利用 Datastore 的 Langchain 集成的 AI 驱动体验。

本笔记本介绍了如何使用 Google Cloud Firestore in Datastore 通过 DatastoreChatMessageHistory 类存储聊天消息历史记录。

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

开始之前

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

• 创建一个 Google Cloud 项目
• 启用 Datastore API
• 创建一个 Datastore 数据库

在确认可以访问此笔记本的运行时环境中的数据库后，填写以下值并在运行示例脚本之前运行单元格。

🦜🔗 库安装

该集成位于其自己的 langchain-google-datastore 软件包中，因此我们需要安装它。

%pip install -upgrade --quiet langchain-google-datastore

Colab only：取消注释以下单元格以重启内核，或使用按钮重启内核。对于 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)

☁ 设置您的 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}

🔐 身份验证

以登录到此笔记本的 IAM 用户身份验证到 Google Cloud，以便访问您的 Google Cloud 项目。

• 如果您使用 Colab 运行此笔记本，请使用下面的单元格并继续。
• 如果您使用 Vertex AI Workbench，请查看 此处 的设置说明。

from google.colab import auth

auth.authenticate_user()

API 启用

langchain-google-datastore 软件包要求您在您的 Google Cloud 项目中启用 Datastore API。

# enable Datastore API
!gcloud services enable datastore.googleapis.com

基本用法

DatastoreChatMessageHistory

要初始化 DatastoreChatMessageHistory 类，您只需要提供 3 件事

1. session_id - 一个唯一的标识符字符串，用于指定会话的 ID。
2. kind - 要写入的 Datastore 种类名称。这是一个可选值，默认情况下，它将使用 ChatHistory 作为种类。
3. collection - 指向 Datastore 集合的单个 / 分隔路径。

from langchain_google_datastore import DatastoreChatMessageHistory

chat_history = DatastoreChatMessageHistory(
    session_id="user-session-id", collection="HistoryMessages"
)

chat_history.add_user_message("Hi!")
chat_history.add_ai_message("How can I help you?")

chat_history.messages

清理

当特定会话的历史记录过时并且可以从数据库和内存中删除时，可以按以下方式完成。

注意： 删除后，数据将不再存储在 Datastore 中，并且将永远消失。

chat_history.clear()

自定义客户端

客户端默认使用可用的环境变量创建。自定义客户端可以传递给构造函数。

from google.auth import compute_engine
from google.cloud import datastore

client = datastore.Client(
    project="project-custom",
    database="non-default-database",
    credentials=compute_engine.Credentials(),
)

history = DatastoreChatMessageHistory(
    session_id="session-id", collection="History", client=client
)

history.add_user_message("New message")

history.messages

history.clear()