Google El Carro for Oracle 工作负载
Google El Carro Oracle Operator 提供了一种在Kubernetes中运行Oracle数据库的方式,作为一个可移植的、开源的、社区驱动的、无供应商锁定的容器编排系统。El Carro 提供了一个强大的声明式API,用于全面和一致的配置和部署,以及实时操作和监控。 通过利用El Carro Langchain集成,扩展您的Oracle数据库功能,以构建由AI驱动的体验。
本指南介绍了如何使用El Carro Langchain集成来
保存、加载和删除langchain文档
使用ElCarroLoader
和ElCarroDocumentSaver
。此集成适用于任何Oracle数据库,无论其运行在何处。
了解更多关于该包的信息,请访问GitHub。
开始之前
请完成 Getting Started 部分以设置您的El Carro Oracle数据库。
🦜🔗 库安装
集成位于其自己的langchain-google-el-carro
包中,因此我们需要安装它。
%pip install --upgrade --quiet langchain-google-el-carro
基本用法
设置Oracle数据库连接
填写以下变量以提供您的Oracle数据库连接详细信息。
# @title Set Your Values Here { display-mode: "form" }
HOST = "127.0.0.1" # @param {type: "string"}
PORT = 3307 # @param {type: "integer"}
DATABASE = "my-database" # @param {type: "string"}
TABLE_NAME = "message_store" # @param {type: "string"}
USER = "my-user" # @param {type: "string"}
PASSWORD = input("Please provide a password to be used for the database user: ")
如果您正在使用El Carro,您可以在El Carro Kubernetes实例的状态中找到主机名和端口值。使用您为PDB创建的用户密码。
示例输出:
kubectl get -w instances.oracle.db.anthosapis.com -n db
NAME DB ENGINE VERSION EDITION ENDPOINT URL DB NAMES BACKUP ID READYSTATUS READYREASON DBREADYSTATUS DBREADYREASON
mydb Oracle 18c Express mydb-svc.db 34.71.69.25:6021 ['pdbname'] TRUE CreateComplete True CreateComplete
ElCarroEngine 连接池
ElCarroEngine
配置了一个连接到您的 Oracle 数据库的连接池,使您的应用程序能够成功连接并遵循行业最佳实践。
from langchain_google_el_carro import ElCarroEngine
elcarro_engine = ElCarroEngine.from_instance(
db_host=HOST,
db_port=PORT,
db_name=DATABASE,
db_user=USER,
db_password=PASSWORD,
)
初始化一个表格
通过elcarro_engine.init_document_table(
初始化默认模式的表。表列:
- 页面内容(类型:文本)
- langchain_metadata (类型: JSON)
elcarro_engine.drop_document_table(TABLE_NAME)
elcarro_engine.init_document_table(
table_name=TABLE_NAME,
)
保存文档
使用ElCarroDocumentSaver.add_documents(
保存langchain文档。
要初始化ElCarroDocumentSaver
类,你需要提供两样东西:
elcarro_engine
-ElCarroEngine
引擎的一个实例。table_name
- 在Oracle数据库中存储langchain文档的表的名称。
from langchain_core.documents import Document
from langchain_google_el_carro import ElCarroDocumentSaver
doc = Document(
page_content="Banana",
metadata={"type": "fruit", "weight": 100, "organic": 1},
)
saver = ElCarroDocumentSaver(
elcarro_engine=elcarro_engine,
table_name=TABLE_NAME,
)
saver.add_documents([doc])
加载文档
使用ElCarroLoader.load()
或ElCarroLoader.lazy_load()
加载langchain文档。
lazy_load
返回一个生成器,仅在迭代期间查询数据库。
要初始化ElCarroLoader
类,您需要提供:
elcarro_engine
-ElCarroEngine
引擎的一个实例。table_name
- 在Oracle数据库中存储langchain文档的表的名称。
from langchain_google_el_carro import ElCarroLoader
loader = ElCarroLoader(elcarro_engine=elcarro_engine, table_name=TABLE_NAME)
docs = loader.lazy_load()
for doc in docs:
print("Loaded documents:", doc)
通过查询加载文档
除了从表中加载文档外,我们还可以选择从通过SQL查询生成的视图中加载文档。例如:
from langchain_google_el_carro import ElCarroLoader
loader = ElCarroLoader(
elcarro_engine=elcarro_engine,
query=f"SELECT * FROM {TABLE_NAME} WHERE json_value(langchain_metadata, '$.organic') = '1'",
)
onedoc = loader.load()
print(onedoc)
从SQL查询生成的视图可以具有与默认表不同的模式。 在这种情况下,ElCarroLoader的行为与从具有非默认模式的表中加载的行为相同。请参阅 部分使用自定义文档页面内容和元数据加载文档。
删除文档
从Oracle表中删除一系列langchain文档
使用ElCarroDocumentSaver.delete(
。
对于具有默认模式(page_content, langchain_metadata)的表,删除条件为:
如果列表中存在一个document
,则应删除row
,使得
document.page_content
等于row[page_content]
document.metadata
等于row[langchain_metadata]
docs = loader.load()
print("Documents before delete:", docs)
saver.delete(onedoc)
print("Documents after delete:", loader.load())
高级用法
加载带有自定义文档页面内容和元数据的文档
首先我们准备一个具有非默认模式的示例表,并用一些任意数据填充它。
import sqlalchemy
create_table_query = f"""CREATE TABLE {TABLE_NAME} (
fruit_id NUMBER GENERATED BY DEFAULT AS IDENTITY (START WITH 1),
fruit_name VARCHAR2(100) NOT NULL,
variety VARCHAR2(50),
quantity_in_stock NUMBER(10) NOT NULL,
price_per_unit NUMBER(6,2) NOT NULL,
organic NUMBER(3) NOT NULL
)"""
elcarro_engine.drop_document_table(TABLE_NAME)
with elcarro_engine.connect() as conn:
conn.execute(sqlalchemy.text(create_table_query))
conn.commit()
conn.execute(
sqlalchemy.text(
f"""
INSERT INTO {TABLE_NAME} (fruit_name, variety, quantity_in_stock, price_per_unit, organic)
VALUES ('Apple', 'Granny Smith', 150, 0.99, 1)
"""
)
)
conn.execute(
sqlalchemy.text(
f"""
INSERT INTO {TABLE_NAME} (fruit_name, variety, quantity_in_stock, price_per_unit, organic)
VALUES ('Banana', 'Cavendish', 200, 0.59, 0)
"""
)
)
conn.execute(
sqlalchemy.text(
f"""
INSERT INTO {TABLE_NAME} (fruit_name, variety, quantity_in_stock, price_per_unit, organic)
VALUES ('Orange', 'Navel', 80, 1.29, 1)
"""
)
)
conn.commit()
如果我们仍然使用ElCarroLoader
的默认参数从这个示例表中加载langchain文档,加载文档的page_content
将是表的第一列,而metadata
将包含所有其他列的键值对。
loader = ElCarroLoader(
elcarro_engine=elcarro_engine,
table_name=TABLE_NAME,
)
loaded_docs = loader.load()
print(f"Loaded Documents: [{loaded_docs}]")
我们可以通过在初始化ElCarroLoader
时设置content_columns
和metadata_columns
来指定我们想要加载的内容和元数据。
content_columns
: 要写入文档page_content
的列。metadata_columns
: 要写入文档metadata
的列。
例如在这里,content_columns
中的列值将被连接成一个以空格分隔的字符串,作为加载文档的page_content
,而加载文档的metadata
将仅包含在metadata_columns
中指定的列的键值对。
loader = ElCarroLoader(
elcarro_engine=elcarro_engine,
table_name=TABLE_NAME,
content_columns=[
"variety",
"quantity_in_stock",
"price_per_unit",
"organic",
],
metadata_columns=["fruit_id", "fruit_name"],
)
loaded_docs = loader.load()
print(f"Loaded Documents: [{loaded_docs}]")
保存带有自定义页面内容和元数据的文档
为了将langchain文档保存到具有自定义元数据字段的表中,我们首先需要通过ElCarroEngine.init_document_table()
创建这样的表,并指定我们想要的metadata_columns
列表。在这个例子中,创建的表将具有以下表列:
- 内容(类型:文本):用于存储水果描述。
- type (type VARCHAR2(200)): 用于存储水果类型。
- weight (类型 INT): 用于存储水果的重量。
- extra_json_metadata (类型: JSON): 用于存储水果的其他元数据信息。
我们可以使用以下参数
与 elcarro_engine.init_document_table()
来创建表:
table_name
: Oracle数据库中用于存储langchain文档的表的名称。metadata_columns
: 一个sqlalchemy.Column
的列表,表示我们需要的元数据列列表。content_column
: 用于存储langchain文档page_content
的列名。默认值:"page_content", "VARCHAR2(4000)"
metadata_json_column
: 用于存储langchain文档额外JSONmetadata
的列名。 默认值:"langchain_metadata", "VARCHAR2(4000)"
.
elcarro_engine.drop_document_table(TABLE_NAME)
elcarro_engine.init_document_table(
table_name=TABLE_NAME,
metadata_columns=[
sqlalchemy.Column("type", sqlalchemy.dialects.oracle.VARCHAR2(200)),
sqlalchemy.Column("weight", sqlalchemy.INT),
],
content_column="content",
metadata_json_column="extra_json_metadata",
)
使用ElCarroDocumentSaver.add_documents(
保存文档。正如你在这个例子中看到的,
document.page_content
将被保存到content
列中。document.metadata.type
将被保存到type
列中。document.metadata.weight
将被保存到weight
列中。document.metadata.organic
将被保存到extra_json_metadata
列中,以 JSON 格式。
doc = Document(
page_content="Banana",
metadata={"type": "fruit", "weight": 100, "organic": 1},
)
print(f"Original Document: [{doc}]")
saver = ElCarroDocumentSaver(
elcarro_engine=elcarro_engine,
table_name=TABLE_NAME,
content_column="content",
metadata_json_column="extra_json_metadata",
)
saver.add_documents([doc])
loader = ElCarroLoader(
elcarro_engine=elcarro_engine,
table_name=TABLE_NAME,
content_columns=["content"],
metadata_columns=[
"type",
"weight",
],
metadata_json_column="extra_json_metadata",
)
loaded_docs = loader.load()
print(f"Loaded Document: [{loaded_docs[0]}]")
删除带有自定义页面内容和元数据的文档
我们也可以通过ElCarroDocumentSaver.delete(
从具有自定义元数据列的表中删除文档。删除条件是:
如果列表中存在一个document
,则应删除row
,使得
document.page_content
等于row[page_content]
- 对于
document.metadata
中的每个元数据字段k
document.metadata[k]
等于row[k]
或document.metadata[k]
等于row[langchain_metadata][k]
row
中没有额外的元数据字段,但在document.metadata
中也没有。
loader = ElCarroLoader(elcarro_engine=elcarro_engine, table_name=TABLE_NAME)
saver.delete(loader.load())
print(f"Documents left: {len(loader.load())}")
更多示例
请查看 demo_doc_loader_basic.py 和 demo_doc_loader_advanced.py 以获取完整的代码示例。