Document AI 客户端库

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

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

安装客户端库

C++

如需详细了解此客户端库的要求和安装依赖项，请参阅设置 C++ 开发环境。

C#

Install-Package Google.Cloud.DocumentAI.V1 -Pre

如需了解详情，请参阅设置 C# 开发环境。

Go

go get cloud.google.com/go/documentai

如需了解详情，请参阅设置 Go 开发环境。

Java

如果您使用的是 Maven，请将以下代码添加到您的 pom.xml 文件中。如需详细了解 BOM，请参阅 Google Cloud Platform 库 BOM。

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>26.83.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-document-ai</artifactId>
  </dependency>
</dependencies>

如果您使用的是 Gradle，请将以下代码添加到您的依赖项中：

implementation platform('com.google.cloud:libraries-bom:26.83.0')

implementation 'com.google.cloud:google-cloud-document-ai'

如果您使用的是 sbt，请将以下代码添加到您的依赖项中：

libraryDependencies += "com.google.cloud" % "google-cloud-document-ai" % "2.98.0"

如果您使用的是 Visual Studio Code 或 IntelliJ，可以通过以下 IDE 插件将客户端库添加到您的项目中：

上述插件还提供其他功能，例如服务账号密钥管理。如需了解详情，请参阅各个插件相应的文档。

如需了解详情，请参阅设置 Java 开发环境。

Node.js

npm install @google-cloud/documentai

如需了解详情，请参阅设置 Node.js 开发环境。

PHP

composer require google/cloud-document-ai

如需了解详情，请参阅在 Google Cloud 上使用 PHP。

Python

pip install --upgrade google-cloud-documentai

如需了解详情，请参阅设置 Python 开发环境。

Ruby

gem install google-cloud-document_ai

如需了解详情，请参阅设置 Ruby 开发环境。

设置身份验证

为了对 Google Cloud API 的调用进行身份验证，客户端库支持应用默认凭证 (ADC)；这些库会在一组指定的位置查找凭证，并使用这些凭证对发送到 API 的请求进行身份验证。借助 ADC，您可以在各种环境（例如本地开发或生产环境）中为您的应用提供凭据，而无需修改应用代码。

对于生产环境，设置 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 使用的本地凭据文件中。

使用客户端库

以下示例展示了如何使用客户端库。

C++


#include "google/cloud/documentai/v1/document_processor_client.h"
#include "google/cloud/location.h"
#include <fstream>
#include <iostream>
#include <string>

int main(int argc, char* argv[]) try {
  if (argc != 5) {
    std::cerr << "Usage: " << argv[0]
              << " project-id location-id processor-id filename (PDF only)\n";
    return 1;
  }

  std::string const location_id = argv[2];
  if (location_id != "us" && location_id != "eu") {
    std::cerr << "location-id must be either 'us' or 'eu'\n";
    return 1;
  }
  auto const location = google::cloud::Location(argv[1], location_id);

  namespace documentai = ::google::cloud::documentai_v1;
  auto client = documentai