Como filtrar ao listar

Use a filtragem para retornar resultados mais específicos ao listar recursos, avaliações ou operações.

Operações

É possível filtrar as operações listadas usando os seguintes parâmetros:

Filtros

  • operation_id: retorna todas as operações com um ID igual ao valor fornecido. Também é possível especificar operações não iguais (!=) a um determinado valor.
  • done: retorna todas as operações com status "done": true. Também é possível especificar operações que ainda estão em andamento (não "done").

    Consultas:

    • ?filter="done=true"
    • ?filter="done!=true"
  • worksOn: retorna todas as operações que funcionam em um recurso (conjunto de dados ou modelo). Também é possível especificar operações não iguais (!=) a um determinado valor.

    Consultas:

    • conjunto de dados: ?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 consulta adicionais

  • pageSize: limita os resultados retornados a um número definido de linhas. Se não for especificado, o servidor escolherá um tamanho padrão.
  • pageToken: um token para recuperar a próxima página de resultados. Uma consulta inicial com um conjunto pageSize e resultados maiores do que cabem nesse tamanho de página também retorna um nextPageToken. Esse token pode ser passado para pageToken para receber resultados subsequentes.

O exemplo de código de linha de comando a seguir mostra como filtrar as operações listadas por operações concluídas (com status "done": true).

Antes de usar os dados da solicitação, faça as substituições a seguir:

  • project-id: seu projeto ID do Google Cloud Platform.

Método HTTP e URL:

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

Para enviar a solicitação, escolha uma destas opções:

curl

execute o seguinte comando:

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

execute o seguinte comando:

$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

Quando a solicitação é bem-sucedida, o servidor retorna um código de status HTTP 200 OK e a resposta no formato JSON.

A resposta a seguir é de um projeto com várias operações do AutoML, filtradas por operações concluídas (?filter="done=true").

Parâmetros de consulta adicionais

Para consultar com outros parâmetros (pageSize, pageToken), anexe o parâmetro ao URL:

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

Também é possível concatenar parâmetros com um "e" comercial (&):

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 dados

É possível filtrar os conjuntos de dados listados usando os seguintes parâmetros:

Filtros

  • dataset_metadata: retorna todos os conjuntos de dados com o tipo de metadados de destino.

Parâmetros de consulta adicionais

  • pageSize: limita os resultados retornados a um número definido de linhas. Se não for especificado, o servidor escolherá um tamanho padrão.
  • pageToken: um token para recuperar a próxima página de resultados. Uma consulta inicial com um conjunto pageSize e resultados maiores do que cabem nesse tamanho de página também retorna um nextPageToken. Esse token pode ser passado para pageToken para receber resultados subsequentes.

O exemplo de código de linha de comando a seguir mostra como filtrar conjuntos de dados listados especificando o dataset_metadata.

Antes de usar os dados da solicitação, faça as substituições a seguir:

  • project-id: seu projeto ID do Google Cloud Platform.
  • dataset-metadata-value: o tipo de dataset_metadata que você está filtrando. Esses valores dependem do tipo de problema do AutoML.

Método HTTP e URL:

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

Para enviar a solicitação, escolha uma destas opções:

curl

execute o seguinte comando:

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

execute o seguinte comando:

$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

Quando a solicitação é bem-sucedida, o servidor retorna um código de status HTTP 200 OK e a resposta no formato JSON.

A resposta a seguir é de um projeto com vários tipos de conjuntos de dados do AutoML, filtrados por conjuntos de dados do AutoML Translation (?filter="translationDatasetMetadata:*").

Resposta:

Parâmetros de consulta adicionais

Para consultar com outros parâmetros (pageSize, pageToken), anexe o parâmetro ao URL:

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

Também é possível concatenar parâmetros com um "e" comercial (&):

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

Modelos

É possível filtrar os modelos listados usando os seguintes parâmetros:

Filtros

  • model_metadata: retorna todos os modelos com o tipo de metadados de destino.
  • datasetId: retorna todos os modelos criados usando um conjunto de dados específico.

Parâmetros de consulta adicionais

  • pageSize: limita os resultados retornados a um número definido de linhas. Se não for especificado, o servidor escolherá um tamanho padrão.
  • pageToken: um token para recuperar a próxima página de resultados. Uma consulta inicial com um conjunto pageSize e resultados maiores do que cabem nesse tamanho de página também retorna um nextPageToken. Esse token pode ser passado para pageToken para receber resultados subsequentes.

O exemplo de código de linha de comando a seguir mostra como filtrar modelos listados especificando o model_metadata.

Antes de usar os dados da solicitação, faça as substituições a seguir:

  • project-id: seu projeto ID do Google Cloud Platform.
  • model-metadata-value: o tipo de model_metadata que você está filtrando. Esses valores dependem do tipo de problema do AutoML.

Método HTTP e URL:

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

Para enviar a solicitação, escolha uma destas opções:

curl

execute o seguinte comando:

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

execute o seguinte comando:

$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

Quando a solicitação é bem-sucedida, o servidor retorna um código de status HTTP 200 OK e a resposta no formato JSON.

A resposta a seguir é de um projeto com vários tipos de modelo do AutoML, filtrados por modelos da Natural Language API do AutoML (?filter="textClassificationModelMetadata:*").

Parâmetros de consulta adicionais

Para consultar com outros parâmetros (pageSize, pageToken), anexe o parâmetro ao URL:

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

Também é possível concatenar parâmetros com um "e" comercial (&):

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

modelEvaulations

É possível filtrar as avaliações de modelo listadas usando os seguintes parâmetros:

Filtros

  • annotationSpecId: retorna todas as avaliações de modelo com um ID igual ao valor fornecido. Também é possível especificar avaliações de modelo não iguais (!=) a um determinado valor.

Parâmetros de consulta adicionais

  • pageSize: limita os resultados retornados a um número definido de linhas. Se não for especificado, o servidor escolherá um tamanho padrão.
  • pageToken: um token para recuperar a próxima página de resultados. Uma consulta inicial com um conjunto pageSize e resultados maiores do que cabem nesse tamanho de página também retorna um nextPageToken. Esse token pode ser passado para pageToken para receber resultados subsequentes.

Veja na exemplo de código de linha de comando a seguir como filtrar as avaliações de modelo listadas especificando o annotationSpecId.

Antes de usar os dados da solicitação, faça as substituições a seguir:

  • project-id: seu projeto ID do Google Cloud Platform.
  • model-id: o ID do modelo para o qual você quer avaliações.
  • annotation-spec-id: o ID da especificação de anotação a que a avaliação de modelo se aplica. O ID está vazio na avaliação geral do modelo.

Método HTTP e URL:

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

Para enviar a solicitação, escolha uma destas opções:

curl

execute o seguinte comando:

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

execute o seguinte comando:

$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

Quando a solicitação é bem-sucedida, o servidor retorna um código de status HTTP 200 OK e a resposta no formato JSON.

A resposta a seguir é de um projeto com vários tipos de modelo do AutoML, filtrados por avaliações de modelo de um único modelo (?filter="annotationSpecId=1231173747155664896").

Parâmetros de consulta adicionais

Para consultar com outros parâmetros (pageSize, pageToken), anexe o parâmetro ao URL:

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

Também é possível concatenar parâmetros com um "e" comercial (&):

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"