Google Cloud SQL for SQL Server 集成 - 以编程方式使用文档

> Cloud SQL 是一项完全托管的关系型数据库服务，提供高性能、无缝集成和出色的可扩展性。它提供 MySQL, PostgreSQL和 SQL Server 数据库引擎。通过 Cloud SQL 的 LangChain 集成扩展您的数据库应用程序，以构建 AI 驱动的体验。

本笔记本介绍如何使用 Cloud SQL for SQL Server to 保存、加载和删除 LangChain 文档与 MSSQLLoader 和 MSSQLDocumentSaver.

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

![在 Colab 中打开](https://colab.research.google.com/github/googleapis/langchain-google-cloud-sql-mssql-python/blob/main/docs/document_loader.ipynb)

准备工作

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

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

# @markdown Please fill in the both the Google Cloud region and name of your Cloud SQL instance.
REGION = "us-central1"  # @param {type:"string"}
INSTANCE = "test-instance"  # @param {type:"string"}

# @markdown Please fill in user name and password of your Cloud SQL instance.
DB_USER = "sqlserver"  # @param {type:"string"}
DB_PASS = "password"  # @param {type:"string"}

# @markdown Please specify a database and a table for demo purpose.
DATABASE = "test"  # @param {type:"string"}
TABLE_NAME = "test-default"  # @param {type:"string"}

🦜🔗 库安装

该集成位于其自己的 langchain-google-cloud-sql-mssql 包中，因此我们需要安装它。

pip install -qU langchain-google-cloud-sql-mssql

仅限 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)

🔐 身份验证

以登录本笔记本的 IAM 用户身份向 Google Cloud 进行身份验证，以便访问您的 Google Cloud 项目。

* 如果您使用 Colab 运行本笔记本，请使用下面的单元格并继续。
* 如果您使用 Vertex AI Workbench，请查看 Vertex AI Workbench 设置说明.

from google.colab import auth

auth.authenticate_user()

☁ 设置您的 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}

💡 启用 API

该 langchain-google-cloud-sql-mssql 包要求您启用 Cloud SQL Admin API 在您的 Google Cloud 项目中。

# enable Cloud SQL Admin API
!gcloud services enable sqladmin.googleapis.com

基本用法

MSSQLEngine 连接池

在从 MSSQL 表保存或加载文档之前，我们首先需要配置一个到 Cloud SQL 数据库的连接池。 MSSQLEngine 配置一个 SQLAlchemy 连接池到您的 Cloud SQL 数据库，使您的应用程序能够成功连接并遵循行业最佳实践。

要创建一个 MSSQLEngine 使用 MSSQLEngine.from_instance() 您只需提供 4 项内容：

project_id ：Cloud SQL 实例所在的 Google Cloud Project 的项目 ID。
region ：Cloud SQL 实例所在的区域。
instance ：Cloud SQL 实例的名称。
database ：要连接到 Cloud SQL 实例上的数据库名称。
user ：用于内置数据库身份验证和登录的数据库用户。
password ：用于内置数据库身份验证和登录的数据库密码。

from langchain_google_cloud_sql_mssql import MSSQLEngine

engine = MSSQLEngine.from_instance(
    project_id=PROJECT_ID,
    region=REGION,
    instance=INSTANCE,
    database=DATABASE,
    user=DB_USER,
    password=DB_PASS,
)

初始化表

通过以下方式初始化默认模式的表 MSSQLEngine.init_document_table(<table_name>)。表列：

* page_content (类型: text)
* langchain_metadata (类型: JSON)

overwrite_existing=True 标志表示新初始化的表将替换任何同名的现有表。

engine.init_document_table(TABLE_NAME, overwrite_existing=True)

保存文档

使用以下方式保存 langchain 文档 MSSQLDocumentSaver.add_documents(<documents>)。要初始化 MSSQLDocumentSaver 类，您需要提供 2 项内容：

engine - 一个 MSSQLEngine engine.
table_name - Cloud SQL 数据库中用于存储 langchain 文档的表名。

from langchain_core.documents import Document
from langchain_google_cloud_sql_mssql import MSSQLDocumentSaver

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 = MSSQLDocumentSaver(engine=engine, table_name=TABLE_NAME)
saver.add_documents(test_docs)

加载文档

使用以下方式加载 langchain 文档 MSSQLLoader.load() or MSSQLLoader.lazy_load(). lazy_load 返回一个生成器，仅在迭代时查询数据库。要初始化 MSSQLDocumentSaver 类，您需要提供：

engine - 一个 MSSQLEngine engine.
table_name - Cloud SQL 数据库中用于存储 langchain 文档的表名。

from langchain_google_cloud_sql_mssql import MSSQLLoader

loader = MSSQLLoader(engine=engine, table_name=TABLE_NAME)
docs = loader.lazy_load()
for doc in docs:
    print("Loaded documents:", doc)

通过查询加载文档

除了从表加载文档外，我们还可以选择从 SQL 查询生成的视图加载文档。例如：

from langchain_google_cloud_sql_mssql import MSSQLLoader

loader = MSSQLLoader(
    engine=engine,
    query=f"select * from \"{TABLE_NAME}\" where JSON_VALUE(langchain_metadata, '$.fruit_id') = 1;",
)
onedoc = loader.load()
onedoc

SQL 查询生成的视图可以具有与默认表不同的模式。在这种情况下，MSSQLLoader 的行为与从非默认模式的表加载相同。请参阅章节使用自定义文档页面内容和元数据加载文档.

删除文档

使用以下方式从 MSSQL 表删除 langchain 文档列表 MSSQLDocumentSaver.delete(<documents>).

对于具有默认模式的表（page_content, langchain_metadata），删除标准为：

