Google Firestore in Datastore Mode
Firestore in Datastore Mode 是一个为自动扩展、高性能和简化应用开发而构建的NoSQL文档数据库。扩展您的数据库应用程序，利用Datastore的Langchain集成构建AI驱动的体验。
本笔记本介绍如何使用Datastore模式下的Firestore来保存、加载和删除langchain文档，使用DatastoreLoader和DatastoreSaver。
了解更多关于该包的信息，请访问GitHub。
开始之前
要运行此笔记本，您需要执行以下操作：
在确认可以访问此笔记本运行时环境中的数据库后，填写以下值并在运行示例脚本之前运行单元格。
🦜🔗 库安装
集成位于其自己的langchain-google-datastore包中，因此我们需要安装它。
%pip install -upgrade --quiet langchain-google-datastore
仅限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()
基本用法
保存文档
使用DatastoreSaver.upsert_documents(保存langchain文档。默认情况下，它会尝试从文档元数据中的key提取实体键。
from langchain_core.documents import Document
from langchain_google_datastore import DatastoreSaver
saver = DatastoreSaver()
data = [Document(page_content="Hello, World!")]
saver.upsert_documents(data)
保存没有键的文档
如果指定了kind，文档将以自动生成的ID存储。
saver = DatastoreSaver("MyKind")
saver.upsert_documents(data)
通过Kind加载文档
使用DatastoreLoader.load()或DatastoreLoader.lazy_load()加载langchain文档。lazy_load返回一个生成器，仅在迭代期间查询数据库。要初始化DatastoreLoader类，您需要提供：
source- 用于加载文档的源。它可以是Query的实例或要读取的Datastore种类的名称。
from langchain_google_datastore import DatastoreLoader
loader = DatastoreLoader("MyKind")
data = loader.load()
通过查询加载文档
除了从kind加载文档外，我们还可以选择从查询加载文档。例如：
from google.cloud import datastore
client = datastore.Client(database="non-default-db", namespace="custom_namespace")
query_load = client.query(kind="MyKind")
query_load.add_filter("region", "=", "west_coast")
loader_document = DatastoreLoader(query_load)
data = loader_document.load()
删除文档
使用DatastoreSaver.delete_documents(从Datastore中删除一系列langchain文档。
saver = DatastoreSaver()
saver.delete_documents(data)
keys_to_delete = [
["Kind1", "identifier"],
["Kind2", 123],
["Kind3", "identifier", "NestedKind", 456],
]
# The Documents will be ignored and only the document ids will be used.
saver.delete_documents(data, keys_to_delete)
高级用法
加载带有自定义文档页面内容和元数据的文档
page_content_properties 和 metadata_properties 的参数将指定要写入 LangChain 文档 page_content 和 metadata 的实体属性。
loader = DatastoreLoader(
source="MyKind",
page_content_fields=["data_field"],
metadata_fields=["metadata_field"],
)
data = loader.load()
自定义页面内容格式
当page_content只包含一个字段时，信息将仅为字段值。否则，page_content将以JSON格式呈现。
自定义连接和认证
from google.auth import compute_engine
from google.cloud.firestore import Client
client = Client(database="non-default-db", creds=compute_engine.Credentials())
loader = DatastoreLoader(
source="foo",
client=client,
)