annotations

Creates, updates, deletes, gets or lists an annotations resource.

Overview

Name	annotations
Type	Resource
Id	google.aiplatform.annotations

Fields

The following fields are returned by SELECT queries:

list

Successful response

Name	Datatype	Description
name	string	Output only. Resource name of the Annotation.
annotationSource	object	Output only. The source of the Annotation. (id: GoogleCloudAiplatformV1UserActionReference)
createTime	string (google-datetime)	Output only. Timestamp when this Annotation was created.
etag	string	Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	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.
payload	any	Required. The schema of the payload can be found in payload_schema.
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.
updateTime	string (google-datetime)	Output only. Timestamp when this Annotation was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	projectsId, locationsId, datasetsId, dataItemsId	filter, pageSize, pageToken, readMask, orderBy	Lists Annotations belongs to a dataitem.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dataItemsId	string
datasetsId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)

SELECT examples

list

Lists Annotations belongs to a dataitem.

SELECT
name,
annotationSource,
createTime,
etag,
labels,
payload,
payloadSchemaUri,
updateTime
FROM google.aiplatform.annotations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND dataItemsId = '{{ dataItemsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND readMask = '{{ readMask }}'
AND orderBy = '{{ orderBy }}';