クイックスタート: Document AI API を設定する

このガイドでは、Document AI の使用を開始するために必要なすべての設定手順を説明します。

Google Cloud コンソールについて

Google Cloud コンソールは、 Google Cloud プロダクトを使用するシステムのプロビジョニング、構成、管理、モニタリングに使用されるウェブ UI です。Google Cloud コンソールを使用して、Document AI リソースを設定および管理します。

プロジェクトを作成する

Google Cloudが提供するサービスを使用するには、プロジェクトを作成する必要があります。プロジェクトは、すべての Google Cloud リソースを整理し、次のコンポーネントで構成されます。

  • 共同編集者
  • 有効な API とその他のリソース
  • モニタリング ツール
  • お支払い情報
  • 認証とアクセス制御
  • Document AI プロセッサ

1 つのプロジェクトを作成することも、複数のプロジェクトを作成することもできます。プロジェクトを使用して、リソース階層内で Google Cloud リソースを整理することもできます。プロジェクトの詳細については、Resource Manager ドキュメントをご覧ください。

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

API を有効にする

プロジェクトで Document AI API を有効にする必要があります。API の有効化の詳細については、サービス使用状況のドキュメントをご覧ください。

Enable the Document AI API.

Enable the API

課金を有効にする

請求先アカウントは、特定のリソースセットに対する支払いを誰が行うかを定義します。 請求先アカウントは 1 つ以上のプロジェクトにリンクできます。プロジェクトの利用料金は、リンクされた請求先アカウントに請求されます。課金は、プロジェクトの作成時に構成します。詳細については、お支払いとご請求に関するドキュメントをご覧ください。

Make sure that billing is enabled for your Google Cloud project.

ロケーション

Document AI では、プロジェクトのリソースが保存、処理されるロケーションをある程度制御できます。特に、プロセッサを作成するときに、データを保存して処理するロケーションを選択する必要があります。デフォルトでは、Document AI は米国のロケーションにリソースを保存して処理します。欧州連合のロケーションを選択すると、データとプロセスは欧州連合にのみ保存されます。

API を使用してロケーションを設定する

API を使用して処理リクエストを送信するたびに、プロセッサのロケーションを指定する必要があります。たとえば、プロセッサが EU でデータの保存と処理を行うように構成されている場合は、次のように URI eu-documentai.googleapis.com を使用します。

Process
  • https://eu-documentai.googleapis.com/v1/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:process
  • https://eu-documentai.googleapis.com/v1beta3/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:process
batchProcess
  • https://eu-documentai.googleapis.com/v1/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:batchProcess
  • https://eu-documentai.googleapis.com/v1beta3/projects/$PROJECT_ID/locations/eu/processors/$PROCESSOR_ID:batchProcess

Document AI API クライアント ライブラリをインストールする

Document AI API を呼び出すには、次の 3 つのオプションがあります。

クライアント ライブラリは複数のよく使われている言語で利用できます。クライアント ライブラリのインストールについては、Document AI API クライアント ライブラリをご覧ください。

Google Cloud CLI をインストールして初期化する

gcloud CLI には、 Google Cloudでホストされるリソースやアプリケーションの管理に使用できる一連のツールが用意されています。

次のリンクで手順を説明します。

Install the Google Cloud CLI, then initialize it by running the following command: 

gcloud init

認証の設定

API を使用するクライアント アプリケーションはすべて、認証の対象であり、リクエストされるリソースへのアクセス権が付与されている必要があります。認証の設定方法は、ローカル開発環境で作業しているか、本番環境を設定しているのかによって異なります。詳細については、アプリケーションのデフォルト認証情報を設定するをご覧ください。

Select the tabs for how you plan to access the API:

gcloud

Install the Google Cloud CLI, then initialize it by running the following command: 

gcloud init

クライアント ライブラリ

ローカル開発環境でクライアント ライブラリを使用するには、gcloud CLI をインストールして初期化し、ユーザー認証情報を使用してアプリケーションのデフォルト認証情報を設定します。

  1. Install the Google Cloud CLI.

  2. To initialize the gcloud CLI, run the following command: 

    gcloud init

  3. If you're using a local shell, then create local authentication credentials for your user account: 

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

詳細については、 Google Cloud 認証ドキュメントの ローカル開発環境の ADC を設定するをご覧ください。

REST

ローカル開発環境で REST API を使用するには、gcloud CLI に指定した認証情報を使用します。

    Install the Google Cloud CLI, then initialize it by running the following command: 

    gcloud init

詳細については、 Google Cloud 認証ドキュメントの REST を使用して認証するをご覧ください。

本番環境での認証の設定については、 Google Cloud 認証ドキュメントの Set up Application Default Credentials for code running on Google Cloud をご覧ください。

ロールについて

API を呼び出す場合、 Google Cloud は、呼び出し側の ID（該当するユーザー、エンティティ、プロセスまたは定義済みの属性）に適切な権限があることを要求します。権限を付与するには、ユーザー アカウントまたはサービス アカウントにロールを付与します。詳細については、Identity and Access Management（IAM）のドキュメントをご覧ください。

Document AI API を試す場合、次の手順で [プロジェクト] > [オーナー] のロールを使用できます。[プロジェクト] > [オーナー] のロールを設定すると、サービス アカウントにプロジェクト内のリソースに対する完全な権限が付与されます。リクエストに完全な権限が不要な場合は、Google Cloud コンソールを使用してより制限されたロールを指定できます。Document AI の権限とロールの一覧については、Document AI の権限と Document AI のロールをご覧ください。IAM ロールを使用して権限を管理する方法については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

プロジェクト間のファイル アクセスの設定

1 つのプロジェクトで Document AI プロセッサを設定するときに、このプロジェクトで、Document AI プロセッサをホストする同じ組織内の別のプロジェクトに保存されている入力ファイルにアクセスできるようにする場合があります。

プロジェクト間のアクセスを許可するには、次の図に示すように、デフォルトの Document AI サービス アカウントにストレージ オブジェクト閲覧者ロール（roles/storage.objectViewer）を付与する必要があります。

setup-1

例

  • プロジェクト A が Document AI プロセッサをホストし、必要に応じて、プロセッサの出力が書き込まれるバケットをホストしているとします。
  • プロジェクト B は、Document AI プロセッサの入力ファイルを含むバケットを所有します。

  • プロジェクト B のファイルに プロジェクト A からアクセスできるようにするには、プロジェクト B の入力バケットに対する Storage オブジェクト閲覧者ロール（roles/storage.objectViewer）を プロジェクト A の Document AI サービス アカウントに付与する必要があります。

    setup-2

IAM と Storage Object Viewer の詳細については、Cloud Storage の IAM ロールをご覧ください。

組み込みサービス アカウント

Document AI サービス アカウントの命名規則は次のとおりです。

service-{project number}@gcp-sa-prod-dai-core.iam.gserviceaccount.com

例: service-361747088407@gcp-sa-prod-dai-core.iam.gserviceaccount.com

setup-3

次のステップ: ユースケース

Document AI API を有効にすると、Document AI プロセッサを作成して使用できるようになります。最適なプロセッサのタイプは、ユースケースによって異なります。

次へ
拡充