Filtrer lors des opérations de listage

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.

Important : En général, vous filtrez en ajoutant la syntaxe suivante à l'URL de la requête :

• ?filter="[filter_name=]filter-value" : renvoie tous les objets JSON correspondant à filter-value.
• ?filter="" : filtre non défini. Aucune correspondance n'est renvoyée.
• ?filter="*" : filtre correspondant à toutes les valeurs possibles.

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"
  • model – ?filter="worksOn=projects/project-id/locations/us-central1/models/model-id"

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ètre pageSize défini et des résultats supérieurs à la taille de cette page renvoie également le jeton nextPageToken. 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 en fonction des opérations terminées (dont l'état est "done": true).

Avant d'utiliser les données de requête, effectuez les remplacements suivants:

• project-id : votre ID de projet Google Cloud Platform.

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

Remarque : La commande suivante suppose que vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter gcloud auth list pour vérifier le compte actuellement actif.

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

Remarque : La commande suivante suppose que vous vous êtes connecté à la gcloud CLI avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter gcloud auth list pour vérifier le compte actuellement actif.

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").

Réponse

    {
  "operations": [
    {
      "name": "projects/project-id/locations/us-central1/operations/VCN1765936620487311360",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.automl.v1.OperationMetadata",
        "createTime": "2019-12-12T19:50:54.701276Z",
        "updateTime": "2019-12-12T21:44:41.398588Z",
        "createModelDetails": {}
      },
      "done": true,
      "response": {
        "@type": "type.googleapis.com/google.cloud.automl.v1.Model",
        "name": "projects/project-id/locations/us-central1/models/VCN3089482538515693568"
      }
    },
    {
      "name": "projects/project-id/locations/us-central1/operations/ICN4019988233986244608",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.automl.v1.OperationMetadata",
        "partialFailures": [
          {
            "code": 3,
            "message": "Error: gs://storage-bucket/csv/all_data.csv line 2269: The label is already a ground truth."
          },
          {
            "code": 3,
            "message": "Error: Single label example 6192816919589105442 can have at most one approved positive annotation."
          },
          {
            "code": 3,
            "message": "Error: gs://storage-bucket/csv/all_data.csv line 2267: The label is already a ground truth."
          }
        ],
        "createTime": "2019-12-12T20:24:26.992578Z",
        "updateTime": "2019-12-12T20:40:39.672070Z",
        "importDataDetails": {}
      },
      "done": true,
      "response": {
        "@type": "type.googleapis.com/google.protobuf.Empty"
      }
    },
    {
      "name": "projects/project-id/locations/us-central1/operations/TBL1400159888251813888",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.automl.v1.OperationMetadata",
        "createTime": "2019-12-11T23:08:07.315450Z",
        "updateTime": "2019-12-12T00:48:44.703974Z",
        "createModelDetails": {}
      },
      "done": true,
      "response": {
        "@type": "type.googleapis.com/google.cloud.automl.v1.Model",
        "name": "projects/project-id/locations/us-central1/models/TBL5737009781177057280"
      }
    },
    {
      "name": "projects/project-id/locations/us-central1/operations/TBL7492967234130673664",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.automl.v1.OperationMetadata",
        "createTime": "2019-12-11T23:07:36.217459Z",
        "updateTime": "2019-12-11T23:08:17.727121Z",
        "createModelDetails": {}
      },
      "done": true,
      "error": {
        "code": 1,
        "message": "CANCELLED"
      }
    },
    {
      "name": "projects/project-id/locations/us-central1/operations/TBL6841634138022215680",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.automl.v1.OperationMetadata",
        "createTime": "2019-12-11T23:02:56.089038Z",
        "updateTime": "2019-12-11T23:02:59.300928Z",
        "deleteDetails": {}
      },
      "done": true,
      "response": {
        "@type": "type.googleapis.com/google.protobuf.Empty"
      }
    },
    {
      "name": "projects/project-id/locations/us-central1/operations/TBL8322192515520266240",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.automl.v1.OperationMetadata",
        "createTime": "2019-12-11T22:57:14.840747Z",
        "updateTime": "2019-12-11T22:59:00.764354Z",
        "importDataDetails": {}
      },
      "done": true,
      "response": {
        "@type": "type.googleapis.com/google.protobuf.Empty"
      }
    },
    {
      "name": "projects/project-id/locations/us-central1/operations/TCN7841151780321755136",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.automl.v1.OperationMetadata",
        "partialFailures": [
          {
            "code": 3,
            "message": "Error: DUPLICATE_CONTENT: Duplicated content detected. Multiple documents (line 2552 and line 3528) share the same content."
          },
          {
            "code": 3,
            "message": "Error: gs://automl-docs-filtering-vcm/happiness.csv line 3527: The label is already a ground truth."
          }
        ],
        "createTime": "2019-12-11T22:22:40.789066Z",
        "updateTime": "2019-12-11T22:36:40.388359Z",
        "importDataDetails": {}
      },
      "done": true,
      "response": {
        "@type": "type.googleapis.com/google.protobuf.Empty"
      }
    }
  ]
}

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.

  Valeurs disponibles

  • imageClassificationDatasetMetadata:* (AutoML Vision Image Classification)
  • imageObjectDetectionDatasetMetadata:* (AutoML Vision Object Detection)
  • textClassificationDatasetMetadata:* (AutoML Natural Language Classification)
  • textExtractionDatasetMetadata:* (AutoML Natural Language Entity Extraction)
  • textSentimentDatasetMetadata:* (AutoML Natural Language Sentiment Analysis)
  • translationDatasetMetadata:* (AutoML Translation)

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ètre pageSize défini et des résultats supérieurs à la taille de cette page renvoie également le jeton nextPageToken. 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 en spécifiant dataset_metadata.

