列出时过滤

您可以在列出资源、评估或操作时使用过滤来返回更具有针对性的结果。

操作

您可以使用以下参数过滤列出的操作:

过滤条件

  • operation_id - 返回 ID 等于提供的值的所有操作。您还可以指定不等于 (!=) 某一特定值的操作。
  • done - 返回状态为 "done": true 的所有操作。 您还可以指定仍在进行中(非 "done")的操作。

    查询:

    • ?filter="done=true"
    • ?filter="done!=true"
  • worksOn - 返回处理资源(数据集或模型)的所有操作。 您还可以指定不等于 (!=) 某一特定值的操作。

    查询:

    • 数据集 - ?filter="worksOn=projects/project-id/locations/us-central1/datasets/dataset-id"
    • 模型 - ?filter="worksOn=projects/project-id/locations/us-central1/models/model-id"

其他查询参数

  • pageSize - 将返回的结果限制为一定数量的页面。如果未指定,服务器将选择默认大小。
  • pageToken - 用于检索下一页结果的令牌。如果初始查询具有固定的 pageSize 且结果显示超过该页面大小,则该查询也将返回 nextPageToken。然后,此令牌将被传递给 pageToken 以获取后续结果。

以下命令行代码示例显示了如何按已完成的操作(状态为 "done": true)过滤列出的操作。

在使用下面的请求数据之前,请先进行以下替换:

  • project-id:您的 Google Cloud Platform 项目 ID。

HTTP 方法和网址:

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

如需发送请求,请选择以下方式之一:

curl

执行以下命令:

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/operations?filter="done=true"

PowerShell

执行以下命令:

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

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

如果请求成功,服务器将返回一个 200 OK HTTP 状态代码以及 JSON 格式的响应。

以下响应来自具有多个 AutoML 操作且按已完成的操作进行了过滤 (?filter="done=true") 的项目。

其他查询参数

要使用其他参数(pageSizepageToken)进行查询,请将该参数附加到网址:

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

您还可以使用和符号 (&) 来串联参数:

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

数据集

您可以使用以下参数过滤列出的数据集:

过滤条件

  • dataset_metadata - 返回目标元数据类型的所有数据集。

其他查询参数

  • pageSize - 将返回的结果限制为一定数量的页面。如果未指定,服务器将选择默认大小。
  • pageToken - 用于检索下一页结果的令牌。如果初始查询具有固定的 pageSize 且结果显示超过该页面大小,则该查询也将返回 nextPageToken。然后,此令牌将被传递给 pageToken 以获取后续结果。

以下命令行代码示例显示了如何通过指定 dataset_metadata 来过滤列出的数据集。

在使用下面的请求数据之前,请先进行以下替换:

  • project-id:您的 Google Cloud Platform 项目 ID。
  • dataset-metadata-value:您要过滤的 dataset_metadata 的类型。这些值取决于 AutoML 问题类型。

HTTP 方法和网址:

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

如需发送请求,请选择以下方式之一:

curl

执行以下命令:

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/datasets?filter="dataset-metadata-value"

PowerShell

执行以下命令:

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

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

如果请求成功,服务器将返回一个 200 OK HTTP 状态代码以及 JSON 格式的响应。

以下响应来自具有多个 AutoML 数据集类型且针对 AutoML Translation 数据集进行了过滤 (?filter="translationDatasetMetadata:*") 的项目。

响应

其他查询参数

要使用其他参数(pageSizepageToken)进行查询,请将该参数附加到网址:

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

您还可以使用和符号 (&) 来串联参数:

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

模型

您可以使用以下参数过滤列出的模型:

过滤条件

  • model_metadata - 返回目标元数据类型的所有模型。
  • datasetId - 返回从特定数据集创建的所有模型。

其他查询参数

  • pageSize - 将返回的结果限制为一定数量的页面。如果未指定,服务器将选择默认大小。
  • pageToken - 用于检索下一页结果的令牌。如果初始查询具有固定的 pageSize 且结果显示超过该页面大小,则该查询也将返回 nextPageToken。然后,此令牌将被传递给 pageToken 以获取后续结果。

以下命令行代码示例显示了如何通过指定 model_metadata 来过滤列出的模型。

在使用下面的请求数据之前,请先进行以下替换:

  • project-id:您的 Google Cloud Platform 项目 ID。
  • model-metadata-value:您要过滤的 model_metadata 的类型。这些值取决于 AutoML 问题类型。

HTTP 方法和网址:

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

如需发送请求,请选择以下方式之一:

curl

执行以下命令:

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models?filter="model-metadata-value"

PowerShell

执行以下命令:

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

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

如果请求成功,服务器将返回一个 200 OK HTTP 状态代码以及 JSON 格式的响应。

以下响应来自具有多个 AutoML 模型类型且针对 AutoML Natural Language 模型进行了过滤 (?filter="textClassificationModelMetadata:*") 的项目。

其他查询参数

要使用其他参数(pageSizepageToken)进行查询,请将该参数附加到网址:

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

您还可以使用和符号 (&) 来串联参数:

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

modelEvaulations

您可以使用以下参数过滤列出的模型评估:

过滤条件

  • annotationSpecId - 返回 ID 等于提供的值的所有模型评估。您还可以指定不等于 (!=) 某一特定值的模型评估。

其他查询参数

  • pageSize - 将返回的结果限制为一定数量的页面。如果未指定,服务器将选择默认大小。
  • pageToken - 用于检索下一页结果的令牌。如果初始查询具有固定的 pageSize 且结果显示超过该页面大小,则该查询也将返回 nextPageToken。然后,此令牌将被传递给 pageToken 以获取后续结果。

以下命令行代码示例显示了如何通过指定 annotationSpecId 来过滤列出的模型评估。

在使用下面的请求数据之前,请先进行以下替换:

  • project-id:您的 Google Cloud Platform 项目 ID。
  • model-id:要评估的模型的 ID。
  • annotation-spec-id:应用模型评估的注释规范的 ID。整体模型评估的 ID 为空。

HTTP 方法和网址:

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

如需发送请求,请选择以下方式之一:

curl

执行以下命令:

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
https://automl.googleapis.com/v1/projects/project-id/locations/us-central1/models/model-id/modelEvaluations?filter="annotationSpecId=annotation-spec-id"

PowerShell

执行以下命令:

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

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

如果请求成功,服务器将返回一个 200 OK HTTP 状态代码以及 JSON 格式的响应。

以下响应来自具有多个 AutoML 模型类型且针对单个模型的模型评估进行了过滤 (?filter="annotationSpecId=1231173747155664896") 的项目。

其他查询参数

要使用其他参数(pageSizepageToken)进行查询,请将该参数附加到网址:

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

您还可以使用和符号 (&) 来串联参数:

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"