以编程方式使用文档

> Cloud SQL for PostgreSQL 是一项全托管数据库服务，可帮助您在 Google Cloud Platform 上设置、维护、管理和管理 PostgreSQL 关系数据库。利用 Cloud SQL for PostgreSQL 的 LangChain 集成扩展您的数据库应用程序，以构建 AI 驱动的体验。

本笔记本介绍如何使用 Cloud SQL for PostgreSQL 使用以下方式加载文档 PostgresLoader class.

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

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

准备工作

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

🦜🔗 库安装

安装集成库， langchain_google_cloud_sql_pg.

pip install -qU  langchain_google_cloud_sql_pg

仅限 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.
# @title Project { display-mode: "form" }
PROJECT_ID = "gcp_project_id"  # @param {type:"string"}

# Set the project id
! gcloud config set project {PROJECT_ID}

基本用法

设置 Cloud SQL 数据库值

在以下位置找到您的数据库变量， Cloud SQL 实例页面.

# @title Set Your Values Here { display-mode: "form" }
REGION = "us-central1"  # @param {type: "string"}
INSTANCE = "my-primary"  # @param {type: "string"}
DATABASE = "my-database"  # @param {type: "string"}
TABLE_NAME = "vector_store"  # @param {type: "string"}

Cloud SQL 引擎

将 PostgreSQL 配置为文档加载器的必要参数之一是 PostgresEngine 对象。 PostgresEngine 为您的 Cloud SQL for PostgreSQL 数据库配置连接池，使您的应用程序能够成功连接，并遵循行业最佳实践。

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

  1. project_id ：Cloud SQL 实例所在的 Google Cloud 项目的项目 ID。
  2. region ：Cloud SQL 实例所在的区域。
  3. instance ：Cloud SQL 实例的名称。
  4. database 要连接到 Cloud SQL 实例上的数据库名称。

默认情况下， IAM 数据库身份验证 将用作数据库身份验证方法。此库使用属于 应用默认凭证 (ADC) 的 IAM 主体，该凭证从环境中获取。

可选地， 内置数据库身份验证 也可以使用用户名和密码来访问 Cloud SQL 数据库。只需提供可选的 user 和 password 参数给 PostgresEngine.from_instance():

  • * user 用于内置数据库身份验证和登录的数据库用户
  • * password 用于内置数据库身份验证和登录的数据库密码。

注意本教程演示了异步接口。所有异步方法都有对应的同步方法。

from langchain_google_cloud_sql_pg import PostgresEngine

engine = await PostgresEngine.afrom_instance(
    project_id=PROJECT_ID,
    region=REGION,
    instance=INSTANCE,
    database=DATABASE,
)

创建 PostgresLoader

from langchain_google_cloud_sql_pg import PostgresLoader

# Creating a basic PostgreSQL object
loader = await PostgresLoader.create(engine, table_name=TABLE_NAME)

通过默认表加载文档

加载器返回表中 Documents 的列表，使用第一列作为页面_内容，其他所有列作为元数据。默认表的第一列是 页面_内容，第二列是元数据 (JSON)。每一行对应一个文档。请注意，如果您希望文档具有 id，则需要自行添加。

from langchain_google_cloud_sql_pg import PostgresLoader

# Creating a basic PostgresLoader object
loader = await PostgresLoader.create(engine, table_name=TABLE_NAME)

docs = await loader.aload()
print(docs)

Load documents via custom table/metadata or custom page content columns

loader = await PostgresLoader.create(
    engine,
    table_name=TABLE_NAME,
    content_columns=["product_name"],  # Optional
    metadata_columns=["id"],  # Optional
)
docs = await loader.aload()
print(docs)

设置页面内容格式

加载器返回 Documents 列表，每行一个文档，页面内容为指定的字符串格式，即文本（空格分隔的连接）、JSON、YAML、CSV 等。JSON 和 YAML 格式包含表头，而文本和 CSV 不包含字段表头。

loader = await PostgresLoader.create(
    engine,
    table_name="products",
    content_columns=["product_name", "description"],
    format="YAML",
)
docs = await loader.aload()
print(docs)