Como criar e gerenciar repositórios de anotações

Nesta página, explicamos como criar, etiquetar, visualizar, listar e excluir armazenamentos de anotações. Os armazenamentos de anotações contêm registros de anotações, que são rótulos que podem ser adicionados a recursos de saúde.

Para uma visão geral dos armazenamentos e registros de anotações, consulte Anotações.

Como criar um armazenamento de anotações

Antes de criar um armazenamento de anotações, você precisa criar um conjunto de dados.

Os exemplos a seguir mostram como criar um armazenamento de anotações.

gcloudAPI

Para criar um armazenamento de anotação, execute o comando gcloud beta healthcare annotation-stores create:

  • O ANNOTATION_STORE_ID precisa ser exclusivo na região. Pode ser qualquer string Unicode de 1 a 256 caracteres que consiste em números, letras, sublinhados, traços e pontos.
gcloud beta healthcare annotation-stores create ANNOTATION_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

Se a solicitação for bem-sucedida, o prompt de comando exibirá a seguinte mensagem:

Created annotationStore [ANNOTATION_STORE_ID].

Para criar um armazenamento de anotações, use o método projects.locations.datasets.annotationStores.create.

curlPowerShell

Para criar um armazenamento de anotações, faça uma solicitação POST e especifique as seguintes informações:

  • O conjunto de dados pai
  • Um nome para o armazenamento de anotações. O código do armazenamento de anotações precisa ser exclusivo no conjunto de dados pai. Pode ser qualquer string Unicode de 1 a 256 caracteres que consiste em números, letras, sublinhados, traços e pontos.
  • Um token de acesso

O exemplo a seguir mostra uma solicitação POST usando curl.

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"

Se a solicitação for bem-sucedida, o servidor retornará a resposta no formato JSON:

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

Para criar um armazenamento de anotações, faça uma solicitação POST e especifique as seguintes informações:

  • O conjunto de dados pai
  • Um nome para o armazenamento de anotações. O código do armazenamento de anotações precisa ser exclusivo no conjunto de dados pai. Pode ser qualquer string Unicode de 1 a 256 caracteres que consiste em números, letras, sublinhados, traços e pontos.
  • Um token de acesso

O exemplo a seguir mostra uma solicitação POST usando o Windows PowerShell.

$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

Se a solicitação for bem-sucedida, o servidor retornará a resposta no formato JSON:

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

Como rotular um armazenamento de anotações

Você pode adicionar um ou mais rótulos de chave-valor a um armazenamento de anotações. Um caso de uso para adicionar rótulos pode ser adicionar rótulos e tags para registros de anotação relacionados a texto ou imagens.

Os exemplos a seguir mostram como adicionar rótulos a um armazenamento de anotações.

gcloudAPI

A CLI gcloud não é compatível com a edição de rótulos de armazenamento de anotações. Em vez disso, use curl, Windows PowerShell ou o idioma de sua preferência.

Para adicionar rótulos a um armazenamento de anotação, use o comando projects.locations.datasets.annotationStores.patch.

curlPowerShel

Para rotular um armazenamento de anotações, faça uma solicitação PATCH e forneça as seguintes informações:

  • O nome do conjunto de dados pai
  • O nome do armazenamento de anotaçõe
  • Os dados do rótulo a serem atualizados
  • Uma máscara de atualização
  • Um token de acesso

O exemplo a seguir mostra uma solicitação PATCH usando curl.

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"

Se a solicitação for bem-sucedida, o servidor retornará a resposta no formato JSON:

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

Para rotular um armazenamento de anotações, faça uma solicitação PATCH e forneça as seguintes informações:

  • O nome do conjunto de dados pai
  • O nome do armazenamento de anotaçõe
  • Os dados do rótulo a serem atualizados
  • Uma máscara de atualização
  • Um token de acesso

O exemplo a seguir mostra uma solicitação PATCH usando o Windows PowerShell.

$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

Se a solicitação for bem-sucedida, o servidor retornará a resposta no formato JSON:

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

Como conseguir detalhes do armazenamento de anotações

Os exemplos a seguir mostram como acessar detalhes sobre um armazenamento de anotações.

gcloudAPI

Para ver detalhes sobre um armazenamento de anotações, execute o comando gcloud beta healthcare annotation-stores describe:

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

