Google Firestore 在 Datastore 模式下
Datastore 模式下的 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()
基本用法
保存文档
使用 DatastoreSaver.upsert_documents(<documents>)
保存 LangChain 文档。默认情况下,它将尝试从文档元数据中的 key
提取实体键。
<!--IMPORTS:[{"imported": "Document", "source": "langchain_core.documents", "docs": "https://python.langchain.com/api_reference/core/documents/langchain_core.documents.base.Document.html", "title": "Google Firestore in Datastore Mode"}]-->
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()
通过查询加载文档
除了从种类加载文档外,我们还可以选择从查询加载文档。例如:
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>)
从数据存储中删除一系列 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,
)