フィルタを使用することにより、リソース、評価、またはオペレーションを一覧表示するときに、より具体的な結果を返すことができます。
オペレーション
次のパラメータを使用して、リスト表示されたオペレーションをフィルタリングできます。
フィルタ
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 メソッドと URL:
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 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
次のコマンドを実行します。
$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
リクエストが成功すると、サーバーは 200 OK
HTTP ステータス コードと JSON 形式のレスポンスを返します。
次のレスポンスは、複数の AutoML オペレーションを含むプロジェクトからのもので、完了したオペレーション(?filter="done=true"
)でフィルタリングされています。
追加のクエリ パラメータ
他のパラメータ(pageSize
、pageToken
)でクエリを実行するには、パラメータを URL に追加します。
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 メソッドと URL:
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 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
次のコマンドを実行します。
$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
リクエストが成功すると、サーバーは 200 OK
HTTP ステータス コードと JSON 形式のレスポンスを返します。
次のレスポンスは、複数の AutoML データセットを含むプロジェクトからのもので、AutoML Translation データセット(?filter="translationDatasetMetadata:*"
)でフィルタリングされています。
レスポンス:
追加のクエリ パラメータ
他のパラメータ(pageSize
、pageToken
)でクエリを実行するには、パラメータを URL に追加します。
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 メソッドと URL:
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 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
次のコマンドを実行します。
$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
リクエストが成功すると、サーバーは 200 OK
HTTP ステータス コードと JSON 形式のレスポンスを返します。
次のレスポンスは、複数の AutoML モデルタイプを含むプロジェクトからのもので、AutoML Natural Language モデル(?filter="textClassificationModelMetadata:*"
)でフィルタリングされています。
追加のクエリ パラメータ
他のパラメータ(pageSize
、pageToken
)でクエリを実行するには、パラメータを URL に追加します。
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"
モデル評価
次のパラメータを使用して、リスト表示されたモデル評価をフィルタリングできます。
フィルタ
annotationSpecId
- 指定された値に等しい ID を持つすべてのモデル評価を返します。また、特定の値と等しくない(!=
)モデル評価を指定することもできます。
追加のクエリ パラメータ
pageSize
- 返される結果を一定数の行に制限します。指定しない場合、サーバーはデフォルトのサイズを選択します。pageToken
- 結果の次ページを取得するためのトークン。pageSize
が設定され、結果がそのページサイズより大きい最初のクエリでも、nextPageToken
が返されます。このトークンをpageToken
に渡して、後続の結果を取得できます。
次のコマンドライン コードのサンプルは、annotationSpecId
を指定して、リスト表示されたモデル評価をフィルタリングする方法を示しています。
データをリクエストする前に、次のように置き換えます。
- project-id: Google Cloud Platform プロジェクト ID。
- model-id: 評価対象のモデルの ID。
- annotation-spec-id: モデル評価が適用されるアノテーション仕様の ID。この ID は、モデル評価全体で空白です。
HTTP メソッドと URL:
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 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
次のコマンドを実行します。
$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
リクエストが成功すると、サーバーは 200 OK
HTTP ステータス コードと JSON 形式のレスポンスを返します。
次のレスポンスは、複数の AutoML モデルタイプを含むプロジェクトからのもので、単一のモデル(?filter="annotationSpecId=1231173747155664896"
)からのモデル評価でフィルタリングされています。
追加のクエリ パラメータ
他のパラメータ(pageSize
、pageToken
)でクエリを実行するには、パラメータを URL に追加します。
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"