Google Firestore （本机模式）
Firestore 是一种面向文档的无服务器数据库，可扩展以满足任何需求。扩展您的数据库应用程序，以利用 Firestore 的 Langchain 集成构建 AI 驱动的体验。
本笔记本介绍了如何使用 Firestore 保存、加载和删除 langchain 文档FirestoreLoader和FirestoreSaver.
在 GitHub 上了解有关该软件包的更多信息。
准备工作
要运行此笔记本，您需要执行以下作：
在此笔记本的运行时环境中确认对数据库的访问后，填写以下值并在运行示例脚本之前运行单元格。
# @markdown Please specify a source for demo purpose.
SOURCE = "test" # @param {type:"Query"|"CollectionGroup"|"DocumentReference"|"string"}
🦜🔗 库安装
集成存在于自己的langchain-google-firestore包中，因此我们需要安装它。
%pip install -upgrade --quiet langchain-google-firestore
仅限 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()
基本用法
保存文档
FirestoreSaver可以将文档存储到 Firestore 中。默认情况下，它将尝试从元数据中提取 Document 引用
保存 langchain 文档FirestoreSaver.upsert_documents(<documents>).
from langchain_core.documents import Document
from langchain_google_firestore import FirestoreSaver
saver = FirestoreSaver()
data = [Document(page_content="Hello, World!")]
saver.upsert_documents(data)
保存文档而不进行引用
如果指定了集合，则文档将使用自动生成的 ID 进行存储。
saver = FirestoreSaver("Collection")
saver.upsert_documents(data)
保存包含其他引用的文档
doc_ids = ["AnotherCollection/doc_id", "foo/bar"]
saver = FirestoreSaver()
saver.upsert_documents(documents=data, document_ids=doc_ids)
从 Collection 或 SubCollection 加载
加载 langchain 文档FirestoreLoader.load()或Firestore.lazy_load().lazy_load返回一个生成器，该生成器在迭代期间仅查询 database。初始化FirestoreLoader类：
source- Query、CollectionGroup、DocumentReference 的实例或 Firestore 集合的单个分隔路径。\
from langchain_google_firestore import FirestoreLoader
loader_collection = FirestoreLoader("Collection")
loader_subcollection = FirestoreLoader("Collection/doc/SubCollection")
data_collection = loader_collection.load()
data_subcollection = loader_subcollection.load()
加载单个文档
from google.cloud import firestore
client = firestore.Client()
doc_ref = client.collection("foo").document("bar")
loader_document = FirestoreLoader(doc_ref)
data = loader_document.load()
从 CollectionGroup 或 Query 加载
from google.cloud.firestore import CollectionGroup, FieldFilter, Query
col_ref = client.collection("col_group")
collection_group = CollectionGroup(col_ref)
loader_group = FirestoreLoader(collection_group)
col_ref = client.collection("collection")
query = col_ref.where(filter=FieldFilter("region", "==", "west_coast"))
loader_query = FirestoreLoader(query)
删除文档
从 Firestore 集合中删除 langchain 文档列表FirestoreSaver.delete_documents(<documents>).
如果提供了文档 ID，则将忽略 Documents。
saver = FirestoreSaver()
saver.delete_documents(data)
# The Documents will be ignored and only the document ids will be used.
saver.delete_documents(data, doc_ids)
高级用法
使用自定义文档页面内容和元数据加载文档
的参数page_content_fields和metadata_fields将指定要写入 LangChain 文档的 Firestore 文档字段page_content和metadata.
loader = FirestoreLoader(
source="foo/bar/subcol",
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 = FirestoreLoader(
source="foo",
client=client,
)