アノテーションストアの作成と管理

このページでは、アノテーションストアの作成、ラベル付け、表示、一覧表示、削除の方法について説明します。アノテーションストアは、アノテーションレコードを保持します。このレコードは、ヘルスケアリソースに追加できるラベルです。

アノテーションストアとアノテーションレコードの概要については、アノテーションをご覧ください。

アノテーションストアの作成

アノテーションストアを作成する前に、データセットを作成する必要があります。

次のサンプルは、アノテーションストアを作成する方法を示しています。

gcloud

アノテーションストアを作成するには、gcloud beta healthcare annotation-stores create コマンドを実行します。

ANNOTATION_STORE_ID はリージョン内で一意であることが必要です。数字、英字、アンダースコア、ダッシュ、ピリオドで構成される 1～256 文字の Unicode 文字列を指定できます。

gcloud beta healthcare annotation-stores create ANNOTATION_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

リクエストが成功すると、コマンドプロンプトに次のメッセージが表示されます。

Created annotationStore [ANNOTATION_STORE_ID].

API

アノテーションストアを作成するには、projects.locations.datasets.annotationStores.create メソッドを使用します。

curl

アノテーションストアを作成するには、POST リクエストを行い、次の情報を指定します。

親データセット
アノテーションストアの名前。アノテーションストア ID は、その親データセット内で一意である必要があります。数字、文字、アンダースコア、ダッシュ、ピリオドで構成される、1～256 文字の Unicode 文字列を使用できます。
アクセストークン

次のサンプルは、curl を使用した POST リクエストを示しています。

curl -X POST \
    --data "" \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    "https://healthcare.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores?annotationStoreId=ANNOTATION_STORE_ID"

リクエストが成功すると、サーバーは JSON 形式のレスポンスを返します。

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID"
}

PowerShell

アノテーションストアを作成するには、POST リクエストを行い、次の情報を指定します。

親データセット
アノテーションストアの名前。アノテーションストア ID は、その親データセット内で一意である必要があります。数字、文字、アンダースコア、ダッシュ、ピリオドで構成される、1～256 文字の Unicode 文字列を使用できます。
アクセストークン

次のサンプルは、Windows PowerShell を使用した POST リクエストを示しています。

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

Invoke-WebRequest `
  -Method Post `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Uri "https://healthcare.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores?annotationStoreId=ANNOTATION_STORE_ID" | Select-Object -Expand Content

リクエストが成功すると、サーバーは JSON 形式のレスポンスを返します。

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID"
}

アノテーションストアにラベルを付ける

1 つ以上の Key-Value ラベルをアノテーションストアに追加できます。ラベルの追加の 1 つのユースケースは、テキストやイメージに関連するアノテーションレコードのラベルとタグの追加です。

次のサンプルは、アノテーションストアにラベルを追加する方法を示しています。

gcloud

gcloud CLI ではアノテーションストアのラベルの編集がサポートされません。代わりに、curl、Windows PowerShell、またはご希望の言語を使用してください。

API

アノテーションストアにラベルを追加するには、projects.locations.datasets.annotationStores.patch コマンドを使用します。

curl

アノテーションストアにラベルを付けるには、PATCH リクエストを行い、次の情報を指定します。

親データセットの名前。
アノテーションストアの名前
更新するラベルデータ
更新マスク
アクセストークン

次のサンプルは、curl を使用した PATCH リクエストを示しています。

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
      'labels': {
        'KEY': 'VALUE'
      }
    }" \
    "https://healthcare.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID?updateMask=labels"

リクエストが成功すると、サーバーは JSON 形式のレスポンスを返します。

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID",
  "labels": {
    "KEY": "VALUE"
  }
}

PowerShell

アノテーションストアにラベルを付けるには、PATCH リクエストを行い、次の情報を指定します。

親データセットの名前。
アノテーションストアの名前
更新するラベルデータ
更新マスク
アクセストークン

次のサンプルは、Windows PowerShell を使用した PATCH リクエストを示しています。

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

Invoke-WebRequest `
  -Method Patch `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Body "{
      'labels': {
        'KEY': 'VALUE'
      }
  }" `
  -Uri "https://healthcare.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID?updateMask=labels" | Select-Object -Expand Content

リクエストが成功すると、サーバーは JSON 形式のレスポンスを返します。

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID",
  "labels": {
    "KEY": "VALUE"
  }
}

アノテーションストアの詳細の取得

次のサンプルは、アノテーションストアの詳細を取得する方法を示しています。

gcloud

アノテーションストアについての詳細を取得するには、gcloud beta healthcare annotation-stores describe コマンドを実行します。

gcloud beta healthcare annotation-stores describe ANNOTATION_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

リクエストが成功すると、コマンドプロンプトにアノテーションストアの詳細が表示されます。

name: projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/annotation-stores/ANNOTATION_STORE_ID

API

アノテーションストアの詳細を取得するには、projects.locations.datasets.annotationStores.get メソッドを使用します。

curl

アノテーションストアの詳細を取得するには、GET リクエストを行い、次の情報を指定します。

