REST Resource: projects.locations.datasets.annotationStores.annotations

Resource: Annotation

An annotation record.

JSON representation
{
  "name": string,
  "annotationSource": {
    object (AnnotationSource)
  },

  // Union field data can be only one of the following:
  "resourceAnnotation": {
    object (ResourceAnnotation)
  },
  "imageAnnotation": {
    object (ImageAnnotation)
  },
  "textAnnotation": {
    object (SensitiveTextAnnotation)
  }
  // End of list of possible types for union field data.
}
Fields
name

string

Output only. Resource name of the Annotation, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/annotationStores/{annotationStoreId}/annotations/{annotation_id}.

annotationSource

object (AnnotationSource)

Details of the source.

Union field data.

data can be only one of the following:

resourceAnnotation

object (ResourceAnnotation)

Annotations for resource, e.g., classification tags.

imageAnnotation

object (ImageAnnotation)

Annnotations for images, e.g., bounding polygons.

textAnnotation

object (SensitiveTextAnnotation)

Annotations for sentitive texts, e.g., range of such texts.

AnnotationSource

AnnotationSource holds the source information of the annotation.

JSON representation
{
  "cloudHealthcareSource": {
    object (CloudHealthcareSource)
  }
}
Fields
cloudHealthcareSource

object (CloudHealthcareSource)

Cloud Healthcare API resource.

CloudHealthcareSource

Cloud Healthcare API resource.

JSON representation
{
  "name": string
}
Fields
name

string

Full path of a Cloud Healthcare API resource.

ResourceAnnotation

Resource level annotation.

JSON representation
{
  "label": string
}
Fields
label

string

ImageAnnotation

Image annotation.

JSON representation
{
  "boundingPolys": [
    {
      object (BoundingPoly)
    }
  ]
}
Fields
boundingPolys[]

object (BoundingPoly)

The list of polygons outlining the sensitive regions in the image.

BoundingPoly

A bounding polygon for the detected image annotation.

JSON representation
{
  "vertices": [
    {
      object (Vertex)
    }
  ],
  "label": string
}
Fields
vertices[]

object (Vertex)

label

string

Vertex

A 2D coordinate in an image. The origin is the top-left.

JSON representation
{
  "x": number,
  "y": number
}
Fields
x

number

X coordinate.

y

number

Y coordinate.

SensitiveTextAnnotation

A TextAnnotation specifies a text range that includes sensitive information.

JSON representation
{
  "details": {
    string: {
      object(Detail)
    },
    ...
  }
}
Fields
details

map (key: string, value: object (Detail))

Maps from a resource slice (e.g. FHIR resource field path) to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3}

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods

create

Creates a new Annotation record.

delete

Deletes an Annotation or returns NOT_FOUND if it does not exist.

get

Gets an Annotation.

list

Lists the Annotations in the given Annotation store for a source resource.

patch

Updates the Annotation.
Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Healthcare API