GoogleCloudAiplatformV1Annotation

import type { GoogleCloudAiplatformV1Annotation } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

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

interface GoogleCloudAiplatformV1Annotation {

readonly annotationSource?: GoogleCloudAiplatformV1UserActionReference;

readonly createTime?: Date;

etag?: string;

labels?: {

[key: string]: string;

};

readonly name?: string;

payload?: any;

payloadSchemaUri?: string;

readonly updateTime?: Date;

}

§Properties

readonly annotationSource?: GoogleCloudAiplatformV1UserActionReference

[src]

Output only. The source of the Annotation.

readonly createTime?: Date

[src]

Output only. Timestamp when this Annotation was created.

etag?: string

[src]

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

labels?: {

[key: string]: string;

}

[src]

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.

readonly name?: string

[src]

Output only. Resource name of the Annotation.

payload?: any

[src]

Required. The schema of the payload can be found in payload_schema.

payloadSchemaUri?: string

[src]

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.

readonly updateTime?: Date

[src]

Output only. Timestamp when this Annotation was last updated.