A row 如果列表中存在一个 document ，使得

* document.page_content 等于 row[page_content]
* document.metadata 等于 row[langchain_metadata]

from langchain_google_cloud_sql_mssql import MSSQLLoader

loader = MSSQLLoader(engine=engine, table_name=TABLE_NAME)
docs = loader.load()
print("Documents before delete:", docs)
saver.delete(onedoc)
print("Documents after delete:", loader.load())

高级用法

加载具有自定义文档页面内容和元数据的文档

首先，我们准备一个具有非默认模式的示例表，并用一些任意数据填充它。

with engine.connect() as conn:
    conn.execute(sqlalchemy.text(f'DROP TABLE IF EXISTS "{TABLE_NAME}"'))
    conn.commit()
    conn.execute(
        sqlalchemy.text(
            f"""
            IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[{TABLE_NAME}]') AND type in (N'U'))
                BEGIN
                    CREATE TABLE [dbo].[{TABLE_NAME}](
                        fruit_id INT IDENTITY(1,1) PRIMARY KEY,
                        fruit_name VARCHAR(100) NOT NULL,
                        variety VARCHAR(50),
                        quantity_in_stock INT NOT NULL,
                        price_per_unit DECIMAL(6,2) NOT NULL,
                        organic BIT NOT NULL
                    )
                END
            """
        )
    )
    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),
                ('Banana', 'Cavendish', 200, 0.59, 0),
                ('Orange', 'Navel', 80, 1.29, 1);
            """
        )
    )
    conn.commit()

如果我们仍然使用默认参数从这个示例表加载 langchain 文档， MSSQLLoader 从该示例表中， page_content 加载文档的将是表格的第一列，并且 metadata 将由所有其他列的键值对组成。

loader = MSSQLLoader(
    engine=engine,
    table_name=TABLE_NAME,
)
loader.load()

我们可以通过设置来指定我们想要加载的内容和元数据 content_columns 和 metadata_columns 在初始化时 MSSQLLoader.

content_columns：要写入文档的列 page_content 的内容。
metadata_columns：要写入文档的列 metadata 的元数据。

例如，在本例中，列中的值 content_columns 将被连接成一个用空格分隔的字符串，作为 page_content 加载文档的内容，并且 metadata 加载文档的元数据将仅包含中指定的列的键值对 metadata_columns.

loader = MSSQLLoader(
    engine=engine,
    table_name=TABLE_NAME,
    content_columns=[
        "variety",
        "quantity_in_stock",
        "price_per_unit",
        "organic",
    ],
    metadata_columns=["fruit_id", "fruit_name"],
)
loader.load()

保存具有自定义页面内容和元数据的文档

为了将 langchain 文档保存到具有自定义元数据字段的表中，我们需要首先通过 MSSQLEngine.init_document_table()创建这样的表，并指定我们想要的 metadata_columns 列表。在这个示例中，创建的表将具有以下表列：

* description（类型：text）：用于存储水果描述。
* fruit_name（类型：text）：用于存储水果名称。
* organic（类型：tinyint(1)）：用于标识水果是否有机。
* other_metadata（类型：JSON）：用于存储水果的其他元数据信息。

我们可以使用以下参数与 MSSQLEngine.init_document_table() 一起创建表：

table_name：Cloud SQL 数据库中用于存储 langchain 文档的表名。
metadata_columns：一个 sqlalchemy.Column 列表，指示我们需要元数据列的列表。
content_column：存储 page_content 的列名 langchain 文档。默认值： page_content.
metadata_json_column：存储额外 metadata 的 JSON 列名 langchain 文档。默认值： langchain_metadata.

engine.init_document_table(
    TABLE_NAME,
    metadata_columns=[
        sqlalchemy.Column(
            "fruit_name",
            sqlalchemy.UnicodeText,
            primary_key=False,
            nullable=True,
        ),
        sqlalchemy.Column(
            "organic",
            sqlalchemy.Boolean,
            primary_key=False,
            nullable=True,
        ),
    ],
    content_column="description",
    metadata_json_column="other_metadata",
    overwrite_existing=True,
)

保存文档 MSSQLDocumentSaver.add_documents(<documents>)。正如您在本例中看到的，

* document.page_content 将被保存到 description column.
* document.metadata.fruit_name 将被保存到 fruit_name column.
* document.metadata.organic 将被保存到 organic column.
* document.metadata.fruit_id 将被保存到 other_metadata 列，格式为 JSON。

test_docs = [
    Document(
        page_content="Granny Smith 150 0.99",
        metadata={"fruit_id": 1, "fruit_name": "Apple", "organic": 1},
    ),
]
saver = MSSQLDocumentSaver(
    engine=engine,
    table_name=TABLE_NAME,
    content_column="description",
    metadata_json_column="other_metadata",
)
saver.add_documents(test_docs)

with engine.connect() as conn:
    result = conn.execute(sqlalchemy.text(f'select * from "{TABLE_NAME}";'))
    print(result.keys())
    print(result.fetchall())

删除具有自定义页面内容和元数据的文档

我们还可以通过 MSSQLDocumentSaver.delete(<documents>)从具有自定义元数据列的表中删除文档。删除条件是：

A row 如果列表中存在一个 document ，使得

* document.page_content 等于 row[page_content]
* 对于每个元数据字段 k in document.metadata
* document.metadata[k] 等于 row[k] or document.metadata[k] 等于 row[langchain_metadata][k]
* 不存在额外的元数据字段出现在 row 但不在 document.metadata.

loader = MSSQLLoader(engine=engine, table_name=TABLE_NAME)
docs = loader.load()
print("Documents before delete:", docs)
saver.delete(docs)
print("Documents after delete:", loader.load())