Datastore 模式下的 Google Firestore
Firestore 在 Datastore 模式中 是一个 NoSQL 文档数据库，专为自动扩展、高性能和简化应用程序开发而构建。扩展您的数据库应用程序以构建 AI 驱动的体验，利用 Datastore 的 Langchain 集成。
此笔记本介绍了如何使用 Firestore 在 Datastore 模式中 保存、加载和删除 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。 - 查看支持页面：查找项目 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(<documents>) 保存 langchain 文档。默认情况下，它将尝试从 Document 元数据中的 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 kind 的名称。
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(<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 Document page_content 和 metadata 的 Entity 属性。
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,
)