Crear y administrar almacenes de anotaciones

En esta página, se explica cómo crear, etiquetar, ver, enumerar y borrar almacenes de anotaciones. Los almacenes de anotaciones contienen registros de anotaciones, que son etiquetas que puedes agregar a los recursos de atención médica.

Para obtener una descripción general de los almacenes y los registros de anotaciones, consulta Anotaciones.

Crea un almacén de anotaciones

Antes de crear un almacén de anotaciones, debes crear un conjunto de datos.

En los siguientes ejemplos, se muestra cómo crear un almacén de anotaciones.

gcloudAPI

Para crear un almacén de anotaciones, ejecuta el comando gcloud beta healthcare annotation-stores create:

  • El ANNOTATION_STORE_ID debe ser único dentro de la región. Puede ser cualquier string de Unicode de 1 a 256 caracteres que conste de números, letras, guiones bajos, guiones y puntos.
gcloud beta healthcare annotation-stores create ANNOTATION_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

Si la solicitud se realiza correctamente, el símbolo del sistema muestra lo siguiente:

Created annotationStore [ANNOTATION_STORE_ID].

Para crear un almacén de anotaciones, usa el método projects.locations.datasets.annotationStores.create.

curlPowerShell

Para crear un almacén de anotaciones, realiza una solicitud POST y especifica la siguiente información:

  • El conjunto de datos superior
  • Un nombre para el almacén de anotaciones El ID del almacén de anotaciones debe ser único en su conjunto de datos principal. Puede ser cualquier string Unicode de 1 a 256 caracteres que conste de números, letras, guiones bajos, guiones y puntos.
  • Un token de acceso

En el siguiente ejemplo, se muestra una solicitud POST mediante 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"

Si la solicitud tiene éxito, se mostrará la respuesta en formato JSON en el servidor:

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

Para crear un almacén de anotaciones, realiza una solicitud POST y especifica la siguiente información:

  • El conjunto de datos superior
  • Un nombre para el almacén de anotaciones El ID del almacén de anotaciones debe ser único en su conjunto de datos principal. Puede ser cualquier string Unicode de 1 a 256 caracteres que conste de números, letras, guiones bajos, guiones y puntos.
  • Un token de acceso

En el siguiente ejemplo, se muestra una solicitud 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

Si la solicitud tiene éxito, se mostrará la respuesta en formato JSON en el servidor:

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

Etiqueta un almacén de anotaciones

Puedes agregar una o más etiquetas de clave-valor a un almacén de anotaciones. Un caso de uso para agregar etiquetas podría agregar etiquetas y etiquetas a los registros de anotación relacionados con texto o imágenes.

En los siguientes ejemplos, se muestra cómo agregar etiquetas a un almacén de anotaciones.

gcloudAPI

La CLI de gcloud no admite la edición de etiquetas de almacén de anotaciones. En su lugar, usa curl, Windows PowerShell o tu lenguaje preferido.

Para agregar etiquetas a un almacén de anotaciones, usa el comando projects.locations.datasets.annotationStores.patch.

curlPowerShell

Para etiquetar un almacén de anotaciones, realiza una solicitud PATCH y proporciona la siguiente información:

  • El nombre del conjunto de datos superior
  • El nombre del almacén de anotaciones
  • Los datos de la etiqueta que deseas actualizar
  • Una máscara de actualización
  • Un token de acceso

En el siguiente ejemplo, se muestra una solicitud PATCH mediante 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"

Si la solicitud tiene éxito, se mostrará la respuesta en formato JSON en el servidor:

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

Para etiquetar un almacén de anotaciones, realiza una solicitud PATCH y proporciona la siguiente información:

  • El nombre del conjunto de datos superior
  • El nombre del almacén de anotaciones
  • Los datos de la etiqueta que deseas actualizar
  • Una máscara de actualización
  • Un token de acceso

En el siguiente ejemplo, se muestra una solicitud 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

Si la solicitud tiene éxito, se mostrará la respuesta en formato JSON en el servidor:

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

Obtén detalles de la tienda de anotaciones

En los siguientes ejemplos, se muestra cómo obtener detalles sobre un almacén de anotaciones.

gcloudAPI

Para obtener detalles sobre un almacén de anotaciones, ejecuta el comando gcloud beta healthcare annotation-stores describe:

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

