Annotation

Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.

Fields
namestring

Output only. Resource name of the Annotation.

payloadSchemaUristring

Required. Google Cloud Storage URI points to a YAML file describingpayload. The schema is defined as anOpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with the parent Dataset'smetadata.

payloadvalue (Value format)

Required. The schema of the payload can be found inpayload_schema.

createTimestring (Timestamp format)

Output only. timestamp when this Annotation was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

updateTimestring (Timestamp format)

Output only. timestamp when this Annotation was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

etagstring

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

annotationSourceobject (UserActionReference)

Output only. The source of the Annotation.

labelsmap (key: string, value: string)

Optional. The labels with user-defined metadata to organize your Annotations.

label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Annotation(System labels are excluded).

Seehttps://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Annotation:

  • "aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI.

  • "aiplatform.googleapis.com/payload_schema": output only, its value is thepayload_schema's title.

JSON representation
{"name":string,"payloadSchemaUri":string,"payload":value,"createTime":string,"updateTime":string,"etag":string,"annotationSource":{object (UserActionReference)},"labels":{string:string,...}}

UserActionReference

References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.

Fields
methodstring

The method name of the API RPC call. For example, "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset"

referenceUnion type
reference can be only one of the following:
operationstring

For API calls that return a long running operation. Resource name of the long running operation. Format:projects/{project}/locations/{location}/operations/{operation}

dataLabelingJobstring

For API calls that start a LabelingJob. Resource name of the LabelingJob. Format:projects/{project}/locations/{location}/dataLabelingJobs/{dataLabelingJob}

JSON representation
{"method":string,// reference"operation":string,"dataLabelingJob":string// Union type}

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-22 UTC.