Method: files.annotate

Servicio que realiza la detección y la anotación de imágenes en un lote de archivos. Ahora solo se admiten "application/pdf", "image/tiff" e "image/gif".

Este servicio extraerá un máximo de 5 fotogramas (GIF) o páginas (PDF o TIFF) de cada archivo proporcionado y realizará la detección y la anotación de cada imagen extraída. Los clientes pueden especificar qué 5 fotogramas o páginas se extraerán en AnnotateFileRequest.pages.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

Representación JSON 
{
  "requests": [
    {
      object (AnnotateFileRequest)
    }
  ]
}
Campos
requests[]

object (AnnotateFileRequest)

Lista de solicitudes de anotación de archivos. Por el momento, solo admitimos un AnnotateFileRequest en BatchAnnotateFilesRequest.

Cuerpo de la respuesta

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

Lista de respuestas de anotaciones de archivos.

Representación JSON 
{
  "responses": [
    {
      object (AnnotateFileResponse)
    }
  ]
}
Campos
responses[]

object (AnnotateFileResponse)

Lista de respuestas de anotación de archivos. Cada respuesta corresponde a un AnnotateFileRequest de BatchAnnotateFilesRequest.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

AnnotateFileRequest

Una solicitud para anotar un solo archivo, como un archivo PDF, TIFF o GIF.

Representación JSON 
{
  "inputConfig": {
    object (InputConfig)
  },
  "features": [
    {
      object (Feature)
    }
  ],
  "imageContext": {
    object (ImageContext)
  },
  "pages": [
    number
  ]
}
Campos
inputConfig

object (InputConfig)

Obligatorio. Información sobre el archivo de entrada.

features[]

object (Feature)

Obligatorio. Funciones solicitadas.

imageContext

object (ImageContext)

Contexto adicional que puede acompañar a las imágenes del archivo.

pages[]

number

Páginas del archivo para realizar la anotación de imágenes.

Las páginas empiezan por 1. Suponemos que la primera página del archivo es la página 1. Se admiten 5 páginas como máximo por solicitud. Las páginas pueden ser negativas.

Página 1 significa la primera página. Página 2 significa la segunda página. La página -1 significa la última página. La página -2 es la penúltima.

Si el archivo es GIF en lugar de PDF o TIFF, la página hace referencia a los fotogramas GIF.

Si este campo está vacío, el servicio realizará de forma predeterminada la anotación de imagen de las 5 primeras páginas del archivo.

AnnotateFileResponse

Respuesta a una solicitud de anotación de un solo archivo. Un archivo puede contener una o varias imágenes, que tienen sus propias respuestas.

Representación JSON 
{
  "inputConfig": {
    object (InputConfig)
  },
  "responses": [
    {
      object (AnnotateImageResponse)
    }
  ],
  "totalPages": number
}
Campos
inputConfig

object (InputConfig)

Información sobre el archivo para el que se genera esta respuesta.

responses[]

object (AnnotateImageResponse)

Respuestas individuales a las imágenes encontradas en el archivo.

totalPages

number

Este campo indica el número total de páginas del archivo.