Cette documentation concerne AutoML Video Intelligence, qui est différente de Vertex AI. Si vous utilisez Vertex AI, consultez la documentation de Vertex AI.

Package google.cloud.automl.v1beta1

Index

AutoMl

API AutoML Server.

Les noms de ressources sont attribués par le serveur. Le serveur ne réutilise jamais les noms qu'il a créés après la suppression des ressources portant ces noms.

L'ID de ressource est la dernière composante du nom de ressource de l'élément. Pour projects/{project_id}/locations/{location_id}/datasets/{dataset_id}, l'ID de l'élément est {dataset_id}.

Actuellement, le seul élément location_id accepté est "us-central1".

Quelle que soit l'entrée documentée pour un paramètre de chaîne attendu dans "snake_case" ou "kebab-case", l'un ou l'autre de ces cas est accepté.

CreateDataset

rpc CreateDataset (CreateDatasetRequest) renvoie (Dataset).

Crée un ensemble de données.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

CreateModel

rpc CreateModel (CreateModelRequest) renvoie (Operation).

Crée un modèle. Renvoie un modèle dans le champ response à l'issue de l'opération. Lorsque vous créez un modèle, plusieurs évaluations sont créées pour ce modèle : une évaluation globale, ainsi qu'une évaluation pour chacune des spécifications d'annotation.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

DeleteDataset

rpc DeleteDataset (DeleteDatasetRequest) renvoie (Operation).

Supprime un ensemble de données et tout son contenu. Renvoie une réponse vide dans le champ response à l'issue de l'opération, ainsi que delete_details dans le champ metadata.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

DeleteModel

rpc DeleteModel (DeleteModelRequest) renvoie (Operation).

Supprime un modèle. Renvoie google.protobuf.Empty dans le champ response à l'issue de l'opération, ainsi que delete_details dans le champ metadata.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

DeployModel

rpc DeployModel (DeployModelRequest) renvoie (Operation).

Déploie un modèle. Renvoie une réponse vide dans le champ response à l'issue de l'opération.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

ExportData

rpc ExportData (ExportDataRequest) renvoie (Operation).

Exporte les données de l'ensemble de données vers un emplacement de sortie fourni. Renvoie une réponse vide dans le champ response à l'issue de l'opération.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

GetAnnotationSpec

rpc GetAnnotationSpec (GetAnnotationSpecRequest) renvoie (AnnotationSpec).

Permet d'obtenir une spécification d'annotation.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

GetDataset

rpc GetDataset (GetDatasetRequest) renvoie (Dataset).

Permet d'obtenir un ensemble de données.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

GetModel

rpc GetModel (GetModelRequest) renvoie (Model).

Permet d'obtenir un modèle.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

GetModelEvaluation

rpc GetModelEvaluation (GetModelEvaluationRequest) renvoie (ModelEvaluation).

Permet d'obtenir une évaluation du modèle.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

ImportData

rpc ImportData (ImportDataRequest) renvoie (Operation).

Importe des données dans un ensemble de données.

Vous ne pouvez appeler cette méthode que pour un ensemble de données vide.

Pour plus d'informations, consultez la section Importer des éléments dans un ensemble de données.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

ListDatasets

rpc ListDatasets (ListDatasetsRequest) renvoie (ListDatasetsResponse).

Répertorie les ensembles de données d'un projet.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

ListModelEvaluations

rpc ListModelEvaluations (ListModelEvaluationsRequest) renvoie (ListModelEvaluationsResponse).

Répertorie les évaluations de modèles.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

ListModels

rpc ListModels (ListModelsRequest) renvoie (ListModelsResponse).

Répertorie les modèles.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

UndeployModel

rpc UndeployModel (UndeployModelRequest) renvoie (Operation).

Annule le déploiement d'un modèle. Renvoie une réponse vide dans le champ response à l'issue de l'opération.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

PredictionService

API AutoML Prediction.

Quelle que soit l'entrée documentée pour un paramètre de chaîne attendu dans "snake_case" ou "kebab-case", l'un ou l'autre de ces cas est accepté.

BatchPredict

rpc BatchPredict (BatchPredictRequest) renvoie (Operation).

Effectue une prédiction par lot et renvoie l'identifiant d'une opération de longue durée. Vous pouvez demander le résultat de l'opération à l'aide de la méthode GetOperation. Une fois l'opération terminée, vous pouvez appeler GetOperation pour récupérer un résultat BatchPredictResult partir du champ response.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

Predict

rpc Predict (PredictRequest) renvoie (PredictResponse).

Non utilisé pour le suivi des objets AutoML Video Intelligence.

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, reportez-vous à la section Présentation de l'authentification.

StreamingPredictionService

API AutoML Streaming Prediction.

Quelle que soit l'entrée documentée pour un paramètre de chaîne attendu dans "snake_case" ou "kebab-case", l'un ou l'autre de ces cas est accepté.

AnnotationPayload

Contient des annotations pertinentes pour AutoML.

Champs
annotation_spec_id

string

Uniquement en sortie. L'ID de ressource de la spécification d'annotation à laquelle cette annotation se rapporte. La spécification d'annotation provient soit d'un ensemble de données ancêtre, soit de l'ensemble de données qui a servi à entraîner le modèle utilisé.

display_name

string