Si la solicitud se realiza de forma correcta, el símbolo del sistema muestra los detalles del almacén de anotaciones:

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

Para obtener más detalles sobre un almacén de anotaciones, usa el método projects.locations.datasets.annotationStores.get.

curlPowerShell

Para obtener detalles sobre un almacén de anotaciones, realiza una solicitud GET y proporciona la siguiente información:

  • El nombre del conjunto de datos superior
  • El nombre del almacén de anotaciones
  • Un token de acceso

En el siguiente ejemplo, se muestra una solicitud GET mediante 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"

Si la solicitud tiene éxito, se mostrará la respuesta en formato JSON en el servidor:

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

Si configuraste algún campo en el recurso AnnotationStore, también aparecerá en la respuesta.

Para obtener detalles sobre un almacén de anotaciones, realiza una solicitud GET y proporciona la siguiente información:

  • El nombre del conjunto de datos superior
  • El nombre del almacén de anotaciones
  • Un token de acceso

En el siguiente ejemplo, se muestra una solicitud 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

Si la solicitud tiene éxito, se mostrará la respuesta en formato JSON en el servidor:

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

Si configuraste algún campo en el recurso AnnotationStore, también aparecerá en la respuesta.

Muestra listas de almacenes de anotaciones en un conjunto de datos

En los siguientes ejemplos, se muestra cómo enumerar los almacenes de anotaciones en un conjunto de datos.

gcloudAPI

Para enumerar los almacenes de anotaciones en un conjunto de datos, ejecuta el comando gcloud beta healthcare annotation-stores list:

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

Si la solicitud se realiza de forma correcta, el símbolo del sistema enumera los almacenes de anotaciones:

ID                   LOCATION
ANNOTATION_STORE_ID  LOCATION

Para enumerar los almacenes de anotaciones en un conjunto de datos, usa el método projects.locations.datasets.annotationStores.list.

curlPowerShell

Para enumerar los almacenes de anotaciones en un conjunto de datos, realiza una solicitud GET y proporciona la siguiente información:

  • El nombre del conjunto de datos superior
  • Un token de acceso

En el siguiente ejemplo, se muestra una solicitud GET mediante 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"

Si la solicitud tiene éxito, se mostrará la respuesta en formato JSON en el servidor:

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

Si configuraste algún campo en el recurso AnnotationStore, también aparecerá en la respuesta.

Para enumerar los almacenes de anotaciones en un conjunto de datos, realiza una solicitud GET y proporciona la siguiente información:

  • El nombre del conjunto de datos superior
  • Un token de acceso

En el siguiente ejemplo, se muestra una solicitud 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

Si la solicitud tiene éxito, se mostrará la respuesta en formato JSON en el servidor:

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

Si configuraste algún campo en el recurso AnnotationStore, también aparecerá en la respuesta.

Borra un almacén de anotaciones

En los siguientes ejemplos, se muestra cómo borrar un almacén de anotaciones.

gcloudAPI

Para borrar un almacén de anotaciones, ejecuta el comando gcloud beta healthcare annotation-stores delete:

  1. Ejecuta el comando delete.

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

  2. Para confirmar, escribe Y.

Si la solicitud se realiza correctamente, el símbolo del sistema muestra lo siguiente:

Deleted annotationStore [ANNOTATION_STORE_ID].

Para borrar un almacén de anotaciones, usa el comando projects.locations.datasets.annotationStores.delete.

curlPowerShell

Para borrar un almacén de anotaciones, realiza una solicitud DELETE y proporciona la siguiente información:

  • El nombre del conjunto de datos superior
  • El nombre del almacén de anotaciones
  • Un token de acceso

En el siguiente ejemplo, se muestra una solicitud DELETE mediante 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"

Si la solicitud es exitosa, el servidor muestra el cuerpo de respuesta vacío en formato JSON:

{}

Para borrar un almacén de anotaciones, realiza una solicitud DELETE y proporciona la siguiente información:

  • El nombre del conjunto de datos superior
  • El nombre del almacén de anotaciones
  • Un token de acceso

En el siguiente ejemplo, se muestra una solicitud 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

Si la solicitud es exitosa, el servidor muestra el cuerpo de respuesta vacío en formato JSON:

{}