Skip to main content
Open In ColabOpen on GitHub

Google Bigtable

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

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

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

在Colab中打开

开始之前​

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

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

# @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。
  • 查看支持页面：Locate the project 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()

基本用法​

使用保存器​

使用BigtableSaver.add_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)
API Reference:Document

从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

删除文档​

从Bigtable表中删除一系列langchain文档，使用BigtableSaver.delete()。

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

高级用法​

限制返回的行数​

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

  1. 使用过滤器
  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，其值为行的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",
)

这个页面有帮助吗？