Uniquement en sortie. La valeur d'AnnotationSpec.display_name lors de l'entraînement du modèle. Comme ce champ renvoie une valeur définie lors de l'entraînement du modèle, la valeur renvoyée peut être différente pour différents modèles entraînés à l'aide du même ensemble de données, car le propriétaire du modèle peut mettre à jour le nom d'affichage ("display_name") entre les entraînements de deux modèles.

Champ d'union detail. Uniquement en sortie. Informations supplémentaires sur l'annotation spécifique à la solution AutoML. La valeur detail ne peut être que l'un des éléments suivants :
classification

ClassificationAnnotation

Non utilisé pour le suivi des objets AutoML Video Intelligence.

video_object_tracking

VideoObjectTrackingAnnotation

Détails d'annotation pour les prédictions de suivi des objets.

AnnotationSpec

Définition d'une annotation.

Champs
name

string

Uniquement en sortie. Le nom de ressource de la spécification d'annotation. Format :

"projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationSpecs/{annotation_spec_id}"

display_name

string

Obligatoire. Le nom de la spécification d'annotation à afficher dans l'interface. Ce nom peut comporter jusqu'à 32 caractères. Les seuls caractères autorisés sont les lettres de l'alphabet latin ASCII (A-Z et a-z), le trait de soulignement (_) et les chiffres ASCII de 0 à 9.

example_count

int32

Uniquement en sortie. Nombre d'exemples dans l'ensemble de données parent étiqueté par la spécification d'annotation.

BatchPredictInputConfig

Configuration d'entrée pour l'action BatchPredict. L'entrée est un ou plusieurs fichiers CSV stockés dans Google Cloud Storage, où les fichiers CSV sont au format suivant :

GCS_FILE_PATH,TIME_SEGMENT_START,TIME_SEGMENT_END
  • GCS_FILE_PATH identifie le chemin d'accès Google Cloud Storage à une vidéo d'une taille maximale de 50 Go et d'une durée maximale de 3 h. Extensions compatibles : .MOV, .MPEG4, .MP4, .AVI.

  • Les valeurs TIME_SEGMENT_START et TIME_SEGMENT_END doivent être comprises entre le début et la fin de la vidéo, et la fin doit être postérieure au début.

Trois lignes d'exemple :

gs://folder/video1.mp4,10,40
gs://folder/video1.mp4,20,60
gs://folder/vid2.mov,0,inf

Consultez la section Annoter des vidéos pour plus d'informations.

Champs
gcs_source

GcsSource

Emplacement Google Cloud Storage pour le contenu d'entrée

BatchPredictOperationMetadata

Détails d'une opération de prédiction par lot (BatchPredict).

Champs
input_config

BatchPredictInputConfig

Uniquement en sortie. La configuration d'entrée qui a été définie au démarrage de cette opération de prédiction par lot.

output_info

BatchPredictOutputInfo

Uniquement en sortie. Informations détaillées sur le résultat de cette opération de prédiction par lot.

BatchPredictOutputInfo

Fournit des informations détaillées sur le résultat de cette opération de prédiction par lot. Complète

[BatchPredictionOutputConfig][google.cloud.automl.v1beta1.BatchPredictionOutputConfig].

Champs
Champ d'union output_location. L'emplacement de sortie dans lequel la sortie de prédiction est écrite. output_location ne peut être que l'un des éléments suivants :
gcs_output_directory

string

Chemin d'accès complet au répertoire Google Cloud Storage créé, dans lequel le résultat de la prédiction est écrit.

bigquery_output_dataset

string

Chemin d'accès à l'ensemble de données BigQuery créé, au format bq://projectId.bqDatasetId, dans lequel le résultat de la prédiction est écrit.

BatchPredictOutputConfig

Configuration de sortie pour l'action BatchPredict.

AutoML Video Intelligence crée un répertoire spécifié dans [gcsDestination][google.cloud.automl.v1beta1.BatchPredictionOutputConfig.gcs_destination]. Le nom du répertoire est "prediction-<model-display-name>-<timestamp-of-prediction-call>", où l'horodatage est au format ISO-8601 YYYY-MM-DDThh:mm:ss.sssZ.

AutoML Video Intelligence crée un fichier nommé "video_classification.csv" dans le nouveau répertoire, ainsi qu'un fichier JSON pour chaque classification de vidéos demandée, autrement dit, pour chaque ligne du fichier CSV d'entrée.

Le format du fichier "video_classification.csv" est le suivant :

GCS_FILE_PATH,TIME_SEGMENT_START,TIME_SEGMENT_END,JSON_FILE_NAME,STATUS
  • Les éléments GCS_FILE_PATH, TIME_SEGMENT_START et TIME_SEGMENT_END correspondent aux mêmes champs du fichier CSV d'entrée.

  • JSON_FILE_NAME est le nom du fichier JSON du répertoire de sortie contenant les réponses de prédiction pour le segment temporel de la vidéo.

  • STATUS contient "OK" si la prédiction a bien été exécutée ; si ce n'est pas le cas, ce champ contient des informations d'erreur. Si STATUS n'indique pas "OK", le fichier JSON de cette prévision peut être vide ou le fichier peut ne pas exister.

Chaque fichier JSON dont le champ STATUS indique l'état "OK" contient une liste de protos "AnnotationPayload" au format JSON, qui sont les prédictions du segment temporel de la vidéo auquel le fichier est attribué dans le fichier "video_classification.csv". Tous les protos "AnnotationPayload" contiennent un champ video_classification et sont triés par le champ video_classification.type. Les types renvoyés sont déterminés par le paramètre classifaction_types de BatchPredictRequest.params.

