AnnotateImageResponse

Réponse à une requête d'annotation d'images.

Représentation JSON
{
  "textAnnotations": [
    {
      object (EntityAnnotation)
    }
  ],
  "fullTextAnnotation": {
    object (TextAnnotation)
  },
  "error": {
    object (Status)
  },
  "context": {
    object (ImageAnnotationContext)
  }
}
Champs
textAnnotations[]

object (EntityAnnotation)

Si ce champ est présent, la détection de texte (OCR) a bien été effectuée.

fullTextAnnotation

object (TextAnnotation)

Si ce champ est présent, la détection de texte (OCR) ou de document (OCR) a bien été effectuée. Cette annotation fournit la hiérarchie structurelle du texte détecté par l'OCR.

error

object (Status)

Si ce champ est défini, il présente le message d'erreur de l'opération. Notez que les annotations d'images préremplies sont assurément correctes, même lorsque error est défini.

context

object (ImageAnnotationContext)

Si ce champ est présent, des informations contextuelles sont nécessaires pour comprendre d'où provient cette image.

EntityAnnotation

Ensemble des caractéristiques d'entités détectées.

Représentation JSON
{
  "mid": string,
  "locale": string,
  "description": string,
  "score": number,
  "confidence": number,
  "topicality": number,
  "boundingPoly": {
    object (BoundingPoly)
  },
  "properties": [
    {
      object (Property)
    }
  ]
}
Champs
mid

string

ID d'entité opaque. Certains identifiants sont disponibles dans l'API Google Knowledge Graph Search.

locale

string

Code de langue des paramètres régionaux dans lequel la description textuelle de l'entité est exprimée.

description

string

Description textuelle de l'entité, exprimée dans sa langue locale.

score

number

Score global du résultat. Plage [0, 1].

confidence
(deprecated)

number

Obsolète. Utilisez plutôt score. Précision de la détection d'entités dans une image. Prenons l'exemple d'une image dans laquelle l'entité "Tour Eiffel" est détectée. Ce champ représente le niveau de confiance pour qu'une tour figure dans l'image de la requête. Plage [0, 1].

topicality

number

Pertinence du libellé ICA (Image Content Annotation) par rapport à l'image. Par exemple, la pertinence de l'entité "tour" est probablement plus élevée pour une image sur laquelle la "Tour Eiffel" a été détectée que pour une image contenant un imposant bâtiment à distance, même si la probabilité pour qu'une tour soit présente sur chaque image puisse être identique. Plage [0, 1].

boundingPoly

object (BoundingPoly)

Zone de l'image à laquelle appartient cette entité. Champ non généré pour les fonctionnalités LABEL_DETECTION.

properties[]

object (Property)

Certaines entités peuvent inclure des champs Property (nom/valeur) facultatifs fournis par l'utilisateur, tels qu'un score ou une chaîne qualifiant l'entité.

BoundingPoly

Polygone de délimitation pour l'annotation d'image détectée.

Représentation JSON
{
  "vertices": [
    {
      object (Vertex)
    }
  ],
  "normalizedVertices": [
    {
      object (NormalizedVertex)
    }
  ]
}
Champs
vertices[]

object (Vertex)

Sommets du polygone de délimitation.

normalizedVertices[]

object (NormalizedVertex)

Sommets normalisés du polygone de sélection.

Vertex

Un sommet représente un point 2D dans l'image. REMARQUE : les coordonnées du sommet sont à la même échelle que l'image d'origine.

Représentation JSON
{
  "x": integer,
  "y": integer
}
Champs
x

integer

Coordonnée X.

y

integer

Coordonnée Y.

NormalizedVertex

Un sommet représente un point 2D dans l'image. REMARQUE : les coordonnées des sommets normalisés sont comparées aux valeurs de l'image d'origine, et sont comprises entre 0 et 1.

Représentation JSON
{
  "x": number,
  "y": number
}
Champs
x

number

Coordonnée X.

y

number

Coordonnée Y.

Propriété

Une propriété (Property) est constituée d'une paire nom/valeur fournie par l'utilisateur.

Représentation JSON
{
  "name": string,
  "value": string,
  "uint64Value": string
}
Champs
name

string

Nom de la propriété.

value

string

Valeur de la propriété.

uint64Value

string

Valeur des propriétés numériques.

TextAnnotation

TextAnnotation contient une représentation structurée du texte extrait par l'OCR. La hiérarchie d'une structure de texte extraite par l'OCR se présente comme suit :

TextAnnotation-> Page -> Bloc -> Paragraphe -> Mot -> Symbole

