创建和管理注解存储区

本页面介绍了如何创建、标记、查看、列出和删除注解存储区。注解存储区用于保存注解记录，您可以将这些记录作为标签添加到医疗保健资源。

如需注解存储区和注解记录的概览，请参阅注解。

创建注解存储区

在创建注解存储区之前，您需要先创建数据集。

以下示例展示了如何创建注解存储区。

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

为注解存储区添加标签

您可以向注解存储区添加一个或多个键值标签。添加标签的一个用例是为与文本或图片相关的注解记录添加标签和标记。

以下示例展示了如何为注解存储区添加标签。

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 命令：

  1. 运行 delete 命令。

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

  2. 要确认，请键入 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 格式返回空响应正文：

{}