Champs
Champ d'union destination. Obligatoire. Destination de la sortie. destination ne peut être que l'un des éléments suivants :
gcs_destination

GcsDestination

Emplacement Google Cloud Storage du répertoire dans lequel la sortie doit être écrite.

bigquery_destination

BigQueryDestination

Emplacement BigQuery dans lequel la sortie doit être écrite.

BatchPredictRequest

Message de requête pour PredictionService.BatchPredict.

Champs
name

string

Le nom du modèle demandé pour les besoins de la prédiction par lot.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.models.predict

input_config

BatchPredictInputConfig

Obligatoire. La configuration d'entrée pour la prédiction par lot.

output_config

BatchPredictOutputConfig

Obligatoire. La configuration spécifiant où les prédictions de sortie doivent être écrites.

params

map<string, string>

Les possibilités suivantes s'offrent à vous :

score_threshold

(Nombre à virgule flottante) Une valeur comprise entre 0,0 et 1,0. Lorsque le modèle effectue des prédictions pour une vidéo, il génère seulement des résultats présentant au moins ce score de confiance. La valeur par défaut est 0.

segment_classification

(Variable booléenne) Définissez ce paramètre sur "true" pour obtenir une classification au niveau du segment. AutoML Video Intelligence renvoie les étiquettes et leurs scores de confiance pour l'intégralité du segment de vidéo que l'utilisateur a spécifié dans la configuration de la requête. La valeur par défaut est "true".

shot_classification

(Variable booléenne) Définissez ce paramètre sur "true" pour obtenir une classification au niveau des plans. AutoML Video Intelligence détermine les limites de chaque plan de caméra dans l'ensemble du segment de la vidéo spécifié par l'utilisateur dans la configuration de la requête. AutoML Video Intelligence renvoie ensuite les étiquettes et leurs scores de confiance pour chaque plan détecté, ainsi que les temps de début et de fin du plan. AVERTISSEMENT : Aucune évaluation du modèle n'est effectuée pour ce type de classification. Sa qualité dépend des données d'entraînement, mais aucune métrique n'est fournie pour décrire cette qualité. La valeur par défaut est "false".

1s_interval_classification

(Variable booléenne) Définissez ce paramètre sur "true" pour obtenir une classification de la vidéo par intervalles d'une seconde. AutoML Video Intelligence renvoie les étiquettes et leurs scores de confiance pour chaque seconde de l'intégralité de la séquence vidéo que l'utilisateur a spécifiée dans la configuration de la requête. AVERTISSEMENT : Aucune évaluation du modèle n'est effectuée pour ce type de classification. Sa qualité dépend des données d'entraînement, mais aucune métrique n'est fournie pour décrire cette qualité. La valeur par défaut est "false".

Consultez la section Annoter des vidéos pour plus de détails.

BatchPredictResult

Résultat de la prédiction par lot.

Champs
metadata

map<string, string>

Métadonnées de réponse de prédiction supplémentaires spécifiques à un domaine.

BigQueryDestination

Non utilisé pour le suivi des objets AutoML Video Intelligence.

Champs
output_uri

string

Obligatoire. URI BigQuery d'un projet, 2 000 caractères au maximum. Formes acceptées : * chemin BigQuery, par exemple bq://projectId.

BoundingBoxMetricsEntry

Métriques du modèle de correspondance du cadre de délimitation pour un seuil unique "intersection-over-union" (ratio entre l'aire d'intersection et l'aire d'union) et plusieurs seuils de confiance pour la correspondance des étiquettes.

Champs
iou_threshold

float

Uniquement en sortie. Valeur du seuil "intersection-over-union" (ratio entre l'aire d'intersection et l'aire d'union) utilisé pour calculer cette entrée de métrique.

mean_average_precision

float

Uniquement en sortie. Précision moyenne, le plus souvent proche de "au_prc".

confidence_metrics_entries[]

ConfidenceMetricsEntry

Uniquement en sortie. Métriques associées à chaque seuil de confiance ("confidence_threshold") pour la correspondance des étiquettes à partir de 0,05, 0,10, …, 0,95, 0,96, 0,97, 0,98, 0,99. La courbe de précision/rappel en est dérivée.

ConfidenceMetricsEntry

Métriques pour un seul seuil de confiance.

Champs
confidence_threshold

float

Uniquement en sortie. Valeur du seuil de confiance utilisée pour calculer les métriques.

recall

float

Uniquement en sortie. Rappel sous le seuil de confiance fixé.

precision

float

Uniquement en sortie. Précision sous le seuil de confiance fixé.

f1_score

float

Uniquement en sortie. La moyenne harmonique du rappel et de la précision.

BoundingPoly

Polygone de délimitation d'un objet détecté dans un plan. En sortie, les sommets ("vertices") et les sommets normalisés ("normalized_vertices") sont fournis. Le polygone est formé en reliant les sommets dans l'ordre dans lequel ils sont répertoriés.

Champs
normalized_vertices[]

NormalizedVertex

Uniquement en sortie. Sommets normalisés du polygone de sélection.

ClassificationAnnotation

Contient des détails d'annotation spécifiques à la classification.

Champs
score

float