Chaque composant structurel, à partir de la page, peut avoir des propriétés qui décrivent les langues détectées, les sauts, etc. Pour en savoir plus, consultez la définition du message TextAnnotation.TextProperty ci-dessous.

Représentation JSON
{
  "pages": [
    {
      object (Page)
    }
  ],
  "text": string
}
Champs
pages[]

object (Page)

Liste des pages détectées par l'OCR.

text

string

Texte UTF-8 détecté sur les pages.

Page

Page détectée par l'OCR.

Représentation JSON
{
  "property": {
    object (TextProperty)
  },
  "width": integer,
  "height": integer,
  "blocks": [
    {
      object (Block)
    }
  ],
  "confidence": number
}
Champs
property

object (TextProperty)

Informations supplémentaires détectées sur la page.

width

integer

Largeur de la page. Pour les PDF, l'unité est exprimée en points. Pour les images (y compris au format TIFF), l'unité est exprimée en pixels.

height

integer

Hauteur de la page. Pour les PDF, l'unité est exprimée en points. Pour les images (y compris au format TIFF), l'unité est exprimée en pixels.

blocks[]

object (Block)

Liste de blocs de texte, d'images, etc. sur la page.

confidence

number

Niveau de confiance des résultats de l'OCR sur la page. Plage [0, 1].

TextProperty

Informations supplémentaires détectées dans le composant structurel.

Représentation JSON
{
  "detectedLanguages": [
    {
      object (DetectedLanguage)
    }
  ],
  "detectedBreak": {
    object (DetectedBreak)
  }
}
Champs
detectedLanguages[]

object (DetectedLanguage)

Liste des langues détectées en toute confiance.

detectedBreak

object (DetectedBreak)

Début ou fin d'un segment de texte détecté.

DetectedLanguage

Langue détectée d'un composant structurel.

Représentation JSON
{
  "languageCode": string,
  "confidence": number
}
Champs
languageCode

string

Le code de langue BCP-47, tel que "en-US" ou "sr-Latn". Pour en savoir plus, consultez la page https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

confidence

number

Niveau de confiance de la langue détectée. Plage [0, 1].

DetectedBreak

Début ou fin d'un composant structurel détecté.

Représentation JSON
{
  "type": enum (BreakType),
  "isPrefix": boolean
}
Champs
type

enum (BreakType)

Type de saut détecté.

isPrefix

boolean

La valeur est "true" si le saut est ajouté au début de l'élément.

BreakType

Énumération indiquant le type de saut détecté. Nouvelle ligne, espace, etc.

Enums
UNKNOWN Type de libellé de saut inconnu.
SPACE Espace standard.
SURE_SPACE Espace sûre (très large).
EOL_SURE_SPACE Saut de ligne.
HYPHEN Césure qui n'est pas présente dans le texte. Ce champ ne peut pas être utilisé avec SPACE, LEADER_SPACE ou LINE_BREAK.
LINE_BREAK Saut de ligne qui termine un paragraphe.

Bloquer

Élément logique sur la page.

Représentation JSON
{
  "property": {
    object (TextProperty)
  },
  "boundingBox": {
    object (BoundingPoly)
  },
  "paragraphs": [
    {
      object (Paragraph)
    }
  ],
  "blockType": enum (BlockType),
  "confidence": number
}
Champs
property

object (TextProperty)

Informations supplémentaires détectées pour le bloc.

boundingBox

object (BoundingPoly)

Cadre de délimitation du bloc. Les sommets sont présentés dans l'ordre suivant : en haut à gauche, en haut à droite, en bas à droite et en bas à gauche. Lorsqu'une rotation du cadre de délimitation est détectée, elle est représentée autour de l'angle supérieur gauche en suivant l'ordre naturel de lecture du texte. Exemple :

  • Lorsque le texte est horizontal, il peut se présenter sous la forme suivante :
    0----1
    |    |
    3----2
  • Lors d'une rotation à 180 degrés autour de l'angle supérieur gauche, il se présente sous la forme suivante :
    2----3
    |    |
    1----0

L'ordre des sommets est toujours (0, 1, 2, 3).

paragraphs[]

object (Paragraph)

