Skip to main content
Open In Colab在 GitHub 上打开

适用于 PostgreSQL 的 Google Cloud SQL

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

此笔记本介绍了如何使用Cloud SQL for PostgreSQL以使用PostgresLoader类。

在 GitHub 上了解有关该软件包的更多信息。

Open In Colab

准备工作

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

🦜🔗 库安装

安装集成库，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"}

云 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和passwordarguments 设置为PostgresEngine.from_instance():

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

注意：本教程演示了异步接口。所有 async 方法都有相应的 sync 方法。

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 列表，使用第一列作为 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、etc. JSON 和 YAML 格式包含标题，而文本和 CSV 不包括字段标题。

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