Uniquement en sortie. Estimation du niveau de confiance comprise entre 0,0 et 1,0. Une valeur supérieure indique une plus grande confiance dans le fait que l'annotation est positive. Si un utilisateur approuve le caractère négatif ou positif d'une annotation, la valeur "score" reste inchangée. Si un utilisateur crée une annotation, le score est 0 si elle est négative, et 1 si elle est positive.

CreateDatasetRequest

Message de requête pour AutoMl.CreateDataset.

Champs
parent

string

Nom de ressource du projet pour lequel l'ensemble de données doit être créé.

L'autorisation Google IAM suivante est requise pour la ressource parent indiquée :

  • automl.datasets.create

dataset

Dataset

L'ensemble de données à créer.

CreateModelOperationMetadata

Détails d'une opération de création de modèle (CreateModel).

CreateModelRequest

Message de requête pour AutoMl.CreateModel.

Champs
parent

string

Nom de ressource du projet parent dans lequel le modèle est créé.

L'autorisation Google IAM suivante est requise pour la ressource parent indiquée :

  • automl.models.create

model

Model

Le modèle à créer.

Ensemble de données

Espace de travail pour résoudre un problème de machine learning (ML) unique et spécifique. Un espace de travail contient des exemples pouvant être annotés.

Champs
name

string

Uniquement en sortie. Nom de ressource de l'ensemble de données. Format : projects/{project_id}/locations/{location_id}/datasets/{dataset_id}

display_name

string

Obligatoire. Le nom de l'ensemble de données à afficher dans l'interface. Ce nom peut comporter jusqu'à 32 caractères. Les seuls caractères autorisés sont les lettres de l'alphabet latin ASCII (A-Z et a-z), le trait de soulignement (_) et les chiffres ASCII de 0 à 9.

example_count

int32

Uniquement en sortie. Le nombre d'exemples dans l'ensemble de données.

create_time

Timestamp

Uniquement en sortie. Horodatage de la création de cet ensemble de données.

video_object_tracking_dataset_metadata

VideoObjectTrackingDatasetMetadata

Métadonnées d'un ensemble de données utilisé pour le suivi des objets vidéo.

DeleteDatasetRequest

Message de requête pour AutoMl.DeleteDataset.

Champs
name

string

Nom de ressource de l'ensemble de données à supprimer.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.datasets.delete

DeleteModelRequest

Message de requête pour AutoMl.DeleteModel.

Champs
name

string

Nom de ressource du modèle en cours de suppression.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.models.delete

DeleteOperationMetadata

Détails des opérations de suppression d'entités.

DeployModelOperationMetadata

Détails de l'opération de déploiement de modèle (DeployModel).

DeployModelRequest

Message de requête pour AutoMl.DeployModel.

Champs
name

string

Nom de ressource du modèle à déployer.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.models.deploy

ExamplePayload

Exemple de données utilisées pour l'entraînement ou la prédiction.

ExportDataOperationMetadata

Détails d'une opération d'exportation de données (ExportData).

Champs
output_info

ExportDataOutputInfo

Uniquement en sortie. Informations détaillées sur le résultat de l'exportation de données.

ExportDataOutputInfo

Fournit des informations détaillées sur le résultat de l'exportation de données. Complète OutputConfig.

Champs
Champ d'union output_location. L'emplacement de sortie dans lequel les données exportées sont écrites. output_location ne peut être que l'un des éléments suivants :
gcs_output_directory

string

Chemin d'accès complet au répertoire Google Cloud Storage créé, dans lequel les données exportées sont écrites.

bigquery_output_dataset

string

Chemin d'accès à l'ensemble de données BigQuery créé, au format bq://projectId.bqDatasetId, dans lequel les données exportées sont écrites.

ExportDataRequest

Message de requête pour AutoMl.ExportData.

Champs
name

string

Obligatoire. Nom de ressource de l'ensemble de données.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.datasets.export

output_config

OutputConfig

Obligatoire. L'emplacement de sortie souhaité.

GcsDestination

Emplacement Google Cloud Storage dans lequel la sortie doit être écrite.

Champs
output_uri_prefix

string

Obligatoire. URI Google Cloud Storage du répertoire de sortie, 2 000 caractères au maximum. Formes acceptées : * Chemin du préfixe : gs://bucket/directory. L'utilisateur à l'origine de la requête doit disposer de l'autorisation en écriture sur le bucket. Le répertoire est créé s'il n'existe pas.

GcsSource

L'emplacement Google Cloud Storage pour le contenu d'entrée.

Champs
input_uris[]

string

Obligatoire. URI Google Cloud Storage des fichiers d'entrée, 2 000 caractères au maximum. Formes acceptées : * Chemin complet de l'objet, par exemple gs://bucket/directory/object.csv

GetAnnotationSpecRequest

Message de requête pour AutoMl.GetAnnotationSpec.

Champs
name

string

Nom de ressource de la spécification d'annotation à récupérer.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.annotationSpecs.get

GetDatasetRequest

Message de requête pour AutoMl.GetDataset.

Champs
name

string

Nom de ressource de l'ensemble de données à récupérer.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.datasets.get

GetModelEvaluationRequest

Message de requête pour AutoMl.GetModelEvaluation.

Champs
name

string

Nom de ressource pour l'évaluation du modèle.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.modelEvaluations.get

GetModelRequest

Message de requête pour AutoMl.GetModel.

Champs
name

string

Nom de ressource du modèle.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.models.get

ImportDataOperationMetadata

Détails d'une opération d'importation de données (ImportData).

ImportDataRequest

Message de requête pour AutoMl.ImportData.

