CreateAnnotationDetails¶

class oci.data_labeling_service_dataplane.models.CreateAnnotationDetails(**kwargs)¶

Bases: object

This is the payload sent in the CreateAnnotation operation. It contains all the information required for a user to create an annotation for a record.

Methods

__init__(**kwargs) Initializes a new CreateAnnotationDetails object with values from keyword arguments.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreateAnnotationDetails.
`defined_tags`	Gets the defined_tags of this CreateAnnotationDetails.
`entities`	[Required] Gets the entities of this CreateAnnotationDetails.
`freeform_tags`	Gets the freeform_tags of this CreateAnnotationDetails.
`record_id`	[Required] Gets the record_id of this CreateAnnotationDetails.

__init__(**kwargs)¶

Initializes a new CreateAnnotationDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

record_id (str) – The value to assign to the record_id property of this CreateAnnotationDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateAnnotationDetails.
entities (list[oci.data_labeling_service_dataplane.models.Entity]) – The value to assign to the entities property of this CreateAnnotationDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateAnnotationDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateAnnotationDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateAnnotationDetails. The OCID of the compartment for the annotation.

Returns:	The compartment_id of this CreateAnnotationDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateAnnotationDetails. The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateAnnotationDetails.
Return type:	dict(str, dict(str, object))

entities¶

[Required] Gets the entities of this CreateAnnotationDetails. The entity types are validated against the dataset to ensure consistency.

Returns:	The entities of this CreateAnnotationDetails.
Return type:	list[oci.data_labeling_service_dataplane.models.Entity]

freeform_tags¶

Gets the freeform_tags of this CreateAnnotationDetails. A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreateAnnotationDetails.
Return type:	dict(str, str)

record_id¶

[Required] Gets the record_id of this CreateAnnotationDetails. The OCID of the record annotated.

Returns:	The record_id of this CreateAnnotationDetails.
Return type:	str