Skip to main content
Cloud SQL for PostgreSQL 是一项全托管的数据库服务,帮助您在 Google Cloud Platform 上设置、维护、管理和管理 PostgreSQL 关系型数据库。通过 Cloud SQL for PostgreSQL 的 LangChain 集成,扩展您的数据库应用,构建 AI 驱动的体验。
本 notebook 介绍如何使用 Cloud SQL for PostgreSQL 通过 PostgresLoader 类加载文档。 GitHub 上了解更多关于该软件包的信息。 Open In Colab

开始之前

要运行本 notebook,您需要完成以下准备工作:

🦜🔗 安装库

安装集成库 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)

🔐 身份验证

以登录本 notebook 的 IAM 用户身份向 Google Cloud 进行身份验证,以访问您的 Google Cloud 项目。
  • 如果您在 Colab 中运行本 notebook,请使用下方单元格并继续。
  • 如果您在 Vertex AI Workbench 中运行,请参阅此处的设置说明。
from google.colab import auth

auth.authenticate_user()

☁ 设置 Google Cloud 项目

设置您的 Google Cloud 项目,以便在本 notebook 中使用 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.from_instance() 创建 PostgresEngine 时,您只需提供以下 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 数据库。只需向 PostgresEngine.from_instance() 提供可选参数 userpassword
  • 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)

通过默认表加载文档

加载器以列表形式返回表中的文档,使用第一列作为 page_content,其余所有列作为元数据。默认表将使用第一列作为 page_content,第二列作为元数据(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)

通过自定义表/元数据或自定义页面内容列加载文档

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

设置页面内容格式

加载器返回文档列表,每行一个文档,页面内容以指定字符串格式呈现,例如文本(空格分隔的拼接)、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)