Creazione e gestione degli archivi di annotazioni

Questa pagina spiega come creare, etichettare, visualizzare, elencare ed eliminare gli archivi di annotazioni. I datastore delle annotazioni contengono record di annotazioni, ovvero etichette che puoi aggiungere alle risorse sanitarie.

Per una panoramica degli archivi di annotazioni e dei record di annotazioni, consulta Annotazioni.

Creazione di un archivio di annotazioni

Prima di poter creare un archivio di annotazioni, devi creare un set di dati.

Gli esempi riportati di seguito mostrano come creare un archivio di annotazioni.

gcloud

Per creare un archivio di annotazioni, esegui gcloud beta healthcare annotation-stores create :

  • ANNOTATION_STORE_ID deve essere univoco all'interno della regione. Può essere qualsiasi Stringa Unicode da 1 a 256 caratteri composta da numeri, lettere trattini bassi, trattini e punti.
gcloud beta healthcare annotation-stores create ANNOTATION_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

Se la richiesta ha esito positivo, il prompt dei comandi visualizza il seguente messaggio:

Created annotationStore [ANNOTATION_STORE_ID].

API

Per creare un archivio di annotazioni, utilizza il metodo projects.locations.datasets.annotationStores.create.

curl

Per creare un archivio di annotazioni, effettua una richiesta POST e specifica quanto segue informazioni:

  • Il set di dati padre
  • Un nome per l'archivio di annotazioni. L'ID negozio di annotazioni deve essere univoco nel relativo set di dati padre. Può essere qualsiasi stringa Unicode con un numero di caratteri compreso tra 1 e 256 e costituita da numeri, lettere, trattini bassi, trattini e punti.
  • Un token di accesso

L'esempio seguente mostra una richiesta POST utilizzando 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 la richiesta riesce, il server restituisce la risposta in formato JSON:

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

PowerShell

Per creare un archivio di annotazioni, effettua una richiesta POST e specifica quanto segue informazioni:

  • Il set di dati padre
  • Un nome per l'archivio di annotazioni. L'ID negozio di annotazioni deve essere univoco nel relativo set di dati padre. Può essere qualsiasi stringa Unicode con un numero di caratteri compreso tra 1 e 256 e costituita da numeri, lettere, trattini bassi, trattini e punti.
  • Un token di accesso

L'esempio seguente mostra una richiesta POST mediante 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 la richiesta riesce, il server restituisce la risposta in formato JSON:

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

Etichettatura di un archivio di annotazioni

Puoi aggiungere una o più etichette chiave-valore a un archivio di annotazioni. Un caso d'uso per l'aggiunta di etichette potrebbe essere l'aggiunta di etichette e tag per i record di annotazione relativi a testo o immagini.

Gli esempi riportati di seguito mostrano come aggiungere etichette a un archivio di annotazioni.

gcloud

gcloud CLI non supporta la modifica delle etichette dell'archivio di annotazioni. Usa invece curl, Windows PowerShell o il tuo metodo preferito lingua.

API

Per aggiungere etichette a un archivio di annotazioni, utilizza il comando projects.locations.datasets.annotationStores.patch.

curl

Per etichettare un archivio di annotazioni, effettua una richiesta PATCH e fornisci quanto segue informazioni:

  • Il nome del set di dati padre
  • Il nome dell'archivio di annotazioni
  • Dati dell'etichetta da aggiornare
  • Una maschera di aggiornamento
  • Un token di accesso

Il seguente esempio mostra un PATCH tramite 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 la richiesta riesce, il server restituisce la risposta in formato JSON:

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

PowerShell

Per etichettare un archivio di annotazioni, effettua una richiesta PATCH e fornisci quanto segue informazioni:

  • Il nome del set di dati padre
  • Il nome dell'archivio di annotazioni
  • Dati dell'etichetta da aggiornare
  • Una maschera di aggiornamento
  • Un token di accesso

Il seguente esempio mostra una richiesta PATCH mediante 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 la richiesta riesce, il server restituisce la risposta in formato JSON:

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

Recupero dei dettagli dell'archivio di annotazioni in corso...

Gli esempi riportati di seguito mostrano come recuperare i dettagli di un archivio di annotazioni.

