Google Bigtable

Bigtable 是一种键-值和宽列存储，非常适合快速访问结构化、半结构化或非结构化数据。通过 Bigtable 的 Langchain 集成，可以扩展数据库应用程序以构建利用人工智能的体验。

这个笔记本介绍了如何使用 Bigtable 来使用 BigtableLoader 和 BigtableSaver 保存、加载和删除 langchain 文档。

在 GitHub 上了解更多关于该包的信息。

开始之前

要运行这个笔记本，您需要完成以下步骤：

• 创建一个 Google Cloud 项目

• 启用 Bigtable API

• 创建一个 Bigtable 实例

• 创建一个 Bigtable 表

• 创建 Bigtable 访问凭据

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

# @markdown 请为演示目的指定一个实例和一个表。
INSTANCE_ID = "my_instance"  # @param {type:"string"}
TABLE_ID = "my_table"  # @param {type:"string"}

🦜🔗 安装库

这个集成位于自己的 langchain-google-bigtable 包中，所以我们需要安装它。

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

仅适用于 Colab：取消下面的单元格的注释以重新启动内核，或者使用顶部的按钮重新启动内核。对于 Vertex AI Workbench，您可以使用顶部的按钮重新启动终端。

# # 自动安装后重新启动内核，以便您的环境可以访问新的包
# 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 请在下面的值中填写您的 Google Cloud 项目 ID，然后运行单元格。
PROJECT_ID = "my-project-id"  # @param {type:"string"}
# 设置项目 ID
!gcloud config set project {PROJECT_ID}

🔐 认证

作为在这个笔记本中登录的 IAM 用户，对 Google Cloud 进行身份验证，以便访问您的 Google Cloud 项目。

• 如果您使用 Colab 运行这个笔记本，请使用下面的单元格并继续。

• 如果您使用 Vertex AI Workbench，请查看这里的设置说明。

from google.colab import auth
auth.authenticate_user()

基本用法

使用 Saver

使用 BigtableSaver.add_documents(<documents>) 保存 langchain 文档。要初始化 BigtableSaver 类，您需要提供两个东西：

1. instance_id - Bigtable 的一个实例。

2. table_id - Bigtable 中存储 langchain 文档的表的名称。

from langchain_core.documents import Document
from langchain_google_bigtable import BigtableSaver
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 = BigtableSaver(
    instance_id=INSTANCE_ID,
    table_id=TABLE_ID,
)
saver.add_documents(test_docs)

从 Bigtable 查询文档

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

从表中加载文档

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

1. instance_id - Bigtable 的一个实例。

2. table_id - Bigtable 中存储 langchain 文档的表的名称。

from langchain_google_bigtable import BigtableLoader
loader = BigtableLoader(
    instance_id=INSTANCE_ID,
    table_id=TABLE_ID,
)
for doc in loader.lazy_load():
    print(doc)
    break

删除文档

使用 BigtableSaver.delete(<documents>) 从 Bigtable 表中删除一组 langchain 文档。

from langchain_google_bigtable import BigtableSaver
docs = loader.load()
print("删除前的文档: ", docs)
onedoc = test_docs[0]
saver.delete([onedoc])
print("删除后的文档: ", loader.load())

高级用法

限制返回的行数

有两种限制返回行数的方法：

1. 使用 filter

2. 使用 row_set

import google.cloud.bigtable.row_filters as row_filters
filter_loader = BigtableLoader(
    INSTANCE_ID, TABLE_ID, filter=row_filters.ColumnQualifierRegexFilter(b"os_build")
)
from google.cloud.bigtable.row_set import RowSet
row_set = RowSet()
row_set.add_row_range_from_keys(
    start_key="phone#4c410523#20190501", end_key="phone#4c410523#201906201"
)
row_set_loader = BigtableLoader(
    INSTANCE_ID,
    TABLE_ID,
    row_set=row_set,
)

自定义客户端

默认情况下创建的客户端是默认客户端，仅使用 admin=True 选项。要使用非默认客户端，可以将 自定义客户端 传递给构造函数。

from google.cloud import bigtable
custom_client_loader = BigtableLoader(
    INSTANCE_ID,
    TABLE_ID,
    client=bigtable.Client(...),
)

自定义内容

BigtableLoader 假定有一个名为 langchain 的列族，其中有一个名为 content 的列，其中包含使用 UTF-8 编码的值。可以像下面这样更改这些默认设置：

from langchain_google_bigtable import Encoding
custom_content_loader = BigtableLoader(
    INSTANCE_ID,
    TABLE_ID,
    content_encoding=Encoding.ASCII,
    content_column_family="my_content_family",
    content_column_name="my_content_column_name",
)

元数据映射

默认情况下，Document 对象上的 metadata 映射将包含一个键 rowkey，其值为行的行键值。要向该映射添加更多项目，请使用 metadata_mapping。

import json
from langchain_google_bigtable import MetadataMapping
metadata_mapping_loader = BigtableLoader(
    INSTANCE_ID,
    TABLE_ID,
    metadata_mappings=[
        MetadataMapping(
            column_family="my_int_family",
            column_name="my_int_column",
            metadata_key="key_in_metadata_map",
            encoding=Encoding.INT_BIG_ENDIAN,
        ),
        MetadataMapping(
            column_family="my_custom_family",
            column_name="my_custom_column",
            metadata_key="custom_key",
            encoding=Encoding.CUSTOM,
            custom_decoding_func=lambda input: json.loads(input.decode()),
            custom_encoding_func=lambda input: str.encode(json.dumps(input)),
        ),
    ],
)

将元数据作为 JSON

如果 Bigtable 中有一个包含 JSON 字符串的列，您希望将其添加到输出文档的元数据中，可以将以下参数添加到 BigtableLoader。注意，默认值为 metadata_as_json_encoding 是 UTF-8。

metadata_as_json_loader = BigtableLoader(
    INSTANCE_ID,
    TABLE_ID,
    metadata_as_json_encoding=Encoding.ASCII,
    metadata_as_json_family="my_metadata_as_json_family",
    metadata_as_json_name="my_metadata_as_json_column_name",
)

自定义 BigtableSaver

BigtableSaver 也可以像 BigtableLoader 一样进行自定义设置。

saver = BigtableSaver(
    INSTANCE_ID,
    TABLE_ID,
    client=bigtable.Client(...),
    content_encoding=Encoding.ASCII,
    content_column_family="my_content_family",
    content_column_name="my_content_column_name",
    metadata_mappings=[
        MetadataMapping(
            column_family="my_int_family",
            column_name="my_int_column",
            metadata_key="key_in_metadata_map",
            encoding=Encoding.INT_BIG_ENDIAN,
        ),
        MetadataMapping(
            column_family="my_custom_family",
            column_name="my_custom_column",
            metadata_key="custom_key",
            encoding=Encoding.CUSTOM,
            custom_decoding_func=lambda input: json.loads(input.decode()),
            custom_encoding_func=lambda input: str.encode(json.dumps(input)),
        ),
    ],
    metadata_as_json_encoding=Encoding.ASCII,
    metadata_as_json_family="my_metadata_as_json_family",
    metadata_as_json_name="my_metadata_as_json_column_name",
)