Google Firestore 数据存储模式集成 - 以编程方式使用文档

> Firestore 数据存储模式是一个 NoSQL 文档数据库，专为自动扩展、高性能和便捷的应用开发而构建。利用 Datastore 的 LangChain 集成扩展您的数据库应用，构建 AI 驱动的体验。

本笔记本介绍如何使用 Firestore 数据存储模式 to 保存、加载和删除 LangChain 文档与 DatastoreLoader 和 DatastoreSaver.

了解更多关于该包的信息，请访问 GitHub.

![在 Colab 中打开](https://colab.research.google.com/github/googleapis/langchain-google-datastore-python/blob/main/docs/document_loader.ipynb)

准备工作

要运行此笔记本，您需要执行以下操作：

在确认可以访问笔记本运行环境中数据库后，填写以下值并运行单元格，然后运行示例脚本。

🦜🔗 库安装

该集成位于其独立的 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，请查看 Vertex AI Workbench 设置说明.

from google.colab import auth

auth.authenticate_user()

基本用法

保存文档

使用保存 LangChain 文档 DatastoreSaver.upsert_documents(<documents>)。默认情况下，它会尝试从 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)

保存文档而不提供密钥

If a kind ，则文档将使用自动生成的 ID 进行存储。

saver = DatastoreSaver("MyKind")

saver.upsert_documents(data)

通过 kind 加载文档

使用加载 LangChain 文档 DatastoreLoader.load() or DatastoreLoader.lazy_load(). lazy_load 返回一个生成器，仅在迭代期间查询数据库。要初始化 DatastoreLoader 类，您需要提供：

source - 用于加载文档的源。它可以是 Query 的实例或要读取的 Datastore kind 的名称。

from langchain_google_datastore import DatastoreLoader

loader = DatastoreLoader("MyKind")
data = loader.load()

通过查询加载文档

除了从 kind 加载文档，我们还可以选择从查询加载文档。例如：

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,
)