Method: files.annotate

Serviço que identifica e insere anotações simultaneamente em imagens de um lote de arquivos. No momento, só são aceitos application/pdf, image/tiff e image/gif.

O serviço vai extrair no máximo cinco frames (GIF) ou páginas (PDF ou TIFF) de cada arquivo fornecido e realizar a detecção e a anotação de cada imagem extraída. Os clientes podem especificar esses frames ou páginas em AnnotateFileRequest.pages.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "requests": [
    {
      object (AnnotateFileRequest)
    }
  ]
}
Campos
requests[]

object (AnnotateFileRequest)

A lista de solicitações de anotação de arquivo. No momento, apenas uma AnnotateFileRequest é aceita em BatchAnnotateFilesRequest.

Corpo da resposta

Se houver êxito, o corpo da resposta incluirá dados com a estrutura abaixo:

Uma lista de respostas de anotações de arquivos.

Representação JSON 
{
  "responses": [
    {
      object (AnnotateFileResponse)
    }
  ]
}
Campos
responses[]

object (AnnotateFileResponse)

A lista de respostas de anotação de arquivo, cada resposta correspondente a cada AnnotateFileRequest em BatchAnnotateFilesRequest.

Escopos da autorização

Requer um dos seguintes escopos do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

AnnotateFileRequest

Uma solicitação para anotar um único arquivo, por exemplo, um arquivo PDF, TIFF ou GIF.

Representação JSON 
{
  "inputConfig": {
    object (InputConfig)
  },
  "features": [
    {
      object (Feature)
    }
  ],
  "imageContext": {
    object (ImageContext)
  },
  "pages": [
    number
  ]
}
Campos
inputConfig

object (InputConfig)

Obrigatório. Informações sobre o arquivo de entrada.

features[]

object (Feature)

Obrigatório. Recursos solicitados.

imageContext

object (ImageContext)

Contexto adicional que pode acompanhar as imagens no arquivo.

pages[]

number

Páginas do arquivo para realizar a anotação de imagem.

Como as páginas começam no número 1, presume-se que a primeira página do arquivo seja a página 1. No máximo, cinco páginas são aceitas por solicitação. As páginas podem ser negativas.

Página 1 significa a primeira página. Página 2 significa a segunda página. Página -1 significa a última página. Página -2 significa a penúltima página.

Se o arquivo for um GIF em vez de PDF ou TIFF, a página fará referência a frames do GIF.

Se este campo estiver vazio, o serviço realizará anotações de imagens por padrão nas primeiras cinco páginas do arquivo.

AnnotateFileResponse

Resposta a uma solicitação de anotação de arquivo única. Um arquivo pode conter uma ou mais imagens, que têm as próprias respostas.

Representação JSON 
{
  "inputConfig": {
    object (InputConfig)
  },
  "responses": [
    {
      object (AnnotateImageResponse)
    }
  ],
  "totalPages": number
}
Campos
inputConfig

object (InputConfig)

Informações sobre o arquivo para que a resposta é gerada.

responses[]

object (AnnotateImageResponse)

Respostas individuais às imagens encontradas no arquivo.

totalPages

number

Este campo fornece o número total de páginas no arquivo.