Champs
name

string

Obligatoire. Nom de l'ensemble de données. L'ensemble de données doit déjà exister. Toutes les annotations et exemples importés seront ajoutés.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.datasets.import

input_config

InputConfig

Obligatoire. L'emplacement d'entrée souhaité et sa sémantique spécifique au domaine, le cas échéant.

InputConfig

Configuration d'entrée pour l'action ImportData.

Le format de l'entrée dépend des métadonnées "dataset_metadata" de l'ensemble de données dans lequel l'importation est effectuée. La source gcs_source est attendue en tant que source d'entrée, sauf indication contraire. Si un fichier dont le contenu est identique (même si son chemin GCS_FILE_PATH est différent) est mentionné à plusieurs reprises, son étiquette, ses cadres de délimitation, etc., sont ajoutés. Un même fichier devrait toujours être fourni avec les mêmes champs ML_USE et GCS_FILE_PATH. Si ce n'est pas le cas, ces valeurs sont sélectionnées de manière non déterministe parmi les valeurs fournies.

Les formats sont représentés en EBNF (BNF étendu), avec des virgules sous forme littérale et les symboles non terminaux définis vers la fin de ce commentaire. Les formats sont :

Pour en savoir plus, consultez la page Préparer les données d'entraînement.

Fichier(s) CSV avec chaque ligne au format :

ML_USE,GCS_FILE_PATH
  • ML_USE – Identifie l'ensemble de données auquel la ligne actuelle (fichier) s'applique. Cette valeur peut être l'une des suivantes :

    • TRAIN – Les lignes de ce fichier sont utilisées pour entraîner le modèle.
    • TEST – Les lignes de ce fichier sont utilisées pour tester le modèle pendant l'entraînement.
    • UNASSIGNED – Les lignes de ce fichier ne sont pas catégorisées. Elles sont automatiquement divisées en données d'entraînement et de test (80 % pour l'entraînement et 20 % pour les tests).
  • GCS_FILE_PATH – Identifie un fichier stocké dans Google Cloud Storage contenant les informations relatives à l'entraînement du modèle.

Une fois que l'ensemble de données d'entraînement a été déterminé à partir des fichiers CSV TRAIN et UNASSIGNED, les données d'entraînement sont réparties entre l'ensemble de données d'entraînement et l'ensemble de données de validation (70 % pour l'entraînement et 30 % pour la validation).

Chaque fichier CSV spécifié à l'aide du champ GCS_FILE_PATH a le format suivant :

GCS_FILE_PATH,LABEL,TIME_SEGMENT_START,TIME_SEGMENT_END
  • GCS_FILE_PATH – Le chemin d'accès à une vidéo stockée dans Google Cloud Storage. Durée de la vidéo : jusqu'à 60 minutes. Extensions compatibles : .MOV, .MPEG4, .MP4, .AVI et tout format de fichier compatible avec ffmpeg.

  • LABEL – Une étiquette qui identifie l'objet du segment vidéo.

  • TIME_SEGMENT_START et TIME_SEGMENT_END – Les horodatages (heures de début et de fin) en secondes du segment vidéo à annoter. Ces valeurs doivent être comprises entre le début et la fin de la vidéo, et TIME_SEGMENT_END doit être postérieur à TIME_SEGMENT_START.

Toute image d'une vidéo associée à une ou plusieurs étiquettes est considérée comme un négatif fort pour toutes les autres étiquettes. Une image sans étiquette par défaut est considérée comme inconnue (peut être ignorée à l'aide du paramètre is_exhaustively_labeled). Une étiquette spéciale "-" permet d'indiquer qu'un segment de temps donné est un élément négatif fort pour toutes les étiquettes. Les segments marqués "-" ne peuvent pas chevaucher les segments d'une autre étiquette.

Exemple de fichier :

TRAIN,gs:folder/train_videos.csv
TEST,gs:folder/test_videos.csv
UNASSIGNED,gs:folder/other_videos.csv

L'exemple ci-dessous montre le format de l'un des fichiers CSV identifiés par le fichier de niveau supérieur gcsSource.

 gs:folder/video1.avi,car,120,180.000021
 gs:folder/video1.avi,bike,150,180.000023
 gs:folder/video1.avi,-,180.000024,300.000999
 gs:folder/vid2.avi,car,0,60.5

Erreurs :

