Google Cloud SQL for PostgreSQL

Cloud SQL for PostgreSQL is a fully-managed database service that helps you set up, maintain, manage, and administer your PostgreSQL relational databases on Google Cloud Platform. Extend your database application to build AI-powered experiences leveraging Cloud SQL for PostgreSQL's Langchain integrations.

本笔记本介绍了如何使用 Cloud SQL for PostgreSQL 通过 PostgresLoader 类加载文档。

在 GitHub 上了解更多关于该包的信息。

开始之前

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

🦜🔗 库安装

安装集成库，langchain_google_cloud_sql_pg。

%pip install --upgrade --quiet  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，请查看设置说明此处。

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.from_instance() 创建一个 PostgresEngine，您只需提供 4 件事：

project_id : 部署 Cloud SQL 实例的 Google Cloud 项目的项目 ID。
region : Cloud SQL 实例所在的区域。
instance : Cloud SQL 实例的名称。
database : 要连接的 Cloud SQL 实例上的数据库名称。

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

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

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)

文档加载器概念指南
文档加载器操操作指南

开始之前​

🦜🔗 库安装​

🔐 身份验证

☁ 设置您的 Google Cloud 项目​

基本用法​