谷歌扳手

Spanner 是一个高度可扩展的数据库，它将无限的可扩展性与关系语义（例如二级索引、强一致性、架构和 SQL）相结合，在一个简单的解决方案中提供 99.999% 的可用性。

本笔记本介绍了如何使用 Spanner 保存、加载和删除 langchain 文档SpannerLoader和SpannerDocumentSaver.

在 GitHub 上了解有关该软件包的更多信息。

准备工作

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

• 创建 Google Cloud 项目
• 启用 Cloud Spanner API
• 创建 Spanner 实例
• 创建 Spanner 数据库
• 创建 Spanner 表

在此笔记本的运行时环境中确认对数据库的访问后，填写以下值并在运行示例脚本之前运行单元格。

# @markdown Please specify an instance id, a database, and a table for demo purpose.
INSTANCE_ID = "test_instance"  # @param {type:"string"}
DATABASE_ID = "test_database"  # @param {type:"string"}
TABLE_NAME = "test_table"  # @param {type:"string"}

🦜🔗 库安装

集成存在于自己的langchain-google-spanner包中，因此我们需要安装它。

%pip install -upgrade --quiet langchain-google-spanner langchain

仅限 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()

基本用法

保存文档

保存 langchain 文档SpannerDocumentSaver.add_documents(<documents>).初始化SpannerDocumentSaverclass 你需要提供 3 件事：

1. instance_id- 要从中加载数据的 Spanner 实例。
2. database_id- 要从中加载数据的 Spanner 数据库实例。
3. table_name- Spanner 数据库中用于存储 langchain 文档的表的名称。

from langchain_core.documents import Document
from langchain_google_spanner import SpannerDocumentSaver

test_docs = [
    Document(
        page_content="Apple Granny Smith 150 0.99 1",
        metadata={"fruit_id": 1},
    ),
    Document(
        page_content="Banana Cavendish 200 0.59 0",
        metadata={"fruit_id": 2},
    ),
    Document(
        page_content="Orange Navel 80 1.29 1",
        metadata={"fruit_id": 3},
    ),
]

saver = SpannerDocumentSaver(
    instance_id=INSTANCE_ID,
    database_id=DATABASE_ID,
    table_name=TABLE_NAME,
)
saver.add_documents(test_docs)

API 参考：文档

从 Spanner 查询文档

有关连接到 Spanner 表的更多详细信息，请查看 Python SDK 文档。

从表中加载文档

加载 langchain 文档SpannerLoader.load()或SpannerLoader.lazy_load().lazy_load返回一个生成器，该生成器在迭代期间仅查询 database。初始化SpannerLoader类：

1. instance_id- 要从中加载数据的 Spanner 实例。
2. database_id- 要从中加载数据的 Spanner 数据库实例。
3. query- 数据库方言的查询。

from langchain_google_spanner import SpannerLoader

query = f"SELECT * from {TABLE_NAME}"
loader = SpannerLoader(
    instance_id=INSTANCE_ID,
    database_id=DATABASE_ID,
    query=query,
)

for doc in loader.lazy_load():
    print(doc)
    break

删除文档

从表中删除 langchain 文档列表SpannerDocumentSaver.delete(<documents>).

docs = loader.load()
print("Documents before delete:", docs)

doc = test_docs[0]
saver.delete([doc])
print("Documents after delete:", loader.load())

高级用法

自定义客户端

默认创建的客户端是默认客户端。传入credentials和project显式地，可以将自定义客户端传递给构造函数。

from google.cloud import spanner
from google.oauth2 import service_account

creds = service_account.Credentials.from_service_account_file("/path/to/key.json")
custom_client = spanner.Client(project="my-project", credentials=creds)
loader = SpannerLoader(
    INSTANCE_ID,
    DATABASE_ID,
    query,
    client=custom_client,
)

自定义文档页面内容和元数据

加载器将返回一个 Documents 列表，其中包含来自特定数据列的页面内容。所有其他数据列都将添加到 metadata。每行都成为一个文档。

自定义页面内容格式

SpannerLoader 假定有一个名为page_content.这些默认值可以像这样更改：

custom_content_loader = SpannerLoader(
    INSTANCE_ID, DATABASE_ID, query, content_columns=["custom_content"]
)

如果指定了多个列，则页面内容的字符串格式将默认为text（以空格分隔的字符串连接）。用户可以指定其他格式，包括text,JSON,YAML,CSV.

自定义元数据格式

SpannerLoader 假定有一个名为langchain_metadata存储 JSON 数据。metadata 列将用作基本字典。默认情况下，将添加所有其他列数据，并且可能会覆盖原始值。这些默认值可以像这样更改：

custom_metadata_loader = SpannerLoader(
    INSTANCE_ID, DATABASE_ID, query, metadata_columns=["column1", "column2"]
)

自定义 JSON 元数据列名称

默认情况下，加载程序使用langchain_metadata作为基本词典。可以自定义此列以选择 JSON 列以用作文档元数据的基本字典。

custom_metadata_json_loader = SpannerLoader(
    INSTANCE_ID, DATABASE_ID, query, metadata_json_column="another-json-column"
)

自定义过时

默认过时时间为 15 秒。这可以通过指定较弱的边界（可以是执行截至给定时间戳的所有读取）或截至过去的给定持续时间来自定义。

import datetime

timestamp = datetime.datetime.utcnow()
custom_timestamp_loader = SpannerLoader(
    INSTANCE_ID,
    DATABASE_ID,
    query,
    staleness=timestamp,
)

duration = 20.0
custom_duration_loader = SpannerLoader(
    INSTANCE_ID,
    DATABASE_ID,
    query,
    staleness=duration,
)

开启数据加速

默认情况下，加载程序不会使用数据提升，因为它会产生额外的相关成本，并且需要额外的 IAM 权限。但是，用户可以选择将其打开。

custom_databoost_loader = SpannerLoader(
    INSTANCE_ID,
    DATABASE_ID,
    query,
    databoost=True,
)

自定义客户端

默认创建的客户端是默认客户端。传入credentials和project显式地，可以将自定义客户端传递给构造函数。

from google.cloud import spanner

custom_client = spanner.Client(project="my-project", credentials=creds)
saver = SpannerDocumentSaver(
    INSTANCE_ID,
    DATABASE_ID,
    TABLE_NAME,
    client=custom_client,
)

SpannerDocumentSaver 的自定义初始化

SpannerDocumentSaver 允许自定义初始化。这允许用户指定如何将 Document 保存到表中。

content_column：这将用作文档页面内容的列名。默认为page_content.

metadata_columns：如果 Document 的元数据中存在键，则这些元数据将保存到特定列中。

metadata_json_column：这将是特定 JSON 列的列名。默认为langchain_metadata.

custom_saver = SpannerDocumentSaver(
    INSTANCE_ID,
    DATABASE_ID,
    TABLE_NAME,
    content_column="my-content",
    metadata_columns=["foo"],
    metadata_json_column="my-special-json-column",
)

初始化 Spanner 的自定义架构

SpannerDocumentSaver 将具有init_document_table创建新表来存储具有自定义 schema 的文档的方法。

from langchain_google_spanner import Column

new_table_name = "my_new_table"

SpannerDocumentSaver.init_document_table(
    INSTANCE_ID,
    DATABASE_ID,
    new_table_name,
    content_column="my-page-content",
    metadata_columns=[
        Column("category", "STRING(36)", True),
        Column("price", "FLOAT64", False),
    ],
)

相关

• Document loader 概念指南
• Document loader 操作指南