Liste des paragraphes du bloc (s'il est de type texte).

blockType

enum (BlockType)

Type de bloc détecté (texte, image, etc.) pour le bloc.

confidence

number

Niveau de confiance des résultats de l'OCR dans le bloc. Plage [0, 1].

Paragraph

Unité structurelle de texte représentant un certain nombre de mots dans un ordre particulier.

Représentation JSON
{
  "property": {
    object (TextProperty)
  },
  "boundingBox": {
    object (BoundingPoly)
  },
  "words": [
    {
      object (Word)
    }
  ],
  "confidence": number
}
Champs
property

object (TextProperty)

Informations supplémentaires détectées pour le paragraphe.

boundingBox

object (BoundingPoly)

Cadre de délimitation du paragraphe. Les sommets sont présentés dans l'ordre suivant : en haut à gauche, en haut à droite, en bas à droite et en bas à gauche. Lorsqu'une rotation du cadre de délimitation est détectée, elle est représentée autour de l'angle supérieur gauche en suivant l'ordre naturel de lecture du texte. Par exemple : * lorsque le texte est horizontal, il peut se présenter sous la forme suivante : 0----1 | | 3----2 * lorsqu'il a été pivoté de 180 degrés autour de l'angle supérieur gauche, il se présente sous la forme suivante : 2----3 | | 1----0 et l'ordre des sommets sera toujours (0, 1, 2, 3).

words[]

object (Word)

Liste de tous les mots du paragraphe.

confidence

number

Niveau de confiance des résultats de l'OCR pour le paragraphe. Plage [0, 1].

Word

Représentation d'un mot.

Représentation JSON
{
  "property": {
    object (TextProperty)
  },
  "boundingBox": {
    object (BoundingPoly)
  },
  "symbols": [
    {
      object (Symbol)
    }
  ],
  "confidence": number
}
Champs
property

object (TextProperty)

Informations supplémentaires détectées pour le mot.

boundingBox

object (BoundingPoly)

Cadre de délimitation du mot. Les sommets sont présentés dans l'ordre suivant : en haut à gauche, en haut à droite, en bas à droite et en bas à gauche. Lorsqu'une rotation du cadre de délimitation est détectée, elle est représentée autour de l'angle supérieur gauche en suivant l'ordre naturel de lecture du texte. Par exemple : * lorsque le texte est horizontal, il peut se présenter sous la forme suivante : 0----1 | | 3----2 * lorsqu'il a été pivoté de 180 degrés autour de l'angle supérieur gauche, il se présente sous la forme suivante : 2----3 | | 1----0 et l'ordre des sommets sera toujours (0, 1, 2, 3).

symbols[]

object (Symbol)

Liste de symboles dans le mot. L'ordre des symboles suit l'ordre naturel de lecture.

confidence

number

Niveau de confiance des résultats de l'OCR pour le mot. Plage [0, 1].

Symbole

Représentation d'un seul symbole.

Représentation JSON
{
  "property": {
    object (TextProperty)
  },
  "boundingBox": {
    object (BoundingPoly)
  },
  "text": string,
  "confidence": number
}
Champs
property

object (TextProperty)

Informations supplémentaires détectées pour le symbole.

boundingBox

object (BoundingPoly)

Cadre de délimitation du symbole. Les sommets sont présentés dans l'ordre suivant : en haut à gauche, en haut à droite, en bas à droite et en bas à gauche. Lorsqu'une rotation du cadre de délimitation est détectée, elle est représentée autour de l'angle supérieur gauche en suivant l'ordre naturel de lecture du texte. Par exemple : * lorsque le texte est horizontal, il peut se présenter sous la forme suivante : 0----1 | | 3----2 * lorsqu'il a été pivoté de 180 degrés autour de l'angle supérieur gauche, il se présente sous la forme suivante : 2----3 | | 1----0 et l'ordre des sommets sera toujours (0, 1, 2, 3).

text

string

Représentation actuelle du symbole en UTF-8.

confidence

number

Niveau de confiance des résultats de l'OCR pour le symbole. Plage [0, 1].

BlockType

Type de bloc (texte, image, etc.) tel qu'identifié par l'OCR.

Enums
UNKNOWN Type de bloc inconnu.
TEXT Bloc de texte standard.
TABLE Bloc de table.
PICTURE Bloc d'image.
RULER Zone de ligne horizontale/verticale.
BARCODE Bloc de code-barres.

ImageAnnotationContext

Si une image a été générée à partir d'un fichier (PDF, par exemple), ce message fournit des informations sur la source de cette image.

Représentation JSON
{
  "uri": string,
  "pageNumber": integer
}
Champs
uri

string

URI du fichier permettant de générer l'image.

pageNumber

integer

Si le fichier est au format PDF ou TIFF, ce champ indique le numéro de page dans le fichier utilisé pour générer l'image.