Google Bigtable 集成 - 以编程方式使用文档

> Bigtable 是一种键值和宽列存储，非常适合快速访问结构化、半结构化或非结构化数据。通过 Bigtable 的 LangChain 集成扩展您的数据库应用程序，以构建由 AI 驱动的体验。

本笔记本介绍如何使用 Bigtable to 保存、加载和删除 LangChain 文档配合 BigtableLoader 和 BigtableSaver.

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

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

准备工作

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

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

# @markdown Please specify an instance and a table for demo purpose.
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，您可以使用顶部的按钮重启终端。

# # 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()

基本用法

使用保存器

使用 BigtableSaver.add_documents(<documents>)保存 LangChain 文档。要初始化 BigtableSaver 类，您需要提供以下两个内容：

instance_id - Bigtable 的一个实例。
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 文档.

从表中加载文档

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

instance_id - Bigtable 的一个实例。
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

删除文档

使用以下方式从 Bigtable 表中删除 langchain 文档列表 BigtableSaver.delete(<documents>).

from langchain_google_bigtable import BigtableSaver

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

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

高级用法

限制返回的行数

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

使用过滤器
使用行_集合

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

元数据映射

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

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 字符串的列，并且您希望将该 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",
)