Method: files.asyncBatchAnnotate

PDF ファイルなど、汎用ファイルのリストに対して非同期で画像検出とアノテーションを実行します。このファイルには複数のページが含まれている場合があります。また、各ページに複数の画像が存在することもあります。進行状況と結果は、google.longrunning.Operations インターフェースを介して取得できます。Operation.metadata には、OperationMetadata（メタデータ）が含まれます。Operation.response には、AsyncBatchAnnotateFilesResponse（結果）が含まれます。

HTTP リクエスト

POST https://vision.googleapis.com/v1p3beta1/files:asyncBatchAnnotate

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "requests": [
    {
      object(AsyncAnnotateFileRequest)
    }
  ]
}
フィールド
requests[]

object(AsyncAnnotateFileRequest)

このバッチの個々の非同期ファイルのアノテーション リクエスト。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認証スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

詳細については、認証の概要をご覧ください。

AsyncAnnotateFileRequest

オフライン ファイルのアノテーション リクエスト。

JSON 表現 
{
  "inputConfig": {
    object(InputConfig)
  },
  "features": [
    {
      object(Feature)
    }
  ],
  "imageContext": {
    object(ImageContext)
  },
  "outputConfig": {
    object(OutputConfig)
  }
}
フィールド
inputConfig

object(InputConfig)

必須。入力ファイルに関する情報。
features[]

object(Feature)

必須。リクエストする機能。
imageContext

object(ImageContext)

ファイル内の画像に付随する可能性のある追加のコンテキスト。
outputConfig

object(OutputConfig)

必須。目的の出力場所とメタデータ（例: フォーマット）。

InputConfig

目的の入力ロケーションとメタデータ。

JSON 表現 
{
  "gcsSource": {
    object(GcsSource)
  },
  "mimeType": string
}
フィールド
gcsSource

object(GcsSource)

入力の読み取り元の Google Cloud Storage のロケーション。

mimeType

string

ファイルのタイプ。現在は、application/pdf と image/tiff のみがサポートされています。ワイルドカードはサポートされていません。

GcsSource

入力の読み取り元となる Google Cloud Storage のロケーション。

JSON 表現 
{
  "uri": string
}
フィールド
uri

string

入力ファイルの Google Cloud Storage URI。これは Google Cloud Storage オブジェクトにする必要があります。現在、ワイルドカードはサポートされていません。

OutputConfig

目的の出力場所とメタデータ。

JSON 表現 
{
  "gcsDestination": {
    object(GcsDestination)
  },
  "batchSize": number
}
フィールド
gcsDestination

object(GcsDestination)

出力を書き込む Google Cloud Storage の場所。
batchSize

number

Google Cloud Storage の各出力 JSON ファイルに追加するレスポンス proto の最大数。有効な範囲は [1, 100] です。指定しない場合、デフォルト値は 20 です。

たとえば、100 ページの PDF の場合、100 個のレスポンス proto が生成されます。batchSize = 20 の場合、20 個のレスポンス proto を含む 5 つの JSON ファイルが、それぞれ接頭辞 gcsDestination.uri の下に記述されます。

現在、batchSize は GcsDestination にのみ適用されますが、将来的には他の出力構成もサポートされます。

GcsDestination

出力の書き込み先とする Google Cloud Storage のロケーション。

JSON 表現 
{
  "uri": string
}
フィールド
uri

string

結果が保存される Google Cloud Storage URI。結果は JSON 形式で、対応する入力 URI が先頭に付加されます。このフィールドは、単一ファイルまたは複数出力の接頭辞を表します。接頭辞は / で終わる必要があります。

例:

複数の出力がある場合、各レスポンスは AnnotateFileResponse で、各レスポンスには、AnnotateImageResponse の全リストのサブセットが含まれます。たとえば、出力 JSON が大きすぎて複数の分割ファイルにオーバーフローする場合は、複数の出力が発生する可能性があります。