Se a solicitação for bem-sucedida, o prompt de comando exibirá os detalhes do armazenamento de anotações:

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

Para ver detalhes sobre um armazenamento de anotações, use o método projects.locations.datasets.annotationStores.get.

curlPowerShell

Para ver detalhes sobre um armazenamento de anotações, faça uma solicitação GET e forneça as seguintes informações

  • O nome do conjunto de dados pai
  • O nome do armazenamento de anotações
  • Um token de acesso

O exemplo a seguir mostra uma solicitação GET usando curl.

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"

Se a solicitação for bem-sucedida, o servidor retornará a resposta no formato JSON:

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

Se você tiver configurado algum campo no recurso AnnotationStore, ele também aparecerá na resposta.

Para ver detalhes sobre um armazenamento de anotações, faça uma solicitação GET e forneça as seguintes informações:

  • O nome do conjunto de dados pai
  • O nome do armazenamento de anotações
  • Um token de acesso

O exemplo a seguir mostra uma solicitação GET usando o Windows PowerShell.

$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

Se a solicitação for bem-sucedida, o servidor retornará a resposta no formato JSON:

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

Se você tiver configurado algum campo no recurso AnnotationStore, ele também aparecerá na resposta.

Como listar armazenamentos de anotações em um conjunto de dados

Os exemplos a seguir mostram como listar os armazenamentos de anotações em um conjunto de dados.

gcloudAPI

Para listar os armazenamentos de anotações em um conjunto de dados, execute o comando gcloud beta healthcare annotation-stores list:

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

Se a solicitação for bem-sucedida, o prompt de comando listará os armazenamentos de anotações:

ID                   LOCATION
ANNOTATION_STORE_ID  LOCATION

Para listar os armazenamentos de anotações em um conjunto de dados, use o método projects.locations.datasets.annotationStores.list.

curlPowerShell

Para listar os armazenamentos de anotações em um conjunto de dados, faça uma solicitação GET e forneça as seguintes informações:

  • O nome do conjunto de dados pai
  • Um token de acesso

O exemplo a seguir mostra uma solicitação GET usando curl.

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"

Se a solicitação for bem-sucedida, o servidor retornará a resposta no formato JSON:

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

Se você tiver configurado algum campo no recurso AnnotationStore, ele também aparecerá na resposta.

Para listar os armazenamentos de anotações em um conjunto de dados, faça uma solicitação GET e forneça as seguintes informações:

  • O nome do conjunto de dados pai
  • Um token de acesso

O exemplo a seguir mostra uma solicitação GET usando o Windows PowerShell.

$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

Se a solicitação for bem-sucedida, o servidor retornará a resposta no formato JSON:

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

Se você tiver configurado algum campo no recurso AnnotationStore, ele também aparecerá na resposta.

Como excluir um armazenamento de anotações

Os exemplos a seguir mostram como excluir um armazenamento de anotações.

gcloudAPI

Para excluir um armazenamento de anotações, execute o comando gcloud beta healthcare annotation-stores delete:

  1. Execute o comando delete.

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

  2. Para confirmar, digite Y.

Se a solicitação for bem-sucedida, o prompt de comando exibirá o seguinte:

Deleted annotationStore [ANNOTATION_STORE_ID].

Para excluir um armazenamento de anotação, use o comando projects.locations.datasets.annotationStores.delete.

curlPowerShell

Para excluir um armazenamento de anotações, faça uma solicitação DELETE e forneça as seguintes informações:

  • O nome do conjunto de dados pai
  • O nome do armazenamento de anotações
  • Um token de acesso

O exemplo a seguir mostra uma solicitação DELETE usando curl.

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"

Se a solicitação for bem-sucedida, o servidor retornará um corpo de resposta vazio no formato JSON:

{}

Para excluir um armazenamento de anotações, faça uma solicitação DELETE e forneça as seguintes informações:

  • O nome do conjunto de dados pai
  • O nome do armazenamento de anotações
  • Um token de acesso

O exemplo a seguir mostra uma solicitação DELETE usando o Windows PowerShell.

$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

Se a solicitação for bem-sucedida, o servidor retornará um corpo de resposta vazio no formato JSON:

{}