Google Firestore (原生模式)
Firestore 是一个无服务器的、面向文档的数据库，可以扩展以满足任何需求。扩展你的数据库应用程序，利用 Firestore 的 Langchain 集成构建人工智能驱动的体验。
这个笔记本介绍了如何使用 Firestore 通过 FirestoreLoader 和 FirestoreSaver 保存、加载和删除 langchain 文档。
在 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 中。默认情况下，它会尝试从元数据中提取文档引用。
使用 FirestoreSaver.upsert_documents(<documents>) 保存 langchain 文档。
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)
从集合或子集合加载
使用 FirestoreLoader.load() 或 Firestore.lazy_load() 加载 langchain 文档。 lazy_load 返回一个生成器，该生成器仅在迭代期间查询数据库。要初始化 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)
删除文档
使用 FirestoreSaver.delete_documents(<documents>) 从 Firestore 集合中删除 langchain 文档列表。
如果提供了文档 ID，则将忽略文档。
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 文档 page_content 和 metadata 的 Firestore 文档字段。
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,
)