Stay organized with collections
Save and categorize content based on your preferences.
Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.
Fields
name
string
Output only. Resource name of the Annotation.
payloadSchemaUri
string
Required. Google Cloud Storage URI points to a YAML file describing payload. The schema is defined as an OpenAPI 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's metadata.
Output only. timestamp when this Annotation was created.
Uses RFC 3339, where generated output will always be Z-normalized and uses 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".
Output only. timestamp when this Annotation was last updated.
Uses RFC 3339, where generated output will always be Z-normalized and uses 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".
etag
string
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
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).
See https://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 the payload_schema's title.
References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.
Fields
method
string
The method name of the API RPC call. For example, "/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset"
reference
Union type
reference can be only one of the following:
operation
string
For API calls that return a long running operation. Resource name of the long running operation. Format: projects/{project}/locations/{location}/operations/{operation}
dataLabelingJob
string
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}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Annotation\n\nUsed to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.\nFields `name` `string` \nOutput only. Resource name of the Annotation.\n`payloadSchemaUri` `string` \nRequired. Google Cloud Storage URI points to a YAML file describing [payload](/vertex-ai/docs/reference/rest/v1/Annotation#FIELDS.payload). The schema is defined as an [OpenAPI 3.0.2 Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 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's [metadata](/vertex-ai/docs/reference/rest/v1/projects.locations.datasets#Dataset.FIELDS.metadata_schema_uri).\n`payload` `value (`[Value](https://protobuf.dev/reference/protobuf/google.protobuf/#value)` format)` \nRequired. The schema of the payload can be found in [payload_schema](/vertex-ai/docs/reference/rest/v1/Annotation#FIELDS.payload_schema_uri).\n`createTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this Annotation was created.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 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\"`.\n`updateTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this Annotation was last updated.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 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\"`.\n`etag` `string` \nOptional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.\n`annotationSource` `object (`[UserActionReference](/vertex-ai/docs/reference/rest/v1/Annotation#UserActionReference)`)` \nOutput only. The source of the Annotation.\n`labels` `map (key: string, value: string)` \nOptional. The labels with user-defined metadata to organize your Annotations.\n\nlabel 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).\n\nSee \u003chttps://goo.gl/xmQnxf\u003e 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:\n\n- \"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.\n\n- \"aiplatform.googleapis.com/payload_schema\": output only, its value is the [payload_schema's](/vertex-ai/docs/reference/rest/v1/Annotation#FIELDS.payload_schema_uri) title.\n\nUserActionReference\n-------------------\n\nReferences an API call. It contains more information about long running operation and Jobs that are triggered by the API call.\nFields `method` `string` \nThe method name of the API RPC call. For example, \"/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset\" \n`reference` `Union type` \n`reference` can be only one of the following:\n`operation` `string` \nFor API calls that return a long running operation. Resource name of the long running operation. Format: `projects/{project}/locations/{location}/operations/{operation}`\n`dataLabelingJob` `string` \nFor API calls that start a LabelingJob. Resource name of the LabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{dataLabelingJob}`"]]