Dataset

class oci.data_labeling_service.models.Dataset(**kwargs)

Bases: object

A dataset is a logical collection of records. The dataset contains all the information necessary to describe a record’s source, format, type of annotations allowed on these records, and labels allowed on annotations.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Dataset.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Dataset.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Dataset.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Dataset.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Dataset.

LIFECYCLE_STATE_NEEDS_ATTENTION

A constant which can be used with the lifecycle_state property of a Dataset.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Dataset.

LIFECYCLE_SUBSTATE_IMPORT_DATASET

A constant which can be used with the lifecycle_substate property of a Dataset.

additional_properties

Gets the additional_properties of this Dataset.

annotation_format

[Required] Gets the annotation_format of this Dataset.

compartment_id

[Required] Gets the compartment_id of this Dataset.

dataset_format_details

[Required] Gets the dataset_format_details of this Dataset.

dataset_source_details

[Required] Gets the dataset_source_details of this Dataset.

defined_tags

Gets the defined_tags of this Dataset.

description

Gets the description of this Dataset.

display_name

Gets the display_name of this Dataset.

freeform_tags

Gets the freeform_tags of this Dataset.

id

[Required] Gets the id of this Dataset.

initial_import_dataset_configuration

Gets the initial_import_dataset_configuration of this Dataset.

initial_record_generation_configuration

Gets the initial_record_generation_configuration of this Dataset.

label_set

[Required] Gets the label_set of this Dataset.

labeling_instructions

Gets the labeling_instructions of this Dataset.

lifecycle_details

Gets the lifecycle_details of this Dataset.

lifecycle_state

[Required] Gets the lifecycle_state of this Dataset.

lifecycle_substate

Gets the lifecycle_substate of this Dataset.

system_tags

Gets the system_tags of this Dataset.

time_created

[Required] Gets the time_created of this Dataset.

time_updated

[Required] Gets the time_updated of this Dataset.

Methods:

__init__(**kwargs)

Initializes a new Dataset object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Dataset. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Dataset. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Dataset. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Dataset. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Dataset. This constant has a value of “FAILED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

A constant which can be used with the lifecycle_state property of a Dataset. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Dataset. This constant has a value of “UPDATING”

LIFECYCLE_SUBSTATE_IMPORT_DATASET = 'IMPORT_DATASET'

A constant which can be used with the lifecycle_substate property of a Dataset. This constant has a value of “IMPORT_DATASET”

__init__(**kwargs)

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

Parameters
  • id (str) – The value to assign to the id property of this Dataset.

  • display_name (str) – The value to assign to the display_name property of this Dataset.

  • compartment_id (str) – The value to assign to the compartment_id property of this Dataset.

  • description (str) – The value to assign to the description property of this Dataset.

  • time_created (datetime) – The value to assign to the time_created property of this Dataset.

  • time_updated (datetime) – The value to assign to the time_updated property of this Dataset.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Dataset. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “NEEDS_ATTENTION”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Dataset.

  • lifecycle_substate (str) – The value to assign to the lifecycle_substate property of this Dataset. Allowed values for this property are: “IMPORT_DATASET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • annotation_format (str) – The value to assign to the annotation_format property of this Dataset.

  • dataset_source_details (oci.data_labeling_service.models.DatasetSourceDetails) – The value to assign to the dataset_source_details property of this Dataset.

  • dataset_format_details (oci.data_labeling_service.models.DatasetFormatDetails) – The value to assign to the dataset_format_details property of this Dataset.

  • label_set (oci.data_labeling_service.models.LabelSet) – The value to assign to the label_set property of this Dataset.

  • initial_record_generation_configuration (oci.data_labeling_service.models.InitialRecordGenerationConfiguration) – The value to assign to the initial_record_generation_configuration property of this Dataset.

  • initial_import_dataset_configuration (oci.data_labeling_service.models.InitialImportDatasetConfiguration) – The value to assign to the initial_import_dataset_configuration property of this Dataset.

  • labeling_instructions (str) – The value to assign to the labeling_instructions property of this Dataset.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Dataset.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Dataset.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Dataset.

  • additional_properties (dict(str, str)) – The value to assign to the additional_properties property of this Dataset.

property additional_properties

Gets the additional_properties of this Dataset. 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 additional_properties of this Dataset.

Return type

dict(str, str)

property annotation_format

[Required] Gets the annotation_format of this Dataset. The annotation format name required for labeling records.

Returns

The annotation_format of this Dataset.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this Dataset. The OCID of the compartment of the resource.

Returns

The compartment_id of this Dataset.

Return type

str

property dataset_format_details

[Required] Gets the dataset_format_details of this Dataset.

Returns

The dataset_format_details of this Dataset.

Return type

oci.data_labeling_service.models.DatasetFormatDetails

property dataset_source_details

[Required] Gets the dataset_source_details of this Dataset.

Returns

The dataset_source_details of this Dataset.

Return type

oci.data_labeling_service.models.DatasetSourceDetails

property defined_tags

Gets the defined_tags of this Dataset. 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 Dataset.

Return type

dict(str, dict(str, object))

property description

Gets the description of this Dataset. A user provided description of the dataset

Returns

The description of this Dataset.

Return type

str

property display_name

Gets the display_name of this Dataset. A user-friendly display name for the resource.

Returns

The display_name of this Dataset.

Return type

str

property freeform_tags

Gets the freeform_tags of this Dataset. 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 Dataset.

Return type

dict(str, str)

property id

[Required] Gets the id of this Dataset. The OCID of the Dataset.

Returns

The id of this Dataset.

Return type

str

property initial_import_dataset_configuration

Gets the initial_import_dataset_configuration of this Dataset.

Returns

The initial_import_dataset_configuration of this Dataset.

Return type

oci.data_labeling_service.models.InitialImportDatasetConfiguration

property initial_record_generation_configuration

Gets the initial_record_generation_configuration of this Dataset.

Returns

The initial_record_generation_configuration of this Dataset.

Return type

oci.data_labeling_service.models.InitialRecordGenerationConfiguration

property label_set

[Required] Gets the label_set of this Dataset.

Returns

The label_set of this Dataset.

Return type

oci.data_labeling_service.models.LabelSet

property labeling_instructions

Gets the labeling_instructions of this Dataset. The labeling instructions for human labelers in rich text format

Returns

The labeling_instructions of this Dataset.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this Dataset. A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in FAILED or NEEDS_ATTENTION state.

Returns

The lifecycle_details of this Dataset.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this Dataset. The state of a dataset. CREATING - The dataset is being created. It will transition to ACTIVE when it is ready for labeling. ACTIVE - The dataset is ready for labeling. UPDATING - The dataset is being updated. It and its related resources may be unavailable for other updates until it returns to ACTIVE. NEEDS_ATTENTION - A dataset updation operation has failed due to validation or other errors and needs attention. DELETING - The dataset and its related resources are being deleted. DELETED - The dataset has been deleted and is no longer available. FAILED - The dataset has failed due to validation or other errors.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “NEEDS_ATTENTION”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Dataset.

Return type

str

property lifecycle_substate

Gets the lifecycle_substate of this Dataset. The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.

Allowed values for this property are: “IMPORT_DATASET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_substate of this Dataset.

Return type

str

property system_tags

Gets the system_tags of this Dataset. The usage of system tag keys. These predefined keys are scoped to namespaces. For example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this Dataset.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this Dataset. The date and time the resource was created, in the timestamp format defined by RFC3339.

Returns

The time_created of this Dataset.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this Dataset. The date and time the resource was last updated, in the timestamp format defined by RFC3339.

Returns

The time_updated of this Dataset.

Return type

datetime