Method: files.annotate

Service qui détecte et annote les images d'un lot de fichiers. Actuellement, seuls les fichiers "application/pdf", "image/tiff" et "image/gif" sont acceptés.

Ce service extrait au maximum cinq frames GIF (les clients peuvent les spécifier dans les requêtes AnnotateFileRequest.pages) ou pages (PDF ou TIFF) de chaque fichier fourni, et détecte et annote chaque image extraite.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "requests": [
    {
      object (AnnotateFileRequest)
    }
  ]
}
Champs
requests[]

object (AnnotateFileRequest)

Liste des requêtes d'annotation de fichiers. À l'heure actuelle, nous n'acceptons qu'une seule requête AnnotateFileRequest dans la liste BatchAnnotateFilesRequest.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Liste des résultats de l'annotation de fichiers.

Représentation JSON 
{
  "responses": [
    {
      object (AnnotateFileResponse)
    }
  ]
}
Champs
responses[]

object (AnnotateFileResponse)

Liste des résultats de l'annotation de fichiers, chacun d'eux correspondant à une requête AnnotateFileRequest de la liste BatchAnnotateFilesRequest.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Présentation de l'authentification.

AnnotateFileRequest

Requête permettant d'annoter un seul fichier, par exemple un fichier PDF, TIFF ou GIF.

Représentation JSON 
{
  "inputConfig": {
    object (InputConfig)
  },
  "features": [
    {
      object (Feature)
    }
  ],
  "imageContext": {
    object (ImageContext)
  },
  "pages": [
    number
  ]
}
Champs
inputConfig

object (InputConfig)

Obligatoire. Informations sur le fichier d'entrée.

features[]

object (Feature)

Obligatoire. Fonctionnalités demandées.

imageContext

object (ImageContext)

Contexte supplémentaire pouvant accompagner les images du fichier.

pages[]

number

Pages du fichier sur lesquelles effectuer une annotation d'images.

La numérotation des pages commence par 1. Nous partons du principe que la première page du fichier est la page 1. Vous pouvez ajouter jusqu'à cinq pages par requête. Les pages peuvent être négatives.

La page 1 correspond à la première page. La page 2 correspond à la deuxième page. La page -1 correspond à la dernière page. La page -2 correspond à l'avant-dernière page.

Si le fichier est au format GIF, et non PDF ou TIFF, la page fait référence à des frames GIF.

Si ce champ est vide, le service annote les images des cinq premières pages du fichier par défaut.

AnnotateFileResponse

Réponse à une requête d'annotation sur un seul fichier. Un fichier peut contenir une ou plusieurs images, disposant chacune de leurs propres réponses.

Représentation JSON 
{
  "inputConfig": {
    object (InputConfig)
  },
  "responses": [
    {
      object (AnnotateImageResponse)
    }
  ],
  "totalPages": number
}
Champs
inputConfig

object (InputConfig)

Informations sur le fichier pour lequel la réponse est générée.

responses[]

object (AnnotateImageResponse)

Réponses individuelles pour les images trouvées dans le fichier.

totalPages

number

Ce champ indique le nombre total de pages du fichier.