Google Firestore (原生模式)
Google Cloud Firestore 是一个无服务器的文档导向数据库,能够根据需求进行扩展。扩展您的数据库应用程序,以利用
Firestore
的 Langchain 集成构建 AI 驱动的体验。
本笔记本介绍了如何使用 Google Cloud Firestore 来存储聊天消息历史记录,使用 FirestoreChatMessageHistory
类。
在 GitHub 上了解更多关于该包的信息。
开始之前
要运行此笔记本,您需要执行以下操作:
在确认在此笔记本的运行时环境中访问数据库后,请填写以下值并在运行示例脚本之前运行该单元格。
🦜🔗 库安装
集成位于其自己的 langchain-google-firestore
包中,因此我们需要安装它。
%pip install -upgrade --quiet langchain-google-firestore
仅限 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)
☁ 设置您的 Google Cloud 项目
设置您的 Google Cloud 项目,以便您可以在此笔记本中利用 Google Cloud 资源。
如果您不知道您的项目 ID,请尝试以下方法:
- 运行
gcloud config list
。 - 运行
gcloud projects list
。 - 查看支持页面:查找项目 ID。
# @markdown 请在下面填写您的 Google Cloud 项目 ID,然后运行该单元格。
PROJECT_ID = "my-project-id" # @param {type:"string"}
# 设置项目 ID
!gcloud config set project {PROJECT_ID}
🔐 身份验证
作为已登录此笔记本的 IAM 用户对 Google Cloud 进行身份验证,以访问您的 Google Cloud 项目。
- 如果您正在使用 Colab 运行此笔记本,请使用下面的单元格并继续。
- 如果您正在使用 Vertex AI Workbench,请查看 这里 的设置说明。
from google.colab import auth
auth.authenticate_user()
基本用法
FirestoreChatMessageHistory
要初始化 FirestoreChatMessageHistory
类,您只需提供 3 个参数:
session_id
- 一个唯一标识符字符串,用于指定会话的 ID。collection
: 指向 Firestore 集合的单个/
分隔路径。
from langchain_google_firestore import FirestoreChatMessageHistory
chat_history = FirestoreChatMessageHistory(
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
清理
当特定会话的历史记录过时并可以从数据库和内存中删除时,可以通过以下方式完成。
注意: 一旦删除,数据将不再存储在 Firestore 中,并永久丢失。
chat_history.clear()
自定义客户端
客户端默认使用可用的环境变量创建。可以将自定义客户端传递给构造函数。
from google.auth import compute_engine
from google.cloud import firestore
client = firestore.Client(
project="project-custom",
database="non-default-database",
credentials=compute_engine.Credentials(),
)
history = FirestoreChatMessageHistory(
session_id="session-id", collection="History", client=client
)
history.add_user_message("New message")
history.messages
history.clear()