親データセットの名前。
アノテーションストアの名前
アクセストークン

次のサンプルは、curl を使用した GET リクエストを示しています。

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    "https://healthcare.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID"

リクエストが成功すると、サーバーは JSON 形式のレスポンスを返します。

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID"
}

AnnotationStore リソースでフィールドを構成した場合は、そのフィールドもレスポンスに表示されます。

PowerShell

アノテーションストアの詳細を取得するには、GET リクエストを行い、次の情報を指定します。

親データセットの名前。
アノテーションストアの名前
アクセストークン

次のサンプルは、Windows PowerShell を使用した GET リクエストを示しています。

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

Invoke-WebRequest `
  -Method Get `
  -Headers $headers `
  -Uri "https://healthcare.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID" | Select-Object -Expand Content

リクエストが成功すると、サーバーは JSON 形式のレスポンスを返します。

{
  "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID"
}

AnnotationStore リソースでフィールドを構成した場合は、そのフィールドもレスポンスに表示されます。

データセット内のアノテーションストアの一覧表示

次のサンプルは、データセット内のアノテーションストアを一覧表示する方法を示しています。

gcloud

データセット内のアノテーションストアを一覧表示するには、gcloud beta healthcare annotation-stores list コマンドを実行します。

gcloud beta healthcare annotation-stores list \
  --dataset=DATASET_ID \
  --location=LOCATION

リクエストが成功すると、コマンドプロンプトにアノテーションストアが一覧表示されます。

ID                   LOCATION
ANNOTATION_STORE_ID  LOCATION

API

データセット内のアノテーションストアを一覧表示するには、projects.locations.datasets.annotationStores.list メソッドを使用します。

curl

データセット内のアノテーションストアを一覧表示するには、GET リクエストを行い、次の情報を指定します。

親データセットの名前。
アクセストークン

次のサンプルは、curl を使用した GET リクエストを示しています。

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    "https://healthcare.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores"

リクエストが成功すると、サーバーは JSON 形式のレスポンスを返します。

{
  "annotationStores": [
    {
      "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID"
    },
    {
      ...
    }
  ]
}

AnnotationStore リソースでフィールドを構成した場合は、そのフィールドもレスポンスに表示されます。

PowerShell

データセット内のアノテーションストアを一覧表示するには、GET リクエストを行い、次の情報を指定します。

親データセットの名前。
アクセストークン

次のサンプルは、Windows PowerShell を使用した GET リクエストを示しています。

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

Invoke-WebRequest `
  -Method Get `
  -Headers $headers `
  -Uri "https://healthcare.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores" | Select-Object -Expand Content

リクエストが成功すると、サーバーは JSON 形式のレスポンスを返します。

{
  "annotationStores": [
    {
      "name": "projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID"
    },
    {
      ...
    }
  ]
}

AnnotationStore リソースでフィールドを構成した場合は、そのフィールドもレスポンスに表示されます。

アノテーションストアの削除

次のサンプルは、アノテーションストアを削除する方法を示しています。

gcloud

アノテーションストアを削除するには、gcloud beta healthcare annotation-stores delete コマンドを実行します。

delete コマンドを実行します。

gcloud beta healthcare annotation-stores delete ANNOTATION_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

確認するには、「Y」と入力します。

リクエストが成功すると、コマンドプロンプトに次のように表示されます。

Deleted annotationStore [ANNOTATION_STORE_ID].

API

アノテーションストアを削除するには、projects.locations.datasets.annotationStores.delete コマンドを使用します。

curl

アノテーションストアを削除するには、DELETE リクエストを行い、次の情報を指定します。

親データセットの名前。
アノテーションストアの名前
アクセストークン

次のサンプルは、curl を使用した DELETE リクエストを示しています。

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     "https://healthcare.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID"

リクエストが成功すると、サーバーは JSON 形式の空のレスポンス本文を返します。

{}

PowerShell

アノテーションストアを削除するには、DELETE リクエストを行い、次の情報を指定します。

親データセットの名前。
アノテーションストアの名前
アクセストークン

次のサンプルは、Windows PowerShell を使用した DELETE リクエストを示しています。

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

Invoke-WebRequest `
  -Method Delete `
  -Uri "https://healthcare.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/datasets/DATASET_ID/annotationStores/ANNOTATION_STORE_ID" | Select-Object -Expand Content

リクエストが成功すると、サーバーは JSON 形式の空のレスポンス本文を返します。

{}

アノテーション ストアの作成と管理

アノテーション ストアの作成

gcloud

API

curl

PowerShell

アノテーション ストアにラベルを付ける

gcloud

API

curl

PowerShell

アノテーション ストアの詳細の取得

gcloud

API

curl

PowerShell

データセット内のアノテーション ストアの一覧表示

gcloud

API

curl

PowerShell

アノテーション ストアの削除

gcloud

API

curl

PowerShell

アノテーションストアの作成と管理

アノテーションストアの作成

アノテーションストアにラベルを付ける

アノテーションストアの詳細の取得

データセット内のアノテーションストアの一覧表示

アノテーションストアの削除