Vous pouvez utiliser des filtres pour renvoyer des résultats plus spécifiques lorsque vous répertoriez des ressources, des évaluations ou des opérations.
Opérations
Vous pouvez filtrer les opérations répertoriées à l'aide des paramètres suivants :
Filtres
operation_id
: renvoie toutes les opérations dont l'ID est identique à la valeur fournie. Vous pouvez également spécifier des opérations qui ne sont pas identiques (!=
) à une certaine valeur.done
: renvoie toutes les opérations dont l'état est"done": true
. Vous pouvez également spécifier des opérations toujours en cours (dont l'état n'est pas"done"
).Requêtes :
?filter="done=true"
?filter="done!=true"
worksOn
: renvoie toutes les opérations qui fonctionnent sur une ressource (ensemble de données ou modèle). Vous pouvez également spécifier des opérations qui ne sont pas identiques (!=
) à une certaine valeur.Requêtes :
- ensemble de données –
?filter="worksOn=projects/project-id/locations/us-central1/datasets/dataset-id"
- modèle –
?filter="worksOn=projects/project-id/locations/us-central1/models/model-id"
- ensemble de données –
Paramètres de requête supplémentaires
pageSize
: limite les résultats renvoyés à un nombre défini de lignes. Si ce paramètre n'est pas défini, le serveur choisit une taille par défaut.pageToken
: jeton permettant de récupérer la page de résultats suivante. Une requête initiale avec un paramètrepageSize
défini et des résultats supérieurs à la taille de cette page renvoie également le jetonnextPageToken
. Ce jeton peut ensuite être transmis àpageToken
pour obtenir les résultats suivants.
L'exemple de code de ligne de commande suivant montre comment filtrer les opérations répertoriées de manière à n'afficher que les opérations terminées (dont l'état est "done": true
).
Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :
- project-id: votre projet Google Cloud Platform ID.
Méthode HTTP et URL :
GET https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/operations?filter="done=true"
Pour envoyer votre requête, choisissez l'une des options suivantes :
curl
Exécutez la commande suivante :
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "x-goog-user-project: project-id" \
"https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/operations?filter="done=true""
PowerShell
Exécutez la commande suivante :
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "project-id" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/operations?filter="done=true"" | Select-Object -Expand Content
Si la requête aboutit, le serveur affiche un code d'état HTTP 200 OK
et la réponse au format JSON.
La réponse suivante provient d'un projet avec plusieurs opérations AutoML, filtrées pour n'afficher que les opérations terminées (?filter="done=true"
).
Paramètres de requête supplémentaires
Pour effectuer une requête avec d'autres paramètres (pageSize
, pageToken
), ajoutez le paramètre à l'URL :
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/model/model-id/modelEvaluations?pageSize=INT
Vous pouvez également concaténer des paramètres avec une esperluette (&
) :
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/model/model-id/modelEvaluations?filter="done=true&pageSize=INT&pageToken=next-page-token"
Ensembles de données
Vous pouvez filtrer les ensembles de données répertoriés à l'aide des paramètres suivants :
Filtres
dataset_metadata
: renvoie tous les ensembles de données avec le type de métadonnées cible.
Paramètres de requête supplémentaires
pageSize
: limite les résultats renvoyés à un nombre défini de lignes. Si ce paramètre n'est pas défini, le serveur choisit une taille par défaut.pageToken
: jeton permettant de récupérer la page de résultats suivante. Une requête initiale avec un paramètrepageSize
défini et des résultats supérieurs à la taille de cette page renvoie également le jetonnextPageToken
. Ce jeton peut ensuite être transmis àpageToken
pour obtenir les résultats suivants.
L'exemple de code de ligne de commande suivant montre comment filtrer les ensembles de données répertoriés à l'aide de dataset_metadata
.
Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :
- project-id: votre projet Google Cloud Platform ID.
- dataset-metadata-value : le type de
dataset_metadata
que vous filtrez. Ces valeurs dépendent du type de problème AutoML.
Méthode HTTP et URL :
GET https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/datasets?filter="dataset-metadata-value"
Pour envoyer votre requête, choisissez l'une des options suivantes :
curl
Exécutez la commande suivante :
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "x-goog-user-project: project-id" \
"https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/datasets?filter="dataset-metadata-value""
PowerShell
Exécutez la commande suivante :
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "project-id" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/datasets?filter="dataset-metadata-value"" | Select-Object -Expand Content
Si la requête aboutit, le serveur affiche un code d'état HTTP 200 OK
et la réponse au format JSON.
La réponse suivante provient d'un projet avec plusieurs types d'ensembles de données AutoML, filtrés pour n'afficher que les ensembles de données AutoML Translation (?filter="translationDatasetMetadata:*"
).
Réponse :
Paramètres de requête supplémentaires
Pour effectuer une requête avec d'autres paramètres (pageSize
, pageToken
), ajoutez le paramètre à l'URL :
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/datasets?pageSize=INT
Vous pouvez également concaténer des paramètres avec une esperluette (&
) :
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/datasets?filter="dataset-metadata-value&pageSize=INT&pageToken=next-page-token"
Modèles
Vous pouvez filtrer les modèles répertoriés à l'aide des paramètres suivants :
Filtres
model_metadata
: renvoie tous les modèles avec le type de métadonnées cible.datasetId
: renvoie tous les modèles créés à partir d'un ensemble de données spécifique.
Paramètres de requête supplémentaires
pageSize
: limite les résultats renvoyés à un nombre défini de lignes. Si ce paramètre n'est pas défini, le serveur choisit une taille par défaut.pageToken
: jeton permettant de récupérer la page de résultats suivante. Une requête initiale avec un paramètrepageSize
défini et des résultats supérieurs à la taille de cette page renvoie également le jetonnextPageToken
. Ce jeton peut ensuite être transmis àpageToken
pour obtenir les résultats suivants.
L'exemple de code de ligne de commande suivant montre comment filtrer les modèles répertoriés à l'aide de model_metadata
.
Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :
- project-id: votre projet Google Cloud Platform ID.
- model-metadata-value : le type de
model_metadata
que vous filtrez. Ces valeurs dépendent du type de problème AutoML.
Méthode HTTP et URL :
GET https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models?filter="model-metadata-value"
Pour envoyer votre requête, choisissez l'une des options suivantes :
curl
Exécutez la commande suivante :
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "x-goog-user-project: project-id" \
"https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models?filter="model-metadata-value""
PowerShell
Exécutez la commande suivante :
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "project-id" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models?filter="model-metadata-value"" | Select-Object -Expand Content
Si la requête aboutit, le serveur affiche un code d'état HTTP 200 OK
et la réponse au format JSON.
La réponse suivante provient d'un projet avec plusieurs types de modèles AutoML, filtrés pour n'afficher que les modèles AutoML Natural Language (?filter="textClassificationModelMetadata:*"
).
Paramètres de requête supplémentaires
Pour effectuer une requête avec d'autres paramètres (pageSize
, pageToken
), ajoutez le paramètre à l'URL :
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models?pageSize=INT
Vous pouvez également concaténer des paramètres avec une esperluette (&
) :
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models?filter="model-metadata-value&pageSize=INT&pageToken=next-page-token"
modelEvaulations
Vous pouvez filtrer les évaluations de modèle répertoriées à l'aide des paramètres suivants :
Filtres
annotationSpecId
: renvoie toutes les évaluations de modèle dont l'ID est identique à la valeur fournie. Vous pouvez également spécifier des évaluations de modèle qui ne sont pas identiques (!=
) à une certaine valeur.
Paramètres de requête supplémentaires
pageSize
: limite les résultats renvoyés à un nombre défini de lignes. Si ce paramètre n'est pas défini, le serveur choisit une taille par défaut.pageToken
: jeton permettant de récupérer la page de résultats suivante. Une requête initiale avec un paramètrepageSize
défini et des résultats supérieurs à la taille de cette page renvoie également le jetonnextPageToken
. Ce jeton peut ensuite être transmis àpageToken
pour obtenir les résultats suivants.
L'exemple de code de ligne de commande suivant montre comment filtrer les évaluations de modèle répertoriées en spécifiant annotationSpecId
.
Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :
- project-id: votre projet Google Cloud Platform ID.
- model-id : ID du modèle pour lequel vous souhaitez obtenir des évaluations.
- annotation-spec-id : 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.
Méthode HTTP et URL :
GET https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models/model-id/modelEvaluations?filter="annotationSpecId=annotation-spec-id"
Pour envoyer votre requête, choisissez l'une des options suivantes :
curl
Exécutez la commande suivante :
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "x-goog-user-project: project-id" \
"https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models/model-id/modelEvaluations?filter="annotationSpecId=annotation-spec-id""
PowerShell
Exécutez la commande suivante :
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "project-id" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-Uri "https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models/model-id/modelEvaluations?filter="annotationSpecId=annotation-spec-id"" | Select-Object -Expand Content
Si la requête aboutit, le serveur affiche un code d'état HTTP 200 OK
et la réponse au format JSON.
La réponse suivante provient d'un projet avec plusieurs types de modèles AutoML, filtrés pour n'afficher que les évaluations d'un seul modèle (?filter="annotationSpecId=1231173747155664896"
).
Paramètres de requête supplémentaires
Pour effectuer une requête avec d'autres paramètres (pageSize
, pageToken
), ajoutez le paramètre à l'URL :
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/model/model-id/modelEvaluations?pageSize=INT
Vous pouvez également concaténer des paramètres avec une esperluette (&
) :
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/model/model-id/modelEvaluations?filter="annotationSpecId=annotation-spec-id&pageSize=INT&pageToken=next-page-token"