Method: projects.locations.files.annotate

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.

This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.

HTTP request

POST https://vision.googleapis.com/v1p4beta1/{parent=projects/*/locations/*}/files:annotate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Optional. Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no parent is specified, a region will be chosen automatically.

Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

Example: projects/project-A/locations/eu.

Request body

The request body contains data with the following structure:

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

object (AnnotateFileRequest)

Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

Response body

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

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.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Vision API Documentation
Need help? Visit our support page.