gcloud

Per ottenere i dettagli di un archivio di annotazioni, esegui il comando gcloud beta healthcare annotation-stores describe:

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

Se la richiesta ha esito positivo, il prompt dei comandi visualizza i dettagli dell'archivio di annotazioni:

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

API

Per ottenere dettagli su un archivio di annotazioni, utilizza il metodo projects.locations.datasets.annotationStores.get.

curl

Per ottenere dettagli su un archivio di annotazioni, effettua una richiesta GET e fornisci le seguenti informazioni:

  • Il nome del set di dati padre
  • Il nome dell'archivio di annotazioni
  • Un token di accesso

L'esempio seguente mostra una richiesta GET che utilizza 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 la richiesta riesce, il server restituisce la risposta in formato JSON:

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

Se hai configurato dei campi nella AnnotationStore risorse, appaiono anche nella risposta.

PowerShell

Per ottenere dettagli su un archivio di annotazioni, effettua una richiesta GET e fornisci le seguenti informazioni:

  • Il nome del set di dati padre
  • Il nome dell'archivio di annotazioni
  • Un token di accesso

L'esempio seguente mostra una richiesta GET mediante 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 la richiesta riesce, il server restituisce la risposta in formato JSON:

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

Se hai configurato dei campi nella AnnotationStore risorse, appaiono anche nella risposta.

Elenco degli archivi di annotazioni in un set di dati

Gli esempi riportati di seguito mostrano come elencare gli archivi di annotazioni in un set di dati.

gcloud

Per elencare gli archivi di annotazioni in un set di dati, esegui il comando gcloud beta healthcare annotation-stores list :

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

Se la richiesta va a buon fine, il prompt dei comandi elenca gli archivi di annotazioni:

ID                   LOCATION
ANNOTATION_STORE_ID  LOCATION

API

Per elencare gli archivi di annotazioni in un set di dati, utilizza il metodo projects.locations.datasets.annotationStores.list.

curl

Per elencare gli archivi di annotazioni in un set di dati, effettua una richiesta GET e fornisci le seguenti informazioni:

  • Il nome del set di dati padre
  • Un token di accesso

L'esempio seguente mostra una richiesta GET che utilizza 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 la richiesta riesce, il server restituisce la risposta in formato JSON:

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

Se hai configurato dei campi nella AnnotationStore risorse, appaiono anche nella risposta.

PowerShell

Per elencare gli archivi di annotazioni in un set di dati, effettua una richiesta GET e fornisci le seguenti informazioni:

  • Il nome del set di dati padre
  • Un token di accesso

L'esempio seguente mostra una richiesta GET mediante 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 la richiesta riesce, il server restituisce la risposta in formato JSON:

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

Se hai configurato dei campi nella AnnotationStore risorse, appaiono anche nella risposta.

Eliminazione di un archivio di annotazioni

Gli esempi riportati di seguito mostrano come eliminare un archivio di annotazioni.

gcloud

Per eliminare un archivio di annotazioni, esegui il comando gcloud beta healthcare annotation-stores delete :

  1. Esegui il comando delete.

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

  2. Per confermare, digita Y.

Se la richiesta ha esito positivo, il prompt dei comandi visualizza quanto segue:

Deleted annotationStore [ANNOTATION_STORE_ID].

API

Per eliminare un archivio di annotazioni, utilizza il comando projects.locations.datasets.annotationStores.delete.

curl

Per eliminare un archivio di annotazioni, effettua una richiesta DELETE e fornisci le seguenti informazioni:

  • Il nome del set di dati padre
  • Il nome dell'archivio di annotazioni
  • Un token di accesso

L'esempio seguente mostra una richiesta DELETE che utilizza 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 la richiesta riesce, il server restituisce un corpo di risposta vuoto in formato JSON:

{}

PowerShell

Per eliminare un archivio di annotazioni, effettua una richiesta DELETE e fornisci le seguenti informazioni:

  • Il nome del set di dati padre
  • Il nome dell'archivio di annotazioni
  • Un token di accesso

L'esempio seguente mostra una richiesta DELETE mediante 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 la richiesta riesce, il server restituisce un corpo della risposta vuoto in formato JSON:

{}