以编程方式使用文档

> AlloyDB 是一个完全托管的关系型数据库服务，提供高性能、无缝集成和令人印象深刻的可扩展性。AlloyDB 与 PostgreSQL 100% 兼容。通过 AlloyDB 的 LangChain 集成扩展您的数据库应用程序，以构建 AI 驱动的体验。

本笔记本介绍如何使用 AlloyDB for PostgreSQL 通过以下方式加载文档 AlloyDBLoader class.

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

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

准备工作

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

🦜🔗 库安装

安装集成库， langchain-google-alloydb-pg.

pip install -qU  langchain-google-alloydb-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}

基本用法

设置 AlloyDB 数据库变量

在以下位置找到您的数据库值， AlloyDB 实例页面.

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

AlloyDBEngine 连接池

将 AlloyDB 建立为向量存储的要求和参数之一是 AlloyDBEngine 对象。 AlloyDBEngine 配置到您的 AlloyDB 数据库的连接池，使您的应用程序能够成功连接并遵循行业最佳实践。

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

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

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

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

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

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

from langchain_google_alloydb_pg import AlloyDBEngine

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

创建 AlloyDBLoader

from langchain_google_alloydb_pg import AlloyDBLoader

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

通过默认表加载文档

加载器从表中返回一个文档列表，使用第一列作为页面_内容，所有其他列作为元数据。默认表的结构是第一列作为 页面_内容，第二列作为元数据（JSON）。每一行变成一个文档。

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

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

loader = await AlloyDBLoader.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 = AlloyDBLoader.create(
    engine,
    table_name="products",
    content_columns=["product_name", "description"],
    format="YAML",
)
docs = await loader.aload()
print(docs)