Avant d'utiliser les données de requête, effectuez les remplacements suivants:

• project-id : votre ID de projet Google Cloud Platform.
• 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

Remarque : La commande suivante suppose que vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter gcloud auth list pour vérifier le compte actuellement actif.

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

Remarque : La commande suivante suppose que vous vous êtes connecté à la gcloud CLI avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter gcloud auth list pour vérifier le compte actuellement actif.

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 :

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.

  Valeurs disponibles

  • imageClassificationModelMetadata:* (AutoML Vision Image Classification)
  • imageObjectDetectionModelMetadata:* (AutoML Vision Object Detection)
  • textClassificationModelMetadata:* (AutoML Natural Language Classification)
  • textExtractionModelMetadata:* (AutoML Natural Language Entity Extraction)
  • textSentimentModelMetadata:* (AutoML Natural Language Sentiment Analysis)
  • translationModelMetadata:* (AutoML Translation)
• 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ètre pageSize défini et des résultats supérieurs à la taille de cette page renvoie également le jeton nextPageToken. 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 en spécifiant model_metadata.

Avant d'utiliser les données de requête, effectuez les remplacements suivants:

• project-id : votre ID de projet Google Cloud Platform.
• 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

Remarque : La commande suivante suppose que vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter gcloud auth list pour vérifier le compte actuellement actif.

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

Remarque : La commande suivante suppose que vous vous êtes connecté à la gcloud CLI avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter gcloud auth list pour vérifier le compte actuellement actif.

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:*").

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/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ètre pageSize défini et des résultats supérieurs à la taille de cette page renvoie également le jeton nextPageToken. 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, effectuez les remplacements suivants:

• project-id : votre ID de projet Google Cloud Platform.
• 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

Remarque : La commande suivante suppose que vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter gcloud auth list pour vérifier le compte actuellement actif.

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

Remarque : La commande suivante suppose que vous vous êtes connecté à la gcloud CLI avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter gcloud auth list pour vérifier le compte actuellement actif.

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").

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/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"