Si l'un des fichiers CSV fournis ne peut pas être analysé ou s'il est impossible de traiter plus d'un certain pourcentage de lignes CSV, l'opération échoue et rien n'est importé. Indépendamment du succès ou de l'échec global, les échecs par ligne seront répertoriés dans "Operation.metadata.partial_failures" (jusqu'à un certain plafond de dénombrement).

Champs
gcs_source

GcsSource

Emplacement Google Cloud Storage pour le contenu d'entrée.

ListDatasetsRequest

Message de requête pour AutoMl.ListDatasets.

Champs
parent

string

Nom de ressource du projet à partir duquel les ensembles de données doivent être répertoriés.

L'autorisation Google IAM suivante est requise pour la ressource parent indiquée :

  • automl.datasets.list

filter

string

Expression pour filtrer les résultats de la requête.

  • dataset_metadata : teste l'existence de métadonnées.

  • display_name : =, != et regex(). Utilise la syntaxe re2.

Exemple d'utilisation du filtre :

  • video_object_tracking_dataset_metadata:* --> L'ensemble de données contient des métadonnées "video_object_tracking_dataset_metadata".

  • regex(display_name, "^A") --> Le nom d'affichage de l'ensemble de données commence par "A".

page_size

int32

Taille de la page demandée. Le serveur peut renvoyer un nombre de résultats inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une taille par défaut.

page_token

string

Jeton identifiant une page de résultats que le serveur doit renvoyer. Généralement obtenu via le paramètre ListDatasetsResponse.next_page_token de l'appel AutoMl.ListDatasets précédent.

ListDatasetsResponse

Message de réponse pour AutoMl.ListDatasets.

Champs
datasets[]

Dataset

Les ensembles de données lues.

next_page_token

string

Jeton permettant de récupérer la page de résultats suivante. Transmettez cette valeur à ListDatasetsRequest.page_token pour obtenir cette page.

ListModelEvaluationsRequest

Message de requête pour AutoMl.ListModelEvaluations.

Champs
parent

string

Nom de ressource du modèle pour lequel les évaluations de modèle doivent être répertoriées. Si modelId est défini sur "-", les évaluations de modèle de tous les modèles de l'emplacement parent seront répertoriées.

L'autorisation Google IAM suivante est requise pour la ressource parent indiquée :

  • automl.modelEvaluations.list

filter

string

Expression pour filtrer les résultats de la requête.

  • annotation_spec_id : pour =, != ou existence. Consultez l'exemple ci-dessous pour le dernier cas.

Exemples d'utilisation du filtre :

  • annotation_spec_id!=4 --> L'évaluation du modèle a été effectuée pour une spécification d'annotation dont l'ID est différent de 4.
  • NOT annotation_spec_id:* --> L'évaluation du modèle a été effectuée pour l'agrégation de toutes les spécifications d'annotation.

page_size

int32

Taille de la page demandée.

page_token

string

Jeton identifiant une page de résultats que le serveur doit renvoyer. Généralement obtenu via le paramètre ListModelEvaluationsResponse.next_page_token de l'appel AutoMl.ListModelEvaluations précédent.

ListModelEvaluationsResponse

Message de réponse pour AutoMl.ListModelEvaluations.

Champs
model_evaluation[]

ModelEvaluation

Liste des évaluations de modèles dans la page demandée.

next_page_token

string

Jeton permettant de récupérer la page de résultats suivante. Transmettez cette valeur au champ ListModelEvaluationsRequest.page_token d'une nouvelle requête AutoMl.ListModelEvaluations pour obtenir cette page.

ListModelsRequest

Message de requête pour AutoMl.ListModels.

Champs
parent

string

Nom de ressource du projet à partir duquel les modèles doivent être répertoriés.

L'autorisation Google IAM suivante est requise pour la ressource parent indiquée :

  • automl.models.list

filter

string

Expression pour filtrer les résultats de la requête.

  • model_metadata : teste l'existence de métadonnées.

  • dataset_id : = ou != --> ID d'ensemble de données.

  • display_name : =, != et regex(). Utilise la syntaxe re2.

Exemples d'utilisation du filtre :

  • video_object_tracking_model_metadata:* --> Le modèle contient des métadonnées "video_object_tracking_model_metadata".

  • dataset_id=5 --> Le modèle a été créé à partir d'un ensemble de données portant l'ID 5.

  • regex(display_name, "^A") --> Le nom d'affichage de l'ensemble de données commence par "A".

page_size

int32

Taille de la page demandée.

page_token

string

Jeton identifiant une page de résultats que le serveur doit renvoyer. Généralement obtenu via le paramètre ListModelsResponse.next_page_token de l'appel AutoMl.ListModels précédent.

ListModelsResponse

Message de réponse pour AutoMl.ListModels.

Champs
model[]

Model

Liste des modèles dans la page demandée.

next_page_token

string

Jeton permettant de récupérer la page de résultats suivante. Transmettez cette valeur à ListModelsRequest.page_token pour obtenir cette page.

Model

Fichier "API.proto" représentant un modèle de machine learning entraîné.

Champs
name

string

Uniquement en sortie. Nom de ressource du modèle. Format : projects/{project_id}/locations/{location_id}/models/{model_id}

display_name

string

Obligatoire. Le nom du modèle à afficher dans l'interface. Ce nom peut comporter jusqu'à 32 caractères. Les seuls caractères autorisés sont les lettres de l'alphabet latin ASCII (A-Z et a-z), le trait de soulignement (_) et les chiffres ASCII de 0 à 9. Il doit commencer par une lettre.

dataset_id

string

Obligatoire. ID de ressource de l'ensemble de données utilisé pour créer le modèle. L'ensemble de données doit provenir du même projet et du même emplacement ancêtres.

create_time

Timestamp

Uniquement en sortie. Horodatage de la création de ce modèle.

update_time

Timestamp

Uniquement en sortie. Horodatage de la dernière mise à jour de ce modèle.

deployment_state

DeploymentState

Uniquement en sortie. État de déploiement du modèle. Un modèle ne peut diffuser des requêtes de prédiction qu'après son déploiement.

video_object_tracking_model_metadata

VideoObjectTrackingModelMetadata

Métadonnées pour les modèles du suivi des objets vidéo.

DeploymentState

État de déploiement du modèle.

Énumérations (Enums)
DEPLOYMENT_STATE_UNSPECIFIED Ne pas utiliser ce type. Il s'agit de la valeur par défaut attribuée à une énumération non définie.
DEPLOYED Le modèle est déployé.
UNDEPLOYED Le modèle n'est pas déployé.

ModelEvaluation

Résultats d'évaluation d'un modèle.

Champs
name

string

Uniquement en sortie. Nom de ressource de l'évaluation du modèle. Format :

projects/{project_id}/locations/{location_id}/models/{model_id}/modelEvaluations/{model_evaluation_id}

annotation_spec_id

string

Uniquement en sortie. ID de la spécification d'annotation à laquelle l'évaluation du modèle s'applique. L'ID est vide pour l'évaluation globale du modèle. Pour la classification des tables, il s'agit des valeurs distinctes de la colonne cible au moment de l'évaluation. Dans ce cas, les spécifications d'annotation dans l'ensemble de données n'existent pas. REMARQUE : Il n'existe actuellement aucun moyen d'obtenir le nom à afficher "display_name" de la spécification d'annotation à partir de son ID. Pour voir les noms à afficher, consultez les évaluations du modèle dans l'interface utilisateur.

display_name

string

Uniquement en sortie. La valeur d'AnnotationSpec.display_name lors de l'entraînement du modèle. Comme ce champ renvoie une valeur définie lors de l'entraînement du modèle, la valeur renvoyée peut être différente pour différents modèles entraînés à l'aide du même ensemble de données, car le propriétaire du modèle peut mettre à jour le nom d'affichage entre les entraînements de deux modèles. Le champ display_name est vide pour l'évaluation globale du modèle.

create_time

Timestamp

Uniquement en sortie. Horodatage de la création de cette évaluation de modèle.

evaluated_example_count

int32

Uniquement en sortie. Nombre d'exemples utilisés pour l'évaluation du modèle, c'est-à-dire pour lesquels la situation réelle du moment de la création du modèle est comparée aux annotations prévues créées par le modèle. Pour le champ "ModelEvaluation" global (c'est-à-dire avec le champ "annotation_spec_id" non défini), il s'agit du nombre total de tous les exemples utilisés pour l'évaluation. Sinon, il s'agit du nombre d'exemples qui ont été réellement annotés par

