- 1.36.0 (latest)
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Annotation.
Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.
Generated from protobuf message google.cloud.aiplatform.v1.Annotation
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Resource name of the Annotation.
↳ payload_schema_uri
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 .
↳ payload
↳ create_time
Google\Protobuf\Timestamp
Output only. Timestamp when this Annotation was created.
↳ update_time
Google\Protobuf\Timestamp
Output only. Timestamp when this Annotation was last updated.
↳ etag
string
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
↳ annotation_source
↳ labels
array|Google\Protobuf\Internal\MapField
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.
getName
Output only. Resource name of the Annotation.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setName
Output only. Resource name of the Annotation.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getPayloadSchemaUri
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 .
Generated from protobuf field string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];
string
setPayloadSchemaUri
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 .
Generated from protobuf field string payload_schema_uri = 2 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getPayload
Required. The schema of the payload can be found in payload_schema .
Generated from protobuf field .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];
Google\Protobuf\Value|null
hasPayload
clearPayload
setPayload
Required. The schema of the payload can be found in payload_schema .
Generated from protobuf field .google.protobuf.Value payload = 3 [(.google.api.field_behavior) = REQUIRED];
var
Google\Protobuf\Value
$this
getCreateTime
Output only. Timestamp when this Annotation was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this Annotation was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getUpdateTime
Output only. Timestamp when this Annotation was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this Annotation was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getEtag
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
string
setEtag
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getAnnotationSource
Output only. The source of the Annotation.
Generated from protobuf field .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasAnnotationSource
clearAnnotationSource
setAnnotationSource
Output only. The source of the Annotation.
Generated from protobuf field .google.cloud.aiplatform.v1.UserActionReference annotation_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
$this
getLabels
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.
Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\MapField
setLabels
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.
Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
var
array|Google\Protobuf\Internal\MapField
$this
