Filtra cuando se muestre la lista

Puedes usar filtros para mostrar resultados más específicos cuando enumeres recursos, operaciones o evaluaciones.

Punto clave: Por lo general, debes agregar la siguiente sintaxis a la URL de la solicitud para filtrar:

• ?filter="[filter_name=]filter-value": Muestra todos los objetos JSON que coinciden con filter-value.
• ?filter="": Anula un filtro. No se muestran coincidencias.
• ?filter="*": Un filtro que coincide con todos los valores posibles.

Operaciones

You can filter listed operations using the following parameters:

Filters

• operation_id - returns all operations with an ID equal to the provided value. You can also specify operations not equal (!=) to a certain value.
• done - returns all operations with a status of "done": true. You can also specify operations that are still ongoing (not "done").

  Queries:

  • ?filter="done=true"
  • ?filter="done!=true"
• worksOn - returns all operations that work on a resource (dataset or model). You can also specify operations not equal (!=) to a certain value.

  Queries:

  • dataset - ?filter="worksOn=projects/project-id/locations/us-central1/datasets/dataset-id"
  • model - ?filter="worksOn=projects/project-id/locations/us-central1/models/model-id"

Parámetros de búsqueda adicionales

• pageSize: Limita los resultados que se muestran a una cantidad determinada de líneas. Si no se especifica, el servidor elegirá un tamaño predeterminado.
• pageToken: Un token para recuperar la siguiente página de resultados. Una consulta inicial con un conjunto pageSize y resultados mayores que los que quepan en ese tamaño de página también mostrarán un nextPageToken. Este token se puede pasar a pageToken para obtener resultados posteriores.

The following command line code sample shows how to filter listed operations by operations that are completed (have a status of "done": true).

Before using any of the request data, make the following replacements:

• project-id: your Google Cloud Platform project ID.

HTTP method and URL:

GET https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/operations?filter="done=true"

To send your request, choose one of these options:

curl

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Execute the following command:

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

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Execute the following command:

$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

If the request is successful, the server returns a 200 OK HTTP status code and the response in JSON format.

The following response is from a project with multiple AutoML operations, filtered by operations that have completed (?filter="done=true").

Response

{
  "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"
      }
    }
  ]
}

Additional query parameters

To query with other parameters (pageSize, pageToken) append the parameter to the URL:

https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/model/model-id/modelEvaluations?pageSize=INT

You can also concatenate parameters with an ampersand (&):

https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/model/model-id/modelEvaluations?filter="done=true&pageSize=INT&pageToken=next-page-token"

Conjuntos de datos

You can filter listed datasets using the following parameters:

Filters

• dataset_metadata - returns all datasets with the target metadata type.

  Available values

  • 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)

Parámetros de búsqueda adicionales

• pageSize: Limita los resultados que se muestran a una cantidad determinada de líneas. Si no se especifica, el servidor elegirá un tamaño predeterminado.
• pageToken: Un token para recuperar la siguiente página de resultados. Una consulta inicial con un conjunto pageSize y resultados mayores que los que quepan en ese tamaño de página también mostrarán un nextPageToken. Este token se puede pasar a pageToken para obtener resultados posteriores.

The following command line code sample shows how to filter listed datasets by specifying the dataset_metadata.

Before using any of the request data, make the following replacements:

• project-id: your Google Cloud Platform project ID.
• dataset-metadata-value: the type of dataset_metadata you are filtering. These values depend on the AutoML problem type.

HTTP method and URL:

GET https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/datasets?filter="dataset-metadata-value"

To send your request, choose one of these options:

curl

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Execute the following command:

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

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Execute the following command:

$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

If the request is successful, the server returns a 200 OK HTTP status code and the response in JSON format.

The following response is from a project with multiple AutoML dataset types, filtered for AutoML Translation datasets (?filter="translationDatasetMetadata:*").

Response:

Response

Nota:

Additional query parameters

To query with other parameters (pageSize, pageToken) append the parameter to the URL:

https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/datasets?pageSize=INT

You can also concatenate parameters with an ampersand (&):

https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/datasets?filter="dataset-metadata-value&pageSize=INT&pageToken=next-page-token"

Modelos

You can filter listed models using the following parameters:

Filters

• model_metadata - returns all models with the target metadata type.

  Available values

  • 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 - returns all models created from a specific dataset.

Parámetros de búsqueda adicionales

• pageSize: Limita los resultados que se muestran a una cantidad determinada de líneas. Si no se especifica, el servidor elegirá un tamaño predeterminado.
• pageToken: Un token para recuperar la siguiente página de resultados. Una consulta inicial con un conjunto pageSize y resultados mayores que los que quepan en ese tamaño de página también mostrarán un nextPageToken. Este token se puede pasar a pageToken para obtener resultados posteriores.

The following command line code sample shows how to filter listed models by specifying the model_metadata.

Before using any of the request data, make the following replacements:

• project-id: your Google Cloud Platform project ID.
• model-metadata-value: the type of model_metadata you are filtering. These values depend on the AutoML problem type.

HTTP method and URL:

GET https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models?filter="model-metadata-value"

To send your request, choose one of these options:

curl

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Execute the following command:

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

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Execute the following command:

$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

If the request is successful, the server returns a 200 OK HTTP status code and the response in JSON format.

The following response is from a project with multiple AutoML model types, filtered for AutoML Natural Language models (?filter="textClassificationModelMetadata:*").

Response

Nota:

Additional query parameters

To query with other parameters (pageSize, pageToken) append the parameter to the URL:

https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models?pageSize=INT

You can also concatenate parameters with an ampersand (&):

https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models?filter="model-metadata-value&pageSize=INT&pageToken=next-page-token"

modelEvaulations

You can filter listed model evaluations using the following parameters:

Filters

• annotationSpecId - returns all model evaluations with an ID equal to the provided value. You can also specify model evaulations not equal (!=) to a certain value.

Parámetros de búsqueda adicionales

• pageSize: Limita los resultados que se muestran a una cantidad determinada de líneas. Si no se especifica, el servidor elegirá un tamaño predeterminado.
• pageToken: Un token para recuperar la siguiente página de resultados. Una consulta inicial con un conjunto pageSize y resultados mayores que los que quepan en ese tamaño de página también mostrarán un nextPageToken. Este token se puede pasar a pageToken para obtener resultados posteriores.

The following command line code sample shows how to filter listed model evaluations by specifying the annotationSpecId.

Before using any of the request data, make the following replacements:

• project-id: your Google Cloud Platform project ID.
• model-id: the ID of the model you want evaluations for.
• annotation-spec-id: The ID of the annotation spec that the model evaluation applies to. The The ID is empty for the overall model evaluation.

HTTP method and URL:

GET https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models/model-id/modelEvaluations?filter="annotationSpecId=annotation-spec-id"

To send your request, choose one of these options:

curl

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login , or by using Cloud Shell, which automatically logs you into the gcloud CLI . You can check the currently active account by running gcloud auth list.

Execute the following command:

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

Note: The following command assumes that you have logged in to the gcloud CLI with your user account by running gcloud init or gcloud auth login . You can check the currently active account by running gcloud auth list.

Execute the following command:

$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

If the request is successful, the server returns a 200 OK HTTP status code and the response in JSON format.

The following response is from a project with multiple AutoML model types, filtered for model evaluations from a single model (?filter="annotationSpecId=1231173747155664896").

Response

Nota:

Additional query parameters

To query with other parameters (pageSize, pageToken) append the parameter to the URL:

https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/model/model-id/modelEvaluations?pageSize=INT

You can also concatenate parameters with an ampersand (&):

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"