annotation_spec_id.

video_object_tracking_evaluation_metrics

VideoObjectTrackingEvaluationMetrics

Métriques d'évaluation pour les modèles de suivi des objets.

NormalizedVertex

Un sommet représente un point 2D dans l'image. Les coordonnées des sommets normalisés sont comprises entre 0 et 1 fraction par rapport au plan d'origine (image, vidéo). Par exemple, si le plan (par exemple, l'image entière) a une taille de 10 x 20, un point avec des coordonnées normalisées (0,1/0,3) est à la position (1, 6) sur ce plan.

Champs
x

float

Obligatoire. Coordonnée horizontale.

y

float

Obligatoire. Coordonnée verticale.

OperationMetadata

Métadonnées utilisées dans toutes les opérations de longue durée renvoyées par l'API AutoML.

Champs
progress_percent

int32

Uniquement en sortie. Progression de l'opération. Plage : [0, 100]. Champ non utilisé à l'heure actuelle.

partial_failures[]

Status

Uniquement en sortie. Échecs partiels rencontrés. Par exemple, certains fichiers ne peuvent pas être lus. Ce champ ne doit jamais dépasser 20 entrées. Le champ des informations d'état Status.details contient des détails relatifs aux erreurs GCP standards.

create_time

Timestamp

Uniquement en sortie. Date/heure de création de l'opération.

update_time

Timestamp

Uniquement en sortie. Date/heure de la dernière mise à jour de l'opération.

Champ d'union details. Uniquement en sortie. Détails de l'opération spécifique. Même si ce champ est vide, sa présence permet de distinguer différents types d'opérations. La valeur details ne peut être que l'un des éléments suivants :
delete_details

DeleteOperationMetadata

Détails d'une opération de suppression (Delete).

deploy_model_details

DeployModelOperationMetadata

Détails d'une opération de déploiement de modèle (DeployModel).

undeploy_model_details

UndeployModelOperationMetadata

Détails d'une opération d'annulation de déploiement du modèle (UndeployModel).

create_model_details

CreateModelOperationMetadata

Détails d'une opération de création de modèle (CreateModel).

import_data_details

ImportDataOperationMetadata

Détails d'une opération d'importation de données (ImportData).

batch_predict_details

BatchPredictOperationMetadata

Détails d'une opération de prédiction par lot (BatchPredict).

export_data_details

ExportDataOperationMetadata

Détails d'une opération d'exportation de données (ExportData).

OutputConfig

Configuration de sortie pour ExportData.

En tant que destination, gcs_destination doit être défini, sauf indication contraire pour un domaine. Seules les annotations réelles sont exportées (les annotations non approuvées ne sont pas exportées).

Les sorties correspondent à la manière dont les données ont été importées et peuvent être utilisées comme entrées pour importer des données. Les formats de sortie sont représentés au format EBNF avec des virgules sous forme littérale, et les mêmes définitions de symboles non terminaux sont celles des données d'importation InputConfig.

Il s'agit d'un fichier CSV video_object_tracking.csv, avec chaque ligne au format suivant et pouvant comporter plusieurs lignes pour un seul élément ML_USE :

ML_USE,GCS_FILE_PATH

Chaque chemin d'accès GCS_FILE_PATH mène à un autre fichier .csv qui décrit des exemples qui ont obtenu ML_USE en utilisant le format de ligne suivant :

GCS_FILE_PATH,LABEL,INSTANCE_ID,TIMESTAMP,BOUNDING_BOX

Ici, les données de la colonne GCS_FILE_PATH pointent vers les emplacements sources originaux des vidéos importées.

Champs
Champ d'union destination. Obligatoire. Destination de la sortie. destination ne peut être que l'un des éléments suivants :
gcs_destination

GcsDestination

Emplacement Google Cloud Storage dans lequel la sortie doit être écrite. Pour le suivi des objets vidéo, un nouveau répertoire est créé dans le répertoire indiqué, de la même manière que l'horodatage au format ISO-8601 : YYYY-MM-DDThh:mm:ss.sssZ.


export_data-<dataset-display-name>-<timestamp-of-export-call>

Toutes les sorties exportées sont écrites dans ce répertoire.

bigquery_destination

BigQueryDestination

Emplacement BigQuery dans lequel la sortie doit être écrite.

PredictRequest

Message de requête pour PredictionService.Predict.

Champs
name

string

Le nom du modèle demandé pour les besoins de la prédiction.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.models.predict

payload

ExamplePayload

Obligatoire. Charge utile sur laquelle une prédiction doit être effectuée. La charge utile doit correspondre au type de problème pour lequel le modèle a été entraîné.

params

map<string, string>

Paramètres supplémentaires spécifiques au domaine : la longueur d'une chaîne ne doit pas dépasser 25 000 caractères.

PredictResponse

Message de réponse pour PredictionService.Predict.

Champs
payload[]

AnnotationPayload

Résultat de la prédiction.

metadata

map<string, string>

Métadonnées de réponse de prédiction supplémentaires spécifiques à un domaine.

UndeployModelOperationMetadata

Détails de l'opération d'annulation du déploiement du modèle (UndeployModel).

UndeployModelRequest

Message de requête pour AutoMl.UndeployModel.

Champs
name

string

Nom de ressource du modèle dont le déploiement doit être annulé.

L'autorisation Google IAM suivante est requise pour la ressource name indiquée :

  • automl.models.undeploy

VideoObjectTrackingAnnotation

Détails d'annotation pour le suivi des objets vidéo.

Champs
instance_id

string

Facultatif. L'instance de l'objet, exprimée sous la forme d'un entier positif. Utilisé pour faire la distinction entre les objets du même type (par exemple, AnnotationSpec) lorsque plusieurs objets sont présents dans un même exemple. REMARQUE : La qualité de la prédiction d'ID d'instance ne fait pas partie de l'évaluation du modèle et répond à un objectif d'optimisation. C'est particulièrement le cas lorsqu'une entité quitte l'écran pendant une période prolongée (minutes) : à son retour, un nouvel ID d'instance peut lui être attribué.

time_offset

Duration

Obligatoire. Heure (image) d'une vidéo à laquelle cette annotation appartient. Représenté par la durée écoulée depuis le début de la vidéo.

bounding_box

BoundingPoly

Obligatoire. Rectangle représentant l'emplacement de l'objet sur l'image (c'est-à-dire le décalage ou la valeur "time_offset" de la vidéo).

