Google El Carro 用于 Oracle 工作负载

Google El Car罗拉Oracle Operator offers a way to run Oracle databases in Kubernetes as a portable, open source, community driven, no vendor lock-in container orchestration system. El Car罗拉 provides a powerful declarative API for comprehensive and consistent configuration and deployment as well as for real-time operations and monitoring. Extend your Oracle database's capabilities to build AI-powered experiences by leveraging the El Car罗拉 Langchain integration.

此指南将介绍如何使用 El Carro Langchain 整合来 通过 1 和 2 保存、加载和删除 Langchain 文档 。此整合适用于任何 Oracle 数据库，无论其运行位置。

Learn more about the package on GitHub.

开始之前​

请完成 README 中的Getting Started部分以设置您的El Carro Oracle数据库。

🦜🔗 库安装

The integration lives in its own langchain-google-el-carro package, so we need to install it.

%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 创建的用户密码。

Example Ouput:

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(<table_name>)。表列：

• page_content (type: text)
• langchain_metadata (type: JSON)

elcarro_engine.drop_document_table(TABLE_NAME)
elcarro_engine.init_document_table(
    table_name=TABLE_NAME,
)

保存文档​

保存langchain文档需要使用ElCarroDocumentSaver.add_documents(<documents>)。 为了初始化ElCarroDocumentSaver类，你需要提供2个东西：

1. elcarro_engine - 一个ElCarroEngine引擎的实例。
2. 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])

API 参考:文档

加载文档

使用 ElCarroLoader.load() 或 ElCarroLoader.lazy_load() 加载 langchain 文档。lazy_load 返回一个生成器，在迭代过程中仅在查询数据库时进行查询。要初始化 ElCarroLoader 类，您需要提供:

1. elcarro_engine - 一个ElCarroEngine引擎的实例。
2. 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)

The view generated from SQL query can have different schema than default table. In such cases, the behavior of ElCarroLoader is the same as loading from table with non-default schema. Please refer to section Load documents with customized document page content & metadata.

删除文档

删除Oracle表中的一组langchain文档，使用ElCarroDocumentSaver.delete(<documents>)。

对于具有默认模式（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 来指定要加载的内容和元数据。

1. content_columns: 将列写入到page_content文档中。
2. 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列表。在这个例子中，创建的表格将具有以下列：

• content (type: text): 用于存储水果描述。
• type (type VARCHAR2(200)): 用于存储水果类型。
• weight (type INT): 用于存储水果重量。
• extra_json_metadata (类型: JSON): 用于存储有关水果的其他元数据信息。

可以使用以下参数 与 elcarro_engine.init_document_table() 创建表格:

1. table_name: 在Oracle数据库中存储langchain文档的表格名称。
2. metadata_columns: 一个由sqlalchemy.Column组成的列表，表示我们需要的元数据列。
3. content_column: 存储LangChain文档的列名。默认值："page_content", "VARCHAR2(4000)"
4. metadata_json_column: 列名称以存储额外的 JSON metadata 语言链文档。 默认值："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(<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(<documents>)从表中删除带有自定义元数据列的文档。删除标准如下：

如果列表中存在一个 document，则应删除 row

• document.page_content 等于 row[page_content]
• 对于每个元数据字段k在document.metadata
  • 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 以获取完整的代码示例。

相关

• 文档加载器 概念指南
• 文档加载器 使用指南