Package google.cloud.vision.v1p3beta1

Index

ImageAnnotator

Service effectuant des tâches de détection de l'API Google Cloud Vision sur les images client, telles que la détection de visages, de points de repère, de logos, de thèmes et de texte. Le service ImageAnnotator renvoie les entités détectées dans les images.

AsyncBatchAnnotateFiles

rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (Operation)

Détecte et annote de manière asynchrone les images d'une liste de fichiers génériques, tels que des fichiers PDF, qui peuvent contenir plusieurs pages et plusieurs images par page. La progression et les résultats peuvent être récupérés via l'interface google.longrunning.Operations. Operation.metadata contient OperationMetadata (métadonnées). Operation.response contient AsyncBatchAnnotateFilesResponse (résultats).

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 la page Présentation de l'authentification.

BatchAnnotateImages

rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse)

Détecte et annote un lot d'images.

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 la page Présentation de l'authentification.

ProductSearch

Gère les ressources Product et ProductSet des images de référence à utiliser dans la recherche de produits. Cette classe utilise le modèle de ressource suivant :

  • L'API dispose d'un ensemble de ressources ProductSet, nommé projects/*/locations/*/productSets/*, permettant de regrouper différents produits afin de limiter l'identification.

En parallèle :

  • L'API dispose d'un ensemble de ressources Product nommé projects/*/locations/*/products/*.

  • Chaque Product possède un ensemble de ressources ReferenceImage nommé projects/*/locations/*/products/*/referenceImages/*.

AddProductToProductSet

rpc AddProductToProductSet(AddProductToProductSetRequest) returns (Empty)

Ajoute une ressource Product à la ressource ProductSet spécifiée. Si la ressource Product est déjà présente, aucune modification n'est apportée.

Vous pouvez ajouter une ressource Product à 100 ressources ProductSet au maximum.

Erreurs possibles :

  • Renvoie NOT_FOUND si la ressource Product ou ProductSet n'existe pas.
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 la page Présentation de l'authentification.

CreateProduct

rpc CreateProduct(CreateProductRequest) returns (Product)

Crée et affiche une ressource Product.

Erreurs possibles :

  • Renvoie INVALID_ARGUMENT si le champ "display_name" est manquant ou comporte plus de 4 096 caractères.
  • Renvoie INVALID_ARGUMENT si la description comporte plus de 4 096 caractères.
  • Renvoie INVALID_ARGUMENT si le champ "product_category" est manquant ou non valide.
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 la page Présentation de l'authentification.

CreateProductSet

rpc CreateProductSet(CreateProductSetRequest) returns (ProductSet)

Crée et affiche une ressource ProductSet.

Erreurs possibles :

  • Renvoie INVALID_ARGUMENT si le champ "display_name" est manquant ou comporte plus de 4 096 caractères.
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 la page Présentation de l'authentification.

CreateReferenceImage

rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage)

Crée et affiche une ressource ReferenceImage.

Le champ bounding_poly est facultatif. Si bounding_poly n'est pas spécifié, le système essaie de détecter les zones d'intérêt de l'image qui sont compatibles avec le champ "product_category" du produit parent. Si ce champ est spécifié, la détection est TOUJOURS ignorée. Le système convertit les polygones en rectangles non pivotants.

Notez que le pipeline redimensionne l'image si sa résolution est trop élevée pour être traitée (plus de 50 Mpx).

Erreurs possibles :

  • Renvoie INVALID_ARGUMENT si le champ "image_uri" est manquant ou comporte plus de 4 096 caractères.
  • Renvoie INVALID_ARGUMENT si le produit n'existe pas.
  • Renvoie INVALID_ARGUMENT si le champ "bounding_poly" n'est pas fourni et si aucun élément compatible avec le champ "product_category" du produit parent n'est détecté.
  • Renvoie INVALID_ARGUMENT si le champ "bounding_poly" contient plus de 10 polygones.
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 la page Présentation de l'authentification.

DeleteProduct

rpc DeleteProduct(DeleteProductRequest) returns (Empty)

Supprime définitivement un produit et ses images de référence.

Les métadonnées du produit et de toutes ses images sont immédiatement supprimées. Cependant, les requêtes de recherche portant sur des ressources ProductSet incluant le produit peuvent continuer de fonctionner jusqu'à l'actualisation de tous les caches associés.

Erreurs possibles :

  • Renvoie NOT_FOUND si la ressource Product n'existe pas.
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 la page Présentation de l'authentification.

DeleteProductSet

rpc DeleteProductSet(DeleteProductSetRequest) returns (Empty)

Supprime définitivement une ressource ProductSet. Les ressources Product et ReferenceImage stockées dans ProductSet ne sont pas supprimées.

Les fichiers image stockés dans Google Cloud Storage ne sont pas supprimés.

Erreurs possibles :

  • Renvoie NOT_FOUND si la ressource ProductSet n'existe pas.
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 la page Présentation de l'authentification.

DeleteReferenceImage

rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (Empty)

Supprime définitivement une image de référence.

Les métadonnées de l'image sont immédiatement supprimées. Cependant, les requêtes de recherche portant sur des ressources ProductSet incluant l'image peuvent continuer de fonctionner jusqu'à l'actualisation de tous les caches associés.

Les fichiers image stockés dans Google Cloud Storage ne sont pas supprimés.

Erreurs possibles :

  • Renvoie NOT_FOUND si l'image de référence n'existe pas.
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 la page Présentation de l'authentification.

GetProduct

rpc GetProduct(GetProductRequest) returns (Product)

Récupère les informations associées à une ressource Product.

Erreurs possibles :

  • Renvoie NOT_FOUND si la ressource Product n'existe pas.
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 la page Présentation de l'authentification.

GetProductSet

rpc GetProductSet(GetProductSetRequest) returns (ProductSet)

Récupère les informations associées à une ressource ProductSet.

Erreurs possibles :

  • Renvoie NOT_FOUND si la ressource ProductSet n'existe pas.
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 la page Présentation de l'authentification.

GetReferenceImage

rpc GetReferenceImage(GetReferenceImageRequest) returns (ReferenceImage)

Récupère les informations associées à une ressource ReferenceImage.

Erreurs possibles :

  • Renvoie NOT_FOUND si l'image spécifiée n'existe pas.
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 la page Présentation de l'authentification.

ImportProductSets

rpc ImportProductSets(ImportProductSetsRequest) returns (Operation)

API asynchrone permettant d'importer une liste d'images de référence dans des ensembles de produits spécifiés en fonction d'une liste d'informations les concernant.

L'API google.longrunning.Operation permet de suivre la progression et les résultats de la requête. Operation.metadata contient BatchOperationMetadata. (progression) Operation.response contient ImportProductSetsResponse. (résultats)

La source d'entrée de cette méthode est un fichier CSV stocké dans Google Cloud Storage. Pour en savoir plus sur le format du fichier CSV, veuillez consulter la section sur le champ ImportProductSetsGcsSource.csv_file_uri.

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 la page Présentation de l'authentification.

ListProductSets

rpc ListProductSets(ListProductSetsRequest) returns (ListProductSetsResponse)

Répertorie les ressources ProductSet dans un ordre non spécifié.

Erreurs possibles :

  • Renvoie INVALID_ARGUMENT si la valeur du champ "page_size" est supérieure à 100 ou inférieure à 1.
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 la page Présentation de l'authentification.

ListProducts

rpc ListProducts(ListProductsRequest) returns (ListProductsResponse)

Répertorie les produits dans un ordre non spécifié.

Erreurs possibles :

  • Renvoie INVALID_ARGUMENT si la valeur du champ "page_size" est supérieure à 100 ou inférieure à 1.
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 la page Présentation de l'authentification.

ListProductsInProductSet

rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse)

Répertorie les ressources Product d'un ProductSet dans un ordre non spécifié. Si la ressource ProductSet n'existe pas, le champ "products" de la réponse est vide.

Erreurs possibles :

  • Renvoie INVALID_ARGUMENT si la valeur du champ "page_size" est supérieure à 100 ou inférieure à 1.
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 la page Présentation de l'authentification.

ListReferenceImages

rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse)

Répertorie les images de référence.

Erreurs possibles :

  • Renvoie NOT_FOUND si le produit parent n'existe pas.
  • Renvoie INVALID_ARGUMENT si la valeur du champ "page_size" est supérieure à 100 ou inférieure à 1.
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 la page Présentation de l'authentification.

RemoveProductFromProductSet

rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (Empty)

Supprime une ressource Product d'un ProductSet spécifié.

Erreurs possibles :

  • Renvoie NOT_FOUND si la ressource Product est introuvable sous le ProductSet.
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 la page Présentation de l'authentification.

UpdateProduct

rpc UpdateProduct(UpdateProductRequest) returns (Product)

Apporte des modifications à une ressource Product. Seuls les champs display_name, description et labels peuvent être mis à jour pour le moment.

Si des libellés sont mis à jour, la modification n'est répercutée dans les requêtes qu'au prochain index.

Erreurs possibles :

  • Renvoie NOT_FOUND si la ressource Product n'existe pas.
  • Renvoie INVALID_ARGUMENT si le champ "display_name" est présent dans "update_mask", mais ne figure pas dans la requête ou comporte plus de 4 096 caractères.
  • Renvoie INVALID_ARGUMENT si la description est présente dans "update_mask", mais comporte plus de 4 096 caractères.
  • Renvoie INVALID_ARGUMENT si le champ "product_category" est présent dans "update_mask".
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 la page Présentation de l'authentification.

UpdateProductSet

rpc UpdateProductSet(UpdateProductSetRequest) returns (ProductSet)

Apporte des modifications à une ressource ProductSet. Seul le champ "display_name" peut être mis à jour pour le moment.

Erreurs possibles :

  • Renvoie NOT_FOUND si la ressource ProductSet n'existe pas.
  • Renvoie INVALID_ARGUMENT si le champ "display_name" est présent dans "update_mask", mais ne figure pas dans la requête ou comporte plus de 4 096 caractères.
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 la page Présentation de l'authentification.

AddProductToProductSetRequest

Message de requête pour la méthode AddProductToProductSet.

Champs
name

string

Nom de la ressource ProductSet à modifier.

Format : projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

product

string

Nom de la ressource Product à ajouter au ProductSet.

Format : projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

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.

Champs
input_config

InputConfig

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

responses[]

AnnotateImageResponse

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

AnnotateImageRequest

Requête permettant d'effectuer des tâches de l'API Google Cloud Vision sur une image fournie par l'utilisateur, avec des fonctionnalités demandées par l'utilisateur.

Champs
image

Image

Image à traiter.

features[]

Feature

Fonctionnalités demandées.

image_context

ImageContext

Contexte supplémentaire pouvant accompagner l'image.

AnnotateImageResponse

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

Champs
face_annotations[]

FaceAnnotation

Si ce champ est présent, la détection de visages a bien été effectuée.

landmark_annotations[]

EntityAnnotation

Si ce champ est présent, la détection de points de repère a bien été effectuée.

logo_annotations[]

EntityAnnotation

Si ce champ est présent, la détection de logos a bien été effectuée.

label_annotations[]

EntityAnnotation

Si ce champ est présent, la détection de thèmes a bien été effectuée.

localized_object_annotations[]

LocalizedObjectAnnotation

Si ce champ est présent, la détection d'objets localisés a bien été effectuée. Les données sont triées par ordre de score de confiance décroissant.

text_annotations[]

EntityAnnotation

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

full_text_annotation

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.

safe_search_annotation

SafeSearchAnnotation

Si ce champ est présent, l'annotation de recherche sécurisée a bien été effectuée.

image_properties_annotation

ImageProperties

Si ce champ est présent, les propriétés de l'image ont bien été extraites.

crop_hints_annotation

CropHintsAnnotation

Si ce champ est présent, les suggestions de cadrage ont bien été effectuées.

web_detection

WebDetection

Si ce champ est présent, la détection Web a bien été effectuée.

product_search_results

ProductSearchResults

Si ce champ est présent, la recherche de produits a bien été effectuée.

error

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

ImageAnnotationContext

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

AsyncAnnotateFileRequest

Requête d'annotation de fichiers hors connexion.

Champs
input_config

InputConfig

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

features[]

Feature

Obligatoire. Fonctionnalités demandées.

image_context

ImageContext

Contexte supplémentaire pouvant accompagner les images du fichier.

output_config

OutputConfig

Obligatoire. Emplacement de sortie et métadonnées (par exemple, le format) souhaités.

AsyncAnnotateFileResponse

Réponse à une requête d'annotation sur un seul fichier hors connexion.

Champs
output_config

OutputConfig

Emplacement de sortie et métadonnées de la requête AsyncAnnotateFileRequest.

AsyncBatchAnnotateFilesRequest

Plusieurs requêtes d'annotation de fichiers asynchrones sont regroupées dans un seul appel de service.

Champs
requests[]

AsyncAnnotateFileRequest

Requêtes d'annotation de fichiers asynchrones individuelles du lot.

AsyncBatchAnnotateFilesResponse

Réponse à une requête d'annotation de fichier par lot asynchrone.

Champs
responses[]

AsyncAnnotateFileResponse

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

BatchAnnotateImagesRequest

Plusieurs requêtes d'annotation d'images asynchrones sont regroupées dans un seul appel de service.

Champs
requests[]

AnnotateImageRequest

Requêtes d'annotation d'images individuelles du lot.

BatchAnnotateImagesResponse

Réponse à une requête d'annotation d'image par lot.

Champs
responses[]

AnnotateImageResponse

Réponses individuelles pour les requêtes d'annotation d'images du lot.

BatchOperationMetadata

Métadonnées des opérations par lots, telles que l'état actuel.

Elles sont incluses dans le champ metadata de l'opération (Operation) renvoyée par l'appel GetOperation du service google::longrunning::Operations.

Champs
state

State

État actuel de l'opération par lot.

submit_time

Timestamp

Date/Heure de l'envoi de la requête par lot au serveur.

end_time

Timestamp

Date/Heure de fin de la requête par lot et google.longrunning.Operation.done défini sur "true".

State

Énumère les états possibles d'une requête par lot.

Enums
STATE_UNSPECIFIED Non valide.
PROCESSING Requête en cours de traitement.
SUCCESSFUL La requête a bien été effectuée et au moins un élément a bien été traité.
FAILED La requête a bien été effectuée et aucun élément n'a été traité.
CANCELLED La requête est envoyée une fois que l'utilisateur a appelé la méthode longrunning.Operations.CancelOperation. Tous les enregistrements traités avant la commande d'annulation sont affichés comme indiqué dans la requête.

Block

Élément logique sur la page.

Champs
property

TextProperty

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

bounding_box

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[]

Paragraph

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

block_type

BlockType

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

confidence

float

Niveau de confiance des résultats de l'OCR dans le bloc. 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.

BoundingPoly

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

Champs
vertices[]

Vertex

Sommets du polygone de délimitation.

normalized_vertices[]

NormalizedVertex

Sommets normalisés du polygone de sélection.

ColorInfo

Les informations associées aux couleurs incluent les canaux RVB, les scores et la fraction de l'image sur laquelle la couleur est présente.

Champs
color

Color

Composants RVB de la couleur.

score

float

Score de la couleur spécifique à l'image. Valeur comprise dans la plage [0, 1].

pixel_fraction

float

Fraction de pixels sur laquelle la couleur est présente. Valeur comprise dans la plage [0, 1].

CreateProductRequest

Message de requête pour la méthode CreateProduct.

Champs
parent

string

Projet dans lequel la ressource Product doit être créée.

Format : projects/PROJECT_ID/locations/LOC_ID

product

Product

Produit à créer.

product_id

string

ID de la ressource Product fourni par l'utilisateur. Si ce champ est défini, le serveur tente d'utiliser cette valeur en tant qu'ID de ressource. Si elle est déjà utilisée, une erreur est renvoyée avec le code ALREADY_EXISTS. Doit contenir au maximum 128 caractères. Ne peut pas inclure le caractère /.

CreateProductSetRequest

Message de requête pour la méthode CreateProductSet.

Champs
parent

string

Projet dans lequel la ressource ProductSet doit être créée.

Format : projects/PROJECT_ID/locations/LOC_ID

product_set

ProductSet

Ressource ProductSet à créer.

product_set_id

string

ID de cette ressource ProductSet fourni par l'utilisateur. Si ce champ est défini, le serveur tente d'utiliser cette valeur en tant qu'ID de ressource. Si elle est déjà utilisée, une erreur est renvoyée avec le code ALREADY_EXISTS. Doit contenir au maximum 128 caractères. Ne peut pas inclure le caractère /.

CreateReferenceImageRequest

Message de requête pour la méthode CreateReferenceImage.

Champs
parent

string

Nom de ressource du produit dans lequel créer l'image de référence.

Format : projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

reference_image

ReferenceImage

Image de référence à créer. Si un ID d'image est spécifié, il est ignoré.

reference_image_id

string

ID de ressource fourni par l'utilisateur pour l'image ReferenceImage à ajouter. Si ce champ est défini, le serveur tente d'utiliser cette valeur en tant qu'ID de ressource. Si elle est déjà utilisée, une erreur est renvoyée avec le code ALREADY_EXISTS. Doit contenir au maximum 128 caractères. Ne peut pas inclure le caractère /.

CropHint

Suggestion de cadrage unique permettant de générer un cadrage lors de la diffusion d'une image.

Champs
bounding_poly

BoundingPoly

Polygone de délimitation de la zone cadrée. Les coordonnées du cadre de délimitation sont à l'échelle de l'image d'origine, comme indiqué dans ImageParams.

confidence

float

Niveau de confiance de l'importance de la zone. Plage [0, 1].

importance_fraction

float

Fraction d'importance de la région par rapport à l'image d'origine.

CropHintsAnnotation

Ensemble de suggestions de cadrage permettant de générer des cadrages lors de la diffusion d'images.

Champs
crop_hints[]

CropHint

Résultats de la suggestion de cadrage.

CropHintsParams

Paramètres de la requête d'annotation de suggestions de cadrage.

Champs
aspect_ratios[]

float

Format exprimé en floats, correspondant au ratio entre la largeur et la hauteur de l'image. Par exemple, si le format souhaité est 4/3, la valeur flottante correspondante doit être de 1,33333. Si le format n'est pas spécifié, le meilleur cadrage possible est renvoyé. Le nombre de formats fournis est limité à 16. Les formats indiqués au-delà du seizième sont ignorés.

DeleteProductRequest

Message de requête pour la méthode DeleteProduct.

Champs
name

string

Nom de la ressource Product à supprimer.

Format : projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

DeleteProductSetRequest

Message de requête pour la méthode DeleteProductSet.

Champs
name

string

Nom de la ressource ProductSet à supprimer.

Format : projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

DeleteReferenceImageRequest

Message de requête pour la méthode DeleteReferenceImage.

Champs
name

string

Nom de ressource de l'image de référence à supprimer.

Format :

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID

DominantColorsAnnotation

Ensemble de couleurs dominantes et scores correspondants.

Champs
colors[]

ColorInfo

Valeurs des couleurs RVB avec leur score et leur fraction en pixels.

EntityAnnotation

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

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

float

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

confidence
(deprecated)

float

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

float

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].

bounding_poly

BoundingPoly

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

locations[]

LocationInfo

Informations concernant la localisation de l'entité détectée. Plusieurs éléments LocationInfo peuvent être présents, car un emplacement peut faire référence à un lieu représenté sur l'image et un autre à l'endroit où l'image a été prise. Des informations concernant la localisation sont généralement disponibles pour les points de repère.

properties[]

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é.

FaceAnnotation

Objet d'annotation de visage contenant les résultats de la détection de visages.

Champs
bounding_poly

BoundingPoly

Polygone de délimitation autour du visage. Les coordonnées du cadre de délimitation sont à l'échelle de l'image d'origine, comme indiqué dans ImageParams. Le cadre de délimitation est agencé de manière à encadrer le visage conformément aux attentes humaines. Il s'appuie sur les résultats des points de repère. Notez qu'une ou plusieurs coordonnées x et/ou y peuvent ne pas être générées dans le champ BoundingPoly (le polygone est alors illimité) si l'image ne comporte qu'un visage partiel à annoter.

fd_bounding_poly

BoundingPoly

Le polygone de délimitation fd_bounding_poly est plus précis que boundingPoly et ne contient que la partie du visage couverte de peau. Il sert généralement à supprimer le visage d'une analyse d'image qui détecte la "quantité de peau" visible sur une image. Il n'est pas basé sur les résultats des points de repère, mais uniquement sur la détection initiale du visage, d'où le

fd

préfixe (détection de visages).

landmarks[]

Landmark

Points de repère détectés sur le visage.

roll_angle

float

Angle de rotation, indiquant la rotation du visage dans le sens des aiguilles d'une montre/dans le sens inverse des aiguilles d'une montre par rapport à l'alignement vertical de l'image sur l'axe perpendiculaire du visage. Plage [-180,180].

pan_angle

float

Angle de lacet, indiquant l'angle vers la gauche/droite vers lequel pointe le visage par rapport à l'axe vertical perpendiculaire de l'image. Plage [-180,180].

tilt_angle

float

Angle d'inclinaison, indiquant l'angle vers le haut/bas vers lequel pointe le visage par rapport à l'axe horizontal de l'image. Plage [-180,180].

detection_confidence

float

Niveau de confiance de la détection. Plage [0, 1].

landmarking_confidence

float

Niveau de confiance des points de repère du visage. Plage [0, 1].

joy_likelihood

Likelihood

Probabilité de joie.

sorrow_likelihood

Likelihood

Probabilité de tristesse.

anger_likelihood

Likelihood

Probabilité de colère.

surprise_likelihood

Likelihood

Probabilité de surprise.

under_exposed_likelihood

Likelihood

Probabilité de sous-exposition.

blurred_likelihood

Likelihood

Probabilité de flou.

headwear_likelihood

Likelihood

Probabilité de port d'accessoires.

Landmark

Point de repère spécifique au visage (par exemple, une caractéristique du visage).

Champs
type

Type

Type de point de repère du visage.

position

Position

Position du point de repère du visage.

Type

Type de point de repère (caractéristique). Les orientations à gauche et à droite sont définies en fonction du point de vue du lecteur de l'image, sans tenir compte des projections miroirs classiques des photos. Ainsi, LEFT_EYE correspond généralement à l'œil droit de la personne.

Enums
UNKNOWN_LANDMARK Point de repère de visage inconnu détecté. Ne doit pas être rempli.
LEFT_EYE Œil gauche.
RIGHT_EYE Œil droit.
LEFT_OF_LEFT_EYEBROW Côté gauche du sourcil gauche.
RIGHT_OF_LEFT_EYEBROW Côté droit du sourcil gauche.
LEFT_OF_RIGHT_EYEBROW Côté gauche du sourcil droit.
RIGHT_OF_RIGHT_EYEBROW Côté droit du sourcil droit.
MIDPOINT_BETWEEN_EYES Point médian entre les yeux.
NOSE_TIP Bout du nez.
UPPER_LIP Lèvre supérieure.
LOWER_LIP Lèvre inférieure.
MOUTH_LEFT Côté gauche de la bouche.
MOUTH_RIGHT Côté droit de la bouche.
MOUTH_CENTER Centre de la bouche.
NOSE_BOTTOM_RIGHT Nez, en bas à droite.
NOSE_BOTTOM_LEFT Nez, en bas à gauche.
NOSE_BOTTOM_CENTER Nez, en bas au centre.
LEFT_EYE_TOP_BOUNDARY Œil gauche, limite supérieure.
LEFT_EYE_RIGHT_CORNER Œil gauche, coin droit.
LEFT_EYE_BOTTOM_BOUNDARY Œil gauche, limite inférieure.
LEFT_EYE_LEFT_CORNER Œil gauche, coin gauche.
RIGHT_EYE_TOP_BOUNDARY Œil droit, limite supérieure.
RIGHT_EYE_RIGHT_CORNER Œil droit, coin droit.
RIGHT_EYE_BOTTOM_BOUNDARY Œil droit, limite inférieure.
RIGHT_EYE_LEFT_CORNER Œil droit, coin gauche.
LEFT_EYEBROW_UPPER_MIDPOINT Sourcil gauche, point médian supérieur.
RIGHT_EYEBROW_UPPER_MIDPOINT Sourcil droit, point médian supérieur.
LEFT_EAR_TRAGION Tragus de l'oreille gauche.
RIGHT_EAR_TRAGION Tragus de l'oreille droite.
LEFT_EYE_PUPIL Pupille de l'œil gauche.
RIGHT_EYE_PUPIL Pupille de l'œil droit.
FOREHEAD_GLABELLA Glabelle.
CHIN_GNATHION Gnathion du menton.
CHIN_LEFT_GONION Gonion à gauche du menton.
CHIN_RIGHT_GONION Gonion à droite du menton.

Feature

Type de détection de l'API Google Cloud Vision à effectuer, et nombre maximal de résultats à renvoyer pour ce type. Vous pouvez définir plusieurs objets Feature dans la liste features.

Champs
type

Type

Type de fonctionnalité.

max_results

int32

Nombre maximal de résultats de ce type. Ne s'applique pas à TEXT_DETECTION, DOCUMENT_TEXT_DETECTION ou CROP_HINTS.

model

string

Modèle à utiliser pour la fonctionnalité. Valeurs acceptées : "builtin/stable" (valeur par défaut si non défini) et "builtin/latest".

Type

Type de fonctionnalité de l'API Google Cloud Vision à extraire.

Enums
TYPE_UNSPECIFIED Type de fonctionnalité non spécifié.
FACE_DETECTION Exécute la détection de visages.
LANDMARK_DETECTION Exécute la détection de points de repère.
LOGO_DETECTION Exécute la détection de logos.
LABEL_DETECTION Exécute la détection de thèmes.
TEXT_DETECTION Exécute la détection de texte et la reconnaissance optique des caractères (OCR). La détection de texte est optimisée pour les zones de texte au sein d'une grande image. Si l'image est un document, utilisez plutôt DOCUMENT_TEXT_DETECTION.
DOCUMENT_TEXT_DETECTION Exécute l'OCR dans un document texte dense. Prioritaire lorsque DOCUMENT_TEXT_DETECTION et TEXT_DETECTION sont présents.
SAFE_SEARCH_DETECTION Exécute des requêtes de recherches sécurisées pour détecter du contenu potentiellement dangereux ou indésirable.
IMAGE_PROPERTIES Calcule un ensemble de propriétés d'image, telles que les couleurs dominantes de l'image.
CROP_HINTS Exécute des suggestions de cadrage.
WEB_DETECTION Exécute la détection Web.
OBJECT_LOCALIZATION Lance la localisation pour détecter des objets.

GcsDestination

Emplacement Google Cloud Storage dans lequel la sortie est écrite.

Champs
uri

string

URI Google Cloud Storage où seront stockés les résultats. Les résultats sont au format JSON et sont précédés de l'URI d'entrée correspondant. Ce champ peut représenter un seul fichier ou un préfixe pour plusieurs sorties. Les préfixes doivent se terminer par /.

Par exemple :

Si plusieurs sorties existent, toutes les réponses contiennent "AnnotateFileResponse", chacune incluant un sous-ensemble de la liste complète de AnnotateImageResponse. Plusieurs sorties peuvent être générées si, par exemple, la sortie JSON est trop volumineuse et qu'elle est répartie en plusieurs fichiers segmentés.

GcsSource

Emplacement Google Cloud Storage dans lequel l'entrée est lue.

Champs
uri

string

URI Google Cloud Storage du fichier d'entrée. Il ne peut s'agir que d'un objet Google Cloud Storage. Les caractères génériques ne sont pas acceptés pour le moment.

GetProductRequest

Message de requête pour la méthode GetProduct.

Champs
name

string

Nom de la ressource Product à récupérer.

Format : projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

GetProductSetRequest

Message de requête pour la méthode GetProductSet.

Champs
name

string

Nom de la ressource ProductSet à récupérer.

Format : projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

GetReferenceImageRequest

Message de requête pour la méthode GetReferenceImage.

Champs
name

string

Nom de la ressource ReferenceImage à récupérer.

Format :

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

Image

Image client sur laquelle effectuer les tâches de l'API Google Cloud Vision.

Champs
content

bytes

Contenu de l'image représenté sous forme de flux d'octets. Remarque : comme pour tous les champs bytes, les protobuffers utilisent une représentation binaire pure, tandis que les représentations JSON sont encodées en base64.

source

ImageSource

Emplacement de l'image Google Cloud Storage ou URL de l'image accessible au public. Si une image contient les champs content et source, content est prioritaire et est utilisé pour effectuer la requête d'annotation d'image.

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.

Champs
uri

string

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

page_number

int32

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.

ImageContext

Contexte de l'image et/ou paramètres spécifiques à une fonctionnalité.

Champs
lat_long_rect

LatLongRect

Non utilisé.

language_hints[]

string

Liste des langues à utiliser pour TEXT_DETECTION. Dans la plupart des cas, une valeur vide donne de meilleurs résultats, car elle active la détection automatique de la langue. Pour les langues basées sur l'alphabet latin, le paramètre language_hints n'est pas nécessaire. Dans de rares cas, lorsque la langue du texte de l'image est connue, le réglage de ce paramètre aide à obtenir de meilleurs résultats (bien que cela nuise fortement au fonctionnement du service si sa valeur est erronée). La détection de texte renvoie une erreur si une ou plusieurs des langues spécifiées ne font pas partie des langues compatibles.

crop_hints_params

CropHintsParams

Paramètres de la requête d'annotation de suggestions de cadrage.

product_search_params

ProductSearchParams

Paramètres de la recherche de produits.

web_detection_params

WebDetectionParams

Paramètres de la détection Web.

ImageProperties

Stocke les propriétés de l'image, telles que les couleurs dominantes.

Champs
dominant_colors

DominantColorsAnnotation

Si ce champ est présent, les couleurs dominantes ont bien été identifiées.

ImageSource

Source externe de l'image (emplacement Google Cloud Storage ou URL Web).

Champs
gcs_image_uri

string

Utilisez plutôt image_uri.

URI Google Cloud Storage au format gs://bucket_name/object_name. La gestion des versions d'objets n'est pas acceptée. Pour en savoir plus, consultez la page URI de requêtes Google Cloud Storage.

image_uri

string

URI de l'image source. Peut être soit :

  1. Un URI Google Cloud Storage au format gs://bucket_name/object_name. La gestion des versions d'objets n'est pas acceptée. Pour en savoir plus, consultez la page URI de requêtes Google Cloud Storage.

  2. URL d'image HTTP/HTTPS accessible au public. Lorsque les images sont récupérées par le biais d'URL HTTP/HTTPS, Google ne peut pas garantir que la requête sera traitée. La requête peut échouer si l'hébergeur la rejette (par exemple, en raison de mesures de limitation du trafic ou de protection contre les attaques DoS) ou si Google limite l'accès au site afin d'empêcher tout abus. Vos applications de production ne doivent pas dépendre d'images hébergées en externe.

Lorsque les champs gcs_image_uri et image_uri sont spécifiés, image_uri est prioritaire.

ImportProductSetsGcsSource

Emplacement Google Cloud Storage d'un fichier CSV contenant une liste de messages ImportProductSetRequests sur chaque ligne.

Champs
csv_file_uri

string

URI Google Cloud Storage du fichier CSV d'entrée.

L'URI doit commencer par gs://.

Le fichier CSV d'entrée doit inclure une image par ligne. Chaque ligne contient huit colonnes.

  1. image-uri
  2. image-id
  3. product-set-id
  4. product-id
  5. product-category
  6. product-display-name
  7. labels
  8. bounding-poly

Les colonnes image-uri, product-set-id, product-id et product-category sont obligatoires. Toutes les autres colonnes sont facultatives.

Si les ressources ProductSet ou Product spécifiées par les valeurs product-set-id et product-id n'existent pas, le système crée une ressource ProductSet ou Product pour l'image. Dans ce cas, la colonne product-display-name fait référence à display_name, la colonne product-category à product_category et la colonne labels à product_labels.

La colonne image-id est facultative, mais doit être unique si elle est fournie. Si elle est vide, le système attribue automatiquement un identifiant unique à l'image.

La colonne product-display-name est facultative. Si elle est vide, le système définit le champ display_name du produit sur une espace (" "). Vous pouvez mettre à jour le champ display_name ultérieurement à l'aide de l'API.

Si une ressource Product possède déjà une colonne product-id, le système ignore les colonnes product-display-name, product-category et labels.

La colonne labels (facultative) est une ligne contenant une liste de paires clé/valeur séparées par des virgules, au format suivant :

"key_1=value_1,key_2=value_2,...,key_n=value_n"

La colonne bounding-poly (facultative) permet d'identifier une zone d'intérêt sur l'image de la même manière que CreateReferenceImage. Si vous ne spécifiez pas la colonne bounding-poly, le système tente de détecter automatiquement les zones d'intérêt.

Une seule colonne bounding-poly est autorisée par ligne. Si l'image contient plusieurs zones d'intérêt, ajoutez une ligne au fichier CSV contenant les mêmes informations sur le produit et les valeurs bounding-poly de chaque zone d'intérêt.

La colonne bounding-poly doit contenir un nombre pair de nombres séparés par des virgules, au format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Utilisez des nombres entiers non négatifs pour les polygones de délimitation absolus et des valeurs flottantes comprises dans la plage [0, 1] pour les polygones de délimitation normalisés.

Le système redimensionne l'image si sa résolution est trop élevée pour être traitée (plus de 20 Mpx).

ImportProductSetsInputConfig

Contenu d'entrée de la méthode ImportProductSets.

Champs
gcs_source

ImportProductSetsGcsSource

Emplacement Google Cloud Storage d'un fichier CSV contenant une liste de messages ImportProductSetRequests sur chaque ligne.

ImportProductSetsRequest

Message de requête pour la méthode ImportProductSets.

Champs
parent

string

Projet dans lequel les ressources ProductSet doivent être importées.

Format : projects/PROJECT_ID/locations/LOC_ID

input_config

ImportProductSetsInputConfig

Contenu d'entrée pour la liste de requêtes.

ImportProductSetsResponse

Message de réponse pour la méthode ImportProductSets.

Ce message est renvoyé par la méthode google.longrunning.Operations.GetOperation dans le champ google.longrunning.Operation.response.

Champs
reference_images[]

ReferenceImage

Liste des champs "reference_images" qui ont bien été importés.

statuses[]

Status

État RPC de chaque requête ImportProductSet, y compris les réussites et les erreurs.

Le nombre d'états indiqué ici correspond au nombre de lignes du fichier CSV. L'état [i] stocke l'état de réussite ou d'échec du traitement de la ligne [i] du fichier CSV, en partant de la ligne 0.

InputConfig

Emplacement d'entrée et métadonnées souhaités.

Champs
gcs_source

GcsSource

Emplacement Google Cloud Storage à partir duquel lire l'entrée.

mime_type

string

Type de fichier. Actuellement, seuls les fichiers "application/pdf" et "image/tiff" sont acceptés. Les caractères génériques ne peuvent pas être utilisés.

LatLongRect

Rectangle déterminé par des paires LatLng minimales et maximales.

Champs
min_lat_lng

LatLng

Paire latitude/longitude minimale.

max_lat_lng

LatLng

Paire latitude/longitude maximale.

Likelihood

Représentation divisée en buckets selon le degré de vraisemblance, ce qui permet d'offrir aux clients des résultats très stables entre les mises à niveau de modèles.

Enums
UNKNOWN Probabilité inconnue.
VERY_UNLIKELY Il est très peu probable que l'image appartienne au secteur spécifié.
UNLIKELY Il est peu probable que l'image appartienne au secteur spécifié.
POSSIBLE Il est possible que l'image appartienne au secteur spécifié.
LIKELY Il est probable que l'image appartienne au secteur spécifié.
VERY_LIKELY Il est très probable que l'image appartienne au secteur spécifié.

ListProductSetsRequest

Message de requête pour la méthode ListProductSets.

Champs
parent

string

Projet à partir duquel les ressources ProductSet doivent être répertoriées.

Format : projects/PROJECT_ID/locations/LOC_ID

page_size

int32

Le nombre maximum d'éléments à renvoyer. 10 par défaut, 100 au maximum.

page_token

string

Valeur "next_page_token" renvoyée par une requête "List" précédente, le cas échéant.

ListProductSetsResponse

Message de réponse pour la méthode ListProductSets.

Champs
product_sets[]

ProductSet

Liste des ressources ProductSet.

next_page_token

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

ListProductsInProductSetRequest

Message de requête pour la méthode ListProductsInProductSet.

Champs
name

string

Ressource ProductSet pour laquelle les ressources Product doivent être récupérées.

Format : projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

page_size

int32

Le nombre maximum d'éléments à renvoyer. 10 par défaut, 100 au maximum.

page_token

string

Valeur "next_page_token" renvoyée par une requête "List" précédente, le cas échéant.

ListProductsInProductSetResponse

Message de réponse pour la méthode ListProductsInProductSet.

Champs
products[]

Product

Liste des ressources Product.

next_page_token

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

ListProductsRequest

Message de requête pour la méthode ListProducts.

Champs
parent

string

Projet OU ressource ProductSet à partir duquel les ressources Product doivent être répertoriées.

Format : projects/PROJECT_ID/locations/LOC_ID

page_size

int32

Le nombre maximum d'éléments à renvoyer. 10 par défaut, 100 au maximum.

page_token

string

Valeur "next_page_token" renvoyée par une requête "List" précédente, le cas échéant.

ListProductsResponse

Message de réponse pour la méthode ListProducts.

Champs
products[]

Product

Liste des produits.

next_page_token

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

ListReferenceImagesRequest

Message de requête pour la méthode ListReferenceImages.

Champs
parent

string

Nom de la ressource Product contenant les images de référence.

Format : projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

page_size

int32

Le nombre maximum d'éléments à renvoyer. 10 par défaut, 100 au maximum.

page_token

string

Jeton identifiant une page de résultats à renvoyer. Il s'agit de la valeur nextPageToken renvoyée par une requête précédente permettant de répertorier les images de référence.

Si ce champ n'est pas spécifié, la première page est la valeur par défaut.

ListReferenceImagesResponse

Message de réponse pour la méthode ListReferenceImages.

Champs
reference_images[]

ReferenceImage

Liste des images de référence.

page_size

int32

Le nombre maximum d'éléments à renvoyer. 10 par défaut, 100 au maximum.

next_page_token

string

Valeur "next_page_token" renvoyée par une requête "List" précédente, le cas échéant.

LocalizedObjectAnnotation

Ensemble d'objets détectés avec des cadres de délimitation.

Champs
mid

string

ID d'objet conforme au champ "mid" d'EntityAnnotation.

language_code

string

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

name

string

Nom d'objet, exprimé dans sa langue language_code.

score

float

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

bounding_poly

BoundingPoly

Zone de l'image à laquelle appartient cet objet. Ces informations doivent être renseignées.

LocationInfo

Informations sur l'emplacement de l'entité détectée.

Champs
lat_lng

LatLng

Coordonnées de latitude et de longitude de l'emplacement.

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.

Champs
x

float

Coordonnées X.

y

float

Coordonnées Y.

Zero coordinate values


The general format for bounding polys in the JSON response when detected is an array of 4 vertex objects:
  • [{"x": 0.063,"y": 0.018},{"x": 0.123,"y": 0.018},{"x": 0.123,"y": 0.038},{"x": 0.063,"y": 0.038}]
When the API detects a coordinate ("x" or "y") value of 0.0, that coordinate is omitted in the JSON response. For example, a response could take the following form: [{},{"x": 0.028}, {"x": 0.028,"y": 0.043},{"y": 0.043}]. This response shows all three representation possibilities:
  • {} - an empty object when both "x":0.0 and "y":0.0.
  • {"x": 0.028} and {"y": 0.043} - an object with a single key-value pair when one coordinate is 0.0 but the other is a non-zero value.
  • {"x": 0.028,"y": 0.043} - an object with both key-value pairs when both coordinates have a non-zero value.

OperationMetadata

Contient des métadonnées pour l'opération BatchAnnotateImages.

Champs
state

State

État actuel de l'opération par lot.

create_time

Timestamp

Date/heure de réception de la requête par lot.

update_time

Timestamp

Date/heure de la dernière mise à jour du résultat de l'opération.

State

État de l'opération par lot.

Énumérations
STATE_UNSPECIFIED Non valide.
CREATED Requête reçue.
RUNNING Requête en cours de traitement.
DONE Fin du traitement par lot.
CANCELLED Annulation du traitement par lot.

OutputConfig

Emplacement de sortie et métadonnées souhaités.

Champs
gcs_destination

GcsDestination

Emplacement Google Cloud Storage dans lequel écrire les sorties.

batch_size

int32

Nombre maximal de fichiers .proto de réponse à placer dans chaque fichier JSON de sortie sur Google Cloud Storage. La plage valide est [1, 100]. Si aucune valeur n'est spécifiée, la valeur par défaut est 20.

Par exemple, pour un fichier PDF de 100 pages, 100 fichiers .proto de réponse sont générés. Si le champ batch_size est égal à 20, cinq fichiers JSON contenant chacun 20 fichiers .proto de réponse sont écrits sous le préfixe gcs_destination.uri.

Actuellement, le champ "batch_size" ne s'applique qu'à l'emplacement GcsDestination. Il est possible qu'il soit prochainement compatible avec d'autres configurations de sortie.

Page

Page détectée par l'OCR.

Champs
property

TextProperty

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

width

int32

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

int32

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[]

Block

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

confidence

float

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

Paragraph

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

Champs
property

TextProperty

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

bounding_box

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 est toujours (0, 1, 2, 3).

words[]

Word

Liste des mots du paragraphe.

confidence

float

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

Position

Position en 3D dans l'image, servant principalement pour les points de repère de la détection de visages. Une position valide doit contenir des coordonnées x et y. Les coordonnées de position sont à la même échelle que l'image d'origine.

Champs
x

float

Coordonnées X.

y

float

Coordonnées Y.

z

float

Coordonnées Z (ou profondeur).

Product

Une ressource Product contient des ressources ReferenceImage.

Champs
name

string

Nom de la ressource Product.

Format : projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

Ce champ est ignoré lors de la création d'un produit.

display_name

string

Nom de la ressource Product fourni par l'utilisateur. Ce champ ne peut pas être vide. Doit contenir au maximum 4 096 caractères.

description

string

Métadonnées fournies par l'utilisateur à stocker avec le produit. Doit contenir au maximum 4 096 caractères.

product_category

string

Catégorie du produit identifié par l'image de référence. La valeur doit être "homegoods", "apparel" ou "toys".

Ce champ est immuable.

product_labels[]

KeyValue

Paires clé/valeur pouvant être associées à un produit. Au moment de la requête, les contraintes peuvent être spécifiées en fonction du champ "product_labels".

Notez que les valeurs entières peuvent être fournies sous forme de chaînes, par exemple "1199". Seules les chaînes comportant des valeurs entières peuvent correspondre à une restriction basée sur une plage (bientôt disponible).

Plusieurs valeurs peuvent être attribuées à la même clé. Un produit peut contenir jusqu'à 100 champs "product_labels".

KeyValue

Libellé de produit représenté sous forme de paire clé/valeur.

Champs
key

string

Clé du libellé associé au produit. Ce champ doit être renseigné et ne peut pas dépasser 128 octets.

value

string

Valeur du libellé associé au produit. Ce champ doit être renseigné et ne peut pas dépasser 128 octets.

ProductSearchParams

Paramètres pour une requête de recherche de produits.

Champs
bounding_poly

BoundingPoly

Polygone de délimitation autour de la zone d'intérêt dans l'image. Facultatif. Si ce champ n'est pas spécifié, la décision est prise à la seule discrétion du système.

product_set

string

Nom d'une ressource ProductSet à rechercher pour des images similaires.

Format : projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

product_categories[]

string

Liste des catégories de produits dans lesquelles effectuer la recherche. Actuellement, seule la première catégorie est prise en compte. Vous devez spécifier "homegoods", "apparel" ou "toys".

filter

string

Expression de filtrage permettant de limiter les résultats de recherche en fonction des libellés de la ressource Product. Nous acceptons actuellement les opérateurs AND et OU dans les expressions clé/valeur, où chaque expression contenue dans une condition OR doit avoir la même clé.

Par exemple, "(color = red OR color = blue) AND brand = Google" est acceptable, mais pas "(color = red OR brand = Google)" ni "color: red".

ProductSearchResults

Résultats d'une requête de recherche de produits.

Champs
index_time

Timestamp

Horodatage de l'index ayant fourni les résultats. Les modifications apportées après cette date ne sont pas reflétées dans les résultats actuels.

results[]

Result

Liste des résultats, un pour chaque correspondance de produit.

product_grouped_results[]

GroupedResult

Liste des résultats regroupés par produits détectés dans l'image de la requête. Chaque entrée correspond à un polygone de délimitation dans l'image de la requête et contient les produits correspondants spécifiques à cette région. Il peut y avoir des doublons de correspondances de produits si vous regroupez tous les résultats par produit.

GroupedResult

Informations sur des produits semblables à un seul produit dans une image de requête.

Champs
bounding_poly

BoundingPoly

Polygone de délimitation autour du produit détecté dans l'image de la requête.

results[]

Result

Liste des résultats, un pour chaque correspondance de produit.

Résultat

Informations sur un produit.

Champs
product

Product

Ressource Product.

score

float

Niveau de confiance de la correspondance, compris entre 0 (aucune confiance) et 1 (confiance totale).

image

string

Nom de ressource de l'image à partir du produit qui correspond le mieux à la requête.

ProductSet

Une ressource ProductSet contient des ressources Product. Elle peut également inclure jusqu'à un million d'images de référence. Si la limite est dépassée, l'indexation périodique échoue.

Champs
name

string

Nom de la ressource ProductSet.

Format : projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

Ce champ est ignoré lors de la création d'une ressource ProductSet.

display_name

string

Nom de la ressource ProductSet fourni par l'utilisateur. Ce champ ne peut pas être vide. Doit contenir au maximum 4 096 caractères.

index_time

Timestamp

Uniquement en sortie. Heure de la dernière indexation de la ressource ProductSet. Les résultats de la requête reflètent toutes les mises à jour précédant cette date. Si la ressource ProductSet n'a jamais été indexée, cet horodatage est la valeur par défaut "1970-01-01T00:00:00Z".

Ce champ est ignoré lors de la création d'une ressource ProductSet.

index_error

Status

Uniquement en sortie. Si une erreur s'est produite lors de l'indexation de l'ensemble de produits, le champ est renseigné.

Ce champ est ignoré lors de la création d'une ressource ProductSet.

Valeur

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

Champs
name

string

Nom de la propriété.

value

string

Valeur de la propriété.

uint64_value

uint64

Valeur des propriétés numériques.

ReferenceImage

Une image de référence (ReferenceImage) représente une image de produit et les métadonnées qui lui sont associées, telles que les cadres de délimitation.

Champs
name

string

Nom de ressource de l'image de référence.

Format :

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

Ce champ est ignoré lors de la création d'une image de référence.

uri

string

URI Google Cloud Storage de l'image de référence.

L'URI doit commencer par gs://.

Obligatoire.

bounding_polys[]

BoundingPoly

Polygones de délimitation autour des zones d'intérêt de l'image de référence. Facultatif. Si ce champ est vide, le système tente de détecter les zones d'intérêt. Jusqu'à 10 polygones de délimitation sont utilisés.

La forme fournie est convertie en rectangle non pivotant. Une fois la conversion effectuée, le petit bord du rectangle doit être supérieur ou égal à 300 pixels. Le format doit être égal ou inférieur à 1:4 (le format 1:3 est accepté, mais pas le format 1:5).

RemoveProductFromProductSetRequest

Message de requête pour la méthode RemoveProductFromProductSet.

Champs
name

string

Nom de la ressource ProductSet à modifier.

Format : projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

product

string

Nom de la ressource Product à supprimer de l'ensemble de produits.

Format : projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

SafeSearchAnnotation

Ensemble de caractéristiques liées à l'image, calculées à l'aide de méthodes de vision par ordinateur sur des domaines de recherche sécurisée (par exemple, contenu réservé aux adultes, spoofing, images médicales, violence).

Champs
adult

Likelihood

Représente la probabilité que l'image comprenne du contenu réservé aux adultes. Le contenu réservé aux adultes peut comporter des éléments tels que des scènes de nudité, des images ou des dessins animés à caractère pornographique, ou des activités à caractère sexuel.

spoof

Likelihood

Probabilité de spoofing. Probabilité qu'une modification ait été apportée à la version canonique de l'image pour la rendre amusante ou choquante.

medical

Likelihood

Probabilité de présence d'images médicales.

violence

Likelihood

Probabilité que l'image comprenne du contenu violent.

racy

Likelihood

Probabilité que l'image de la requête comporte du contenu pour adultes. Le contenu réservé aux adultes peut inclure, mais sans s'y limiter, des tenues courtes ou transparentes, des scènes de nudité habilement dissimulée, des poses obscènes ou provocantes, ou des gros plans de zones intimes du corps.

Symbole

Représentation d'un seul symbole.

Champs
property

TextProperty

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

bounding_box

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 est toujours (0, 1, 2, 3).

text

string

Représentation actuelle du symbole en UTF-8.

confidence

float

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

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 également posséder ses propres propriétés. Les propriétés décrivent les langues détectées, les sauts, etc. Pour en savoir plus, consultez la définition du message TextAnnotation.TextProperty ci-dessous.

Champs
pages[]

Page

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

text

string

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

DetectedBreak

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

Champs
type

BreakType

Type de saut détecté.

is_prefix

bool

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.

DetectedLanguage

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

Champs
language_code

string

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

confidence

float

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

TextProperty

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

Champs
detected_languages[]

DetectedLanguage

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

detected_break

DetectedBreak

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

UpdateProductRequest

Message de requête pour la méthode UpdateProduct.

Champs
product

Product

Ressource Product qui remplace celle du serveur. "product.name" est immuable.

update_mask

FieldMask

Masque de champ (FieldMask) spécifiant les champs à mettre à jour. Si le champ "update_mask" n'est pas spécifié, tous les champs modifiables doivent être mis à jour. Les chemins d'accès aux masques valides sont product_labels, display_name et description.

UpdateProductSetRequest

Message de requête pour la méthode UpdateProductSet.

Champs
product_set

ProductSet

Ressource ProductSet qui remplace celle du serveur.

update_mask

FieldMask

Masque de champ (FieldMask) spécifiant les champs à mettre à jour. Si le champ "update_mask" n'est pas spécifié, tous les champs modifiables doivent être mis à jour. Le chemin d'accès au masque valide est display_name.

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.

Champs
x

int32

Coordonnées X.

y

int32

Coordonnées Y.

Zero coordinate values


The general format for bounding polys in the JSON response when detected is an array of 4 vertex objects:
  • [{"x": 63,"y": 18},{"x": 123,"y": 18},{"x": 123,"y": 38},{"x": 63,"y": 38}]
When the API detects a coordinate ("x" or "y") value of 0, that coordinate is omitted in the JSON response. For example, a response could take the following form: [{},{"x": 28}, {"x": 28,"y": 43},{"y": 43}]. This response shows all three representation possibilities:
  • {} - an empty object when both "x":0 and "y":0.
  • {"x": 28} and {"y": 43} - an object with a single key-value pair when one coordinate is 0 but the other is a non-zero value.
  • {"x": 28,"y": 43} - an object with both key-value pairs when both coordinates have a non-zero value.

WebDetection

Informations pertinentes sur une image provenant d'Internet.

Champs
web_entities[]

WebEntity

Entités issues d'images similaires sur Internet.

full_matching_images[]

WebImage

Images identiques provenant d'Internet. Peut inclure des copies redimensionnées de l'image de la requête.

partial_matching_images[]

WebImage

Images à correspondance partielle provenant d'Internet. Ces images sont suffisamment similaires pour partager certaines fonctionnalités clés. Par exemple, une image d'origine peut avoir une correspondance partielle si elle est associée à une zone de recadrage.

pages_with_matching_images[]

WebPage

Pages Web contenant les images correspondantes issues d'Internet.

visually_similar_images[]

WebImage

Résultats d'images visuellement similaires.

best_guess_labels[]

WebLabel

Meilleure estimation du service par rapport au thème de l'image de la requête. Elle est déduite à partir d'images similaires sur le Web ouvert.

WebEntity

Entité extraite d'images similaires sur Internet.

Champs
entity_id

string

ID d'entité opaque.

score

float

Score de pertinence global de l'entité. Non normalisé et non comparable entre différentes requêtes d'images.

description

string

Description canonique de l'entité en anglais.

WebImage

Métadonnées des images en ligne.

Champs
url

string

URL de l'image du résultat.

score

float

(Obsolète) Score de pertinence global de l'image.

WebLabel

Libellé permettant de fournir des métadonnées supplémentaires pour la détection Web.

Champs
label

string

Libellé pour les métadonnées supplémentaires.

language_code

string

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

WebPage

Métadonnées des pages Web.

Champs
url

string

URL de la page Web de résultat.

score

float

(Obsolète) Score de pertinence global de la page Web.

page_title

string

Le titre de la page Web peut contenir des balises HTML.

full_matching_images[]

WebImage

Images identiques sur la page. Peut inclure des copies redimensionnées de l'image de la requête.

partial_matching_images[]

WebImage

Images à correspondance partielle sur la page. Ces images sont suffisamment similaires pour partager certaines fonctionnalités clés. Par exemple, une image d'origine peut avoir une correspondance partielle si elle est associée à une zone de recadrage.

WebDetectionParams

Paramètres d'une requête de détection Web.

Champs
include_geo_results

bool

Indique si les résultats provenant des informations géographiques de l'image doivent être inclus.

Word

Représentation d'un mot.

Champs
property

TextProperty

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

bounding_box

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[]

Symbol

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

confidence

float

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