カスタム メタデータ ラベル

Document AI は、ユーザー定義のラベルまたは Key-Value ペア（KVP）を、プロセッサに送信されるメタデータとして ProcessDocument、BatchProcessDocuments リクエストに追加することをサポートしています。リクエストに関するこのメタデータ（ページ数などの使用状況データとともに）は、Cloud Billing システムに転送されます。このラベルは課金システムに設定され、このメタデータ ラベルを使用してフィルタリングすることで、請求料金を分類できます。

ユースケース

ラベルの主なユースケースとして、多数のクライアントにドキュメント処理サービスを提供するお客様が挙げられます。1 つのプロジェクトが複数のクライアントに対して使用される場合があります。課金の際は、特定のリクエストをそれぞれのクライアントに関連付けることが重要です。ここで役立つのがメタデータ ラベルです。 Google Cloudでレポートをフィルタリングするためのものです。

ラベルの要件

リクエストに適用するラベルは、次の要件を満たす必要があります。

• 1 つのリクエストに使用できるラベルは、最大 64 個です。
• 各ラベルは KVP である必要があります。
• キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。
• キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。
• 単一のリクエスト内で、ラベルのキーの部分は一意である必要があります（たとえば、{'country':'india'} は使用できますが、{'country':'india','country':'sweden'} は使用できません）。
• キーは、小文字または国際文字で始める必要があります。

API での使用

Sync Process コードサンプルは、ラベルを使用してプロセッサにリクエストを送信する方法を示しています。

  curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -d @docai_request.json \
    "https://us-documentai.googleapis.com/v1/projects/514064100333/locations/us/processors/3bb61571a9731982:process"

リクエストの例

  {
    "skipHumanReview": true,
    "rawDocument": {
      "mimeType": "application/pdf",
        "content" : "PDF/IMAGE CONTENT"
    },
    "labels": {"country": "india" },
    "processOptions": {
      "individualPageSelector" : {
        "pages": [1]
      }
    }
  }

Async Process コードサンプルは、ラベルを使用してプロセッサにリクエストを送信する方法を示しています。

  curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -d @batch_docai_request.json \
    "https://us-documentai.googleapis.com/v1/projects/514064100333/locations/us/processors/3bb61571a9731982:batchProcess"

リクエストの例

  {
   "inputDocuments": {
     "gcsPrefix": {
       "gcsUriPrefix": "gs://atul_dai_test/ravi/GCS_DWH_work_flows_docs/Small_pdf/"
     }
   },
   "documentOutputConfig": {
     "gcsOutputConfig": {
       "gcsUri": "gs://atul_dai_test/ravi/GCS_DWH_work_flows_docs/test/docai_config/"
     }
   },
   "labels": {"country": "india" },
   "skipHumanReview": true
 }

料金レポート

これらのラベルを使用して、リクエストの使用状況を表示できます。

1. Cloud Billing コンソールに移動します。

2. コンソールで、左上の メニューを選択し、プルダウンから [お支払い] を選択します。請求先アカウントが複数ある場合は、選択を求めるページが表示されます。[リンクされた請求先アカウントに移動] を選択します。

   

   

3. [お支払いと請求] ページの左側のナビゲーション パネルで、[レポート] を選択します。

   

4. 右側のペインにあるフィルタを使用して、リクエストの使用状況を確認します。