数据存储模式下的 Google Firestore
数据存储模式下的 Firestore 是一个 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. - 请参阅支持页面：查找项目 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()
基本用法
保存文档
保存 langchain 文档DatastoreSaver.upsert_documents(<documents>).默认情况下，它将尝试从key在 Document 元数据中。
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 加载文档
加载 langchain 文档DatastoreLoader.load()或DatastoreLoader.lazy_load().lazy_load返回一个生成器，该生成器在迭代期间仅查询 database。初始化DatastoreLoader类：
source- 用于加载文档的源。它可以是 Query 的实例，也可以是要从中读取的 Datastore 类型的名称。
from langchain_google_datastore import DatastoreLoader
loader = DatastoreLoader("MyKind")
data = loader.load()
通过查询加载文档
除了从 kind 加载文档外，我们还可以选择从 query 加载文档。例如：
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()
删除文档
从 Datastore 中删除 langchain 文档列表DatastoreSaver.delete_documents(<documents>).
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 的 Entity 属性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,
)