Method: files.annotate

複数のファイルに対して一括で画像検出とアノテーションを実行するサービス。現在、「application/pdf」、「image/tiff」、「image/gif」のみがサポートされています。

このサービスは、指定されたファイルから最大で 5 個のフレーム（gif）またはページ（PDF または tiff）を抽出して、抽出した各画像の検出とアノテーションを実行します（抽出対象は AnnotateFileRequest.pages で指定できます）。

HTTP リクエスト

POST https://vision.googleapis.com/v1p4beta1/files:annotate

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

リクエストの本文

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

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

object (AnnotateFileRequest)

ファイル アノテーション リクエストのリスト。現在、BatchAnnotateFilesRequest では AnnotateFileRequest が 1 つだけサポートされています。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

ファイル アノテーション レスポンスのリスト。

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

object (AnnotateFileResponse)

ファイル アノテーション レスポンスのリスト。各レスポンスは、BatchAnnotateFilesRequest 内の各 AnnotateFileRequest に対応しています。

認証スコープ

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

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

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

AnnotateFileRequest

1 つのファイル（PDF、TIFF、GIF など）にアノテーションを付けるリクエスト。

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

object (InputConfig)

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

object (Feature)

必須。要求する機能。

imageContext

object (ImageContext)

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

number

画像アノテーションを実行するファイルのページ数。

ページは 1 から始まり、ファイルの先頭ページが 1 ページであるとみなされます。1 回のリクエストにつき最大 5 ページがサポートされています。ページには負の値を設定できます。

ページ 1 は最初のページを意味します。ページ 2 は 2 ページ目を意味します。ページ -1 は最後のページを意味します。ページ -2 は最後から 2 番目のページを意味します。

ファイルが PDF や TIFF ではなく GIF の場合、ページは GIF フレームになります。

このフィールドが空の場合、デフォルトでは、ファイルの最初の 5 ページに対して画像アノテーションが実行されます。

AnnotateFileResponse

単一ファイルのアノテーション リクエストへのレスポンス。1 つのファイルには 1 つ以上の画像が含まれる場合があります。各画像にそれぞれ固有のレスポンスが存在します。

JSON 表現 
{
  "inputConfig": {
    object (InputConfig)
  },
  "responses": [
    {
      object (AnnotateImageResponse)
    }
  ],
  "totalPages": number
}
フィールド
inputConfig

object (InputConfig)

このレスポンスが生成されるファイルに関する情報。
responses[]

object (AnnotateImageResponse)

ファイルに含まれる画像に対する個々のレスポンス。
totalPages

number

このフィールドには、ファイル内の総ページ数が含まれます。