Google Firestore（数据存模式）
Firestore在数据存储模式下是一个构建于自动扩展、高性能和应用程序开发简便之上的NoSQL文档数据库。通过利用数据存储的Langchain集成，您可以扩展您的数据库应用以构建AI驱动的功能。
这个笔记本介绍了如何使用Firestore在Datastore模式下通过DatastoreLoader和DatastoreSaver来保存、加载和删除LangChain文档。
Learn more about the package on GitHub.
开始之前
要运行此笔记本，您需要执行以下操作：
在确认此笔记本运行环境中的数据库访问后，请填写以下值并运行该单元格，然后运行示例脚本。
🦜🔗 库安装
The integration lives in its own langchain-google-datastore package, so we need to install it.
%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云项目
设置您的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工作区，请参阅设置说明这里。
from google.colab import auth
auth.authenticate_user()
基本用法
保存文档
保存langchain文档使用DatastoreSaver.upsert_documents(<documents>)。默认情况下，它会尝试从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实例，或者是要从中读取数据存储类型的名称。
from langchain_google_datastore import DatastoreLoader
loader = DatastoreLoader("MyKind")
data = loader.load()
加载文档通过查询
除了从文件加载文档，我们还可以选择通过查询加载文档。例如：
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 文档 page_content 和 metadata。
loader = DatastoreLoader(
source="MyKind",
page_content_fields=["data_field"],
metadata_fields=["metadata_field"],
)
data = loader.load()
自定义页面内容格式
当`0`只包含一个字段时，信息将是该字段的值。否则，`1`将以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,
)