Google Bigtable
Bigtable 是一個鍵值和寬欄儲存庫,非常適合快速存取結構化、半結構化或非結構化資料。 擴展您的資料庫應用程式,利用 Bigtable 的 Langchain 整合來構建 AI 驅動的體驗。
這個筆記本介紹了如何使用 Bigtable,透過 BigtableLoader
和 BigtableSaver
儲存、載入和刪除 langchain 文件。
在 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
類別,您需要提供 2 件事
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 文件。
從資料表載入文件
使用 BigtableLoader.load()
或 BigtableLoader.lazy_load()
載入 langchain 文件。 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
刪除文件
使用 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",
)
Metadata 映射
預設情況下,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)),
),
],
)
Metadata 作為 JSON
如果 Bigtable 中有一個欄位包含您想要新增到輸出文件 metadata 的 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",
)