주석 저장소 만들기 및 관리

이 페이지에서는 주석 저장소를 생성, 라벨 지정, 확인, 나열, 삭제하는 방법을 설명합니다. 주석 저장소에는 의료 리소스에 추가할 수 있는 라벨인 주석 레코드가 포함됩니다.

주석 저장소 및 주석 레코드 개요는 주석을 참조하세요.

주석 저장소 만들기

주석 저장소를 만들려면 먼저 데이터 세트를 만들어야 합니다.

다음 샘플은 주석 저장소를 만드는 방법을 보여줍니다.

gcloudAPI

주석 저장소를 만들려면 gcloud beta healthcare annotation-stores create 명령어를 실행합니다.

  • ANNOTATION_STORE_ID는 리전 내에서 고유해야 합니다. 숫자, 문자, 밑줄, 대시, 마침표로 이루어진 1~256자의 모든 유니코드 문자열일 수 있습니다.
gcloud beta healthcare annotation-stores create ANNOTATION_STORE_ID \
  --dataset=DATASET_ID \
  --location=LOCATION

요청이 성공하면 명령어 프롬프트가 다음 메시지를 표시합니다.

Created annotationStore [ANNOTATION_STORE_ID].

주석 저장소를 만들려면 projects.locations.datasets.annotationStores.create 메서드를 사용합니다.

curlPowerShell

주석 저장소를 만들려면 POST 요청을 수행하고 다음 정보를 지정합니다.

  • 상위 데이터 세트
  • 주석 저장소의 이름입니다. 주석 저장소 ID는 상위 데이터 세트에서 고유해야 합니다. 숫자, 문자, 밑줄, 대시, 마침표로 구성된 1~256 자의 모든 유니코드 문자열일 수 있습니다.
  • 액세스 토큰

다음 샘플은 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"
}

주석 저장소를 만들려면 POST 요청을 수행하고 다음 정보를 지정합니다.

  • 상위 데이터 세트
  • 주석 저장소의 이름입니다. 주석 저장소 ID는 상위 데이터 세트에서 고유해야 합니다. 숫자, 문자, 밑줄, 대시, 마침표로 구성된 1~256 자의 모든 유니코드 문자열일 수 있습니다.
  • 액세스 토큰

다음 샘플은 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"
}

주석 저장소 라벨 지정

하나 이상의 키-값 라벨을 주석 저장소에 추가할 수 있습니다. 라벨 추가에 대한 한 가지 사용 사례는 주석 레코드에 텍스트 또는 이미지와 관련된 라벨 및 태그를 추가하는 것입니다.

다음 샘플은 주석 저장소에 라벨을 추가하는 방법을 보여줍니다.

gcloudAPI

gcloud CLI에서는 주석 저장소 라벨을 수정할 수 없습니다. 대신 curl, Windows PowerShell, 사용자가 선호하는 언어를 사용합니다.

주석 저장소에 라벨을 추가하려면 projects.locations.datasets.annotationStores.patch 명령어를 사용합니다.

curlPowerShell

주석 저장소에 라벨을 지정하려면 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"
  }
}

주석 저장소에 라벨을 지정하려면 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"
  }
}

주석 저장소 세부정보 가져오기

다음 샘플은 주석 저장소에 대한 세부정보를 가져오는 방법을 보여줍니다.

gcloudAPI

주석 저장소에 대해 세부정보를 가져오려면 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

주석 저장소에 대해 세부정보를 가져오려면 projects.locations.datasets.annotationStores.get 메서드를 사용합니다.

curlPowerShell

주석 저장소에 대해 세부정보를 가져오려면 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 리소스에서 필드를 구성한 경우 응답에도 표시됩니다.

주석 저장소에 대해 세부정보를 가져오려면 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 리소스에서 필드를 구성한 경우 응답에도 표시됩니다.

데이터 세트의 주석 저장소 나열

다음 샘플은 데이터 세트의 주석 저장소를 나열하는 방법을 보여줍니다.

gcloudAPI

데이터 세트의 주석 저장소를 나열하려면 gcloud beta healthcare annotation-stores list 명령어를 실행합니다.

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

요청이 성공하면 명령어 프롬프트에 주석 저장소가 나열됩니다.

ID                   LOCATION
ANNOTATION_STORE_ID  LOCATION

데이터 세트의 주석 저장소를 나열하려면 projects.locations.datasets.annotationStores.list 메서드를 사용합니다.

curlPowerShell

데이터 세트의 주석 저장소를 나열하려면 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 리소스에서 필드를 구성한 경우 응답에도 표시됩니다.

데이터 세트의 주석 저장소를 나열하려면 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 리소스에서 필드를 구성한 경우 응답에도 표시됩니다.

주석 저장소 삭제

다음 샘플은 주석 저장소를 삭제하는 방법을 보여줍니다.

gcloudAPI

주석 저장소를 삭제하려면 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].

주석 저장소를 삭제하려면 projects.locations.datasets.annotationStores.delete 명령어를 사용합니다.

curlPowerShell

주석 저장소를 삭제하려면 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 형식으로 빈 응답 본문을 반환합니다.

{}

주석 저장소를 삭제하려면 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 형식으로 빈 응답 본문을 반환합니다.

{}