score

float

Uniquement en sortie. Niveau de confiance indiquant que cette annotation est positive pour la vidéo selon la valeur de décalage ("time_offset") ; valeur spécifiée avec [0, 1] ; une valeur élevée signifie un niveau de confiance accru. Pour les annotations créées par l'utilisateur, le score est 1. Lorsque l'utilisateur approuve une annotation, le score d'origine indiqué avec un nombre à virgule flottante est conservé (et non remplacé par 1).

VideoObjectTrackingDatasetMetadata

Métadonnées de l'ensemble de données spécifiques au suivi des objets vidéo.

VideoObjectTrackingEvaluationMetrics

Métriques d'évaluation du modèle pour les problèmes liés au suivi des objets vidéo. Évalue la qualité de la prédiction des cadres de délimitation étiquetés et des titres étiquetés (c'est-à-dire une série de cadres de délimitation partageant la même étiquette et le même ID d'instance).

Champs
evaluated_frame_count

int32

Uniquement en sortie. Nombre d'images vidéo utilisées pour créer cette évaluation.

evaluated_bounding_box_count

int32

Uniquement en sortie. Nombre total de cadres de délimitation (c'est-à-dire ajoutés sur toutes les images) réellement utilisés pour créer cette évaluation.

evaluated_track_count

int32

Uniquement en sortie. Nombre total de titres (c'est-à-dire observés dans toutes les images) réellement utilisés pour créer cette évaluation.

bounding_box_metrics_entries[]

BoundingBoxMetricsEntry

Uniquement en sortie. Métriques de correspondance des cadres de délimitation pour chaque seuil "intersection-over-union" (ratio entre l'aire d'intersection et l'aire d'union) : 0,05, 0,10, ..., 0,95, 0,96, 0,97, 0,98, 0,99 et pour chaque pair associé au seuil de confiance de l'étiquette : 0,05, 0,10, ..., 0,95, 0,96, 0,97, 0,98, 0,99.

bounding_box_mean_average_precision

float

Uniquement en sortie. Métrique unique pour l'évaluation des cadres de délimitation : précision moyenne ("mean_average_precision") sur toutes les entrées de métriques du cadre de délimitation ("bounding_box_metrics_entries").

VideoObjectTrackingModelMetadata

Métadonnées de modèle spécifiques au suivi des objets vidéo.