Method: files.asyncBatchAnnotate

Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateFilesResponse (results).

HTTP request

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

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requests": [
    {
      object (AsyncAnnotateFileRequest)
    }
  ]
}
Fields
requests[]

object (AsyncAnnotateFileRequest)

Individual async file annotation requests for this batch.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

AsyncAnnotateFileRequest

An offline file annotation request.

JSON representation 
{
  "inputConfig": {
    object (InputConfig)
  },
  "features": [
    {
      object (Feature)
    }
  ],
  "imageContext": {
    object (ImageContext)
  },
  "outputConfig": {
    object (OutputConfig)
  }
}
Fields
inputConfig

object (InputConfig)

Required. Information about the input file.

features[]

object (Feature)

Required. Requested features.

imageContext

object (ImageContext)

Additional context that may accompany the image(s) in the file.

outputConfig

object (OutputConfig)

Required. The desired output location and metadata (e.g. format).