Google Bigtable
Bigtable 是一个键值和宽列存储，非常适合快速访问结构化、半结构化或非结构化数据。 利用 Bigtable 的 Langchain 集成，扩展您的数据库应用程序以构建 AI 驱动的体验。
本笔记本介绍如何使用 Bigtable 来 保存、加载和删除 langchain 文档，方法是使用 BigtableLoader 和 BigtableSaver。
在 GitHub 上了解有关该包的更多信息。
开始之前
要运行此笔记本，您需要执行以下操作
在确认了此笔记本运行时环境中对数据库的访问权限后，填写以下值并在运行示例脚本之前运行该单元格。
# @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，请查看设置说明 此处。
from google.colab import auth
auth.authenticate_user()
基本用法
使用保存器
使用 BigtableSaver.add_documents(<documents>) 保存 langchain 文档。 要初始化 BigtableSaver 类，您需要提供两件事
instance_id- Bigtable 的一个实例。table_id- 要存储 langchain 文档的 Bigtable 中的表的名称。
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 类，您需要提供
instance_id- Bigtable 的一个实例。table_id- 要存储 langchain 文档的 Bigtable 中的表的名称。
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("Documents before delete: ", docs)
onedoc = test_docs[0]
saver.delete([onedoc])
print("Documents after delete: ", loader.load())
高级用法
限制返回的行
有两种方法可以限制返回的行
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",
)