Document AI Toolbox 客户端库

本页面介绍了如何开始使用 Document AI 工具箱 API 的 Cloud 客户端库。通过客户端库，您可以更轻松地使用支持的语言访问 Google Cloud API。虽然您可以通过向服务器发出原始请求来直接使用Google Cloud API，但客户端库可实现简化，从而显著减少您需要编写的代码量。

请参阅客户端库说明，详细了解 Cloud 客户端库 和旧版 Google API 客户端库。

安装客户端库

pip install --upgrade google-cloud-documentai-toolbox

设置身份验证

对于生产环境，设置 ADC 的方式取决于服务和上下文。如需了解详情，请参阅设置应用默认凭证。

对于本地开发环境，您可以使用与您的 Google 账号关联的凭据设置 ADC：

1. 安装 Google Cloud CLI。 安装完成后， 初始化 Google Cloud CLI，方法是运行以下命令：

   gcloud init

   如果您使用的是外部身份提供方 (IdP)，则必须先 使用联合身份登录 gcloud CLI。

2. 如果您使用的是本地 shell，请为您的用户 账号创建本地身份验证凭证：

   gcloud auth application-default login

   如果您使用的是 Cloud Shell，则无需执行此操作。

   如果返回了身份验证错误，并且您使用的是外部身份提供方 (IdP)，请确认您已 使用联合身份登录 gcloud CLI。

   登录屏幕随即出现。在您登录后，您的凭据会存储在 ADC 使用的本地凭据文件中。

使用客户端库

Document AI 工具箱是一个适用于 Python 的 SDK，它提供实用 函数来管理、操控文档响应以及从中提取信息。 它会从 Cloud Storage 中的 JSON 文件、本地 JSON 文件或直接从 process_document() 方法输出的处理后的文档响应创建“封装”文档对象。

它可以执行以下操作：

• 将批处理中的零散 Document JSON 文件合并为单个“封装”文档。
• 将分片导出为统一的 Document。
• 从以下位置获取 Document 输出：
  • Cloud Storage
  • BatchProcessMetadata
  • Operation 名称
• 从 Pages、Lines、Paragraphs、FormFields 和 Tables 访问文本，而无需处理 Layout 信息。
• 搜索包含目标字符串或与正则表达式匹配的 Pages。
• 按名称搜索 FormFields。
• 按类型搜索 Entities。
• 将 Tables 转换为 Pandas Dataframe 或 CSV。
• 将 Entities 和 FormFields 插入 BigQuery 表。
• 根据拆分器/分类器处理器的输出拆分 PDF 文件。
• 从 Document 边界框提取图片 Entities。
• 在常用格式之间转换 Documents：
  • Cloud Vision API AnnotateFileResponse
  • hOCR
  • 第三方文档处理格式
• 从 Cloud Storage 文件夹创建批处理文档以进行处理。

代码示例

以下代码示例演示了如何使用 Document AI 工具箱。

from typing import Optional

from google.cloud import documentai
from google.cloud.documentai_toolbox import document, gcs_utilities

# TODO(developer): Uncomment these variables before running the sample.
# Given a Document JSON or sharded Document JSON in path gs://bucket/path/to/folder
# gcs_bucket_name = "bucket"
# gcs_prefix = "path/to/folder"

# Or, given a Document JSON in path gs://bucket/path/to/folder/document.json
# gcs_uri = "gs://bucket/path/to/folder/document.json"

# Or, given a Document JSON in path local/path/to/folder/document.json
# document_path = "local/path/to/folder/document.json"

# Or, given a Document object from Document AI
# documentai_document = documentai.Document()

# Or, given a BatchProcessMetadata object from Document AI
# operation = client.batch_process_documents(request)
# operation.result(timeout=timeout)
# batch_process_metadata = documentai.BatchProcessMetadata(operation.metadata)

# Or, given a BatchProcessOperation name from Document AI
# batch_process_operation = "projects/project_id/locations/location/operations/operation_id"


def quickstart_sample(
    gcs_bucket_name: Optional[str] = None,
    gcs_prefix: Optional[str] = None,
    gcs_uri: Optional[str] = None,
    document_path: Optional[str] = None,
    documentai_document: Optional[documentai.Document] = None,
    batch_process_metadata: Optional[documentai.