Google Firestore (原生模式)
Google Cloud Firestore 是一个无服务器的面向文档的数据库,可以根据需求进行扩展。利用
Firestore's
的 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
。 - 查看支持页面: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}
🔐 认证
以登录此笔记本的IAM用户身份验证到Google Cloud,以便访问您的Google Cloud项目。
- 如果您正在使用Colab运行此笔记本,请使用下面的单元格并继续。
- 如果您正在使用Vertex AI Workbench,请查看这里的设置说明。
from google.colab import auth
auth.authenticate_user()
基本用法
Firestore聊天消息历史
要初始化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()