Method: files.annotate

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

Este servicio extraerá como máximo 5 marcos (gif) o páginas (pdf o tiff) (los clientes pueden especificar los 5 en AnnotateFileRequest.pages) de cada archivo proporcionado y realizará la detección y anotación para cada imagen extraída.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

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

object (AnnotateFileRequest)

La lista de solicitudes de anotación de archivos. En este momento, solo se admite una AnnotateFileRequest en BatchAnnotateFilesRequest.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Una lista de respuestas de anotación de archivos.

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

object (AnnotateFileResponse)

La lista de respuestas de anotación de archivos, cada respuesta corresponde a cada AnnotateFileRequest en BatchAnnotateFilesRequest.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

AnnotateFileRequest

Una solicitud para anotar un solo archivo (p. ej., 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 en el archivo.

pages[]

number

Páginas del archivo en las que se realizarán las anotaciones de imagen.

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

La página 1 significa la primera página. La página 2 significa la segunda página. Page -1 significa la última página. Page -2 significa la segunda página.

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

Si este campo está vacío, de forma predeterminada, el servicio realiza anotaciones de imagen para las primeras 5 páginas del archivo.

AnnotateFileResponse

Respuesta a una solicitud de anotación de archivo único. Un archivo puede contener una o más imágenes, que tienen sus propias respuestas individuales.

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 que se encuentran en el archivo.

totalPages

number

Este campo proporciona la cantidad total de páginas en el archivo.