CreateDatasetDetails

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

Bases: object

Parameters needed to create a new Dataset. A Dataset allows a user to describe the data source that provides the Records and how Annotations should be applied to the Records.

Methods:

__init__(**kwargs)

Initializes a new CreateDatasetDetails object with values from keyword arguments.

Attributes:

annotation_format

[Required] Gets the annotation_format of this CreateDatasetDetails.

compartment_id

[Required] Gets the compartment_id of this CreateDatasetDetails.

dataset_format_details

[Required] Gets the dataset_format_details of this CreateDatasetDetails.

dataset_source_details

[Required] Gets the dataset_source_details of this CreateDatasetDetails.

defined_tags

Gets the defined_tags of this CreateDatasetDetails.

description

Gets the description of this CreateDatasetDetails.

display_name

Gets the display_name of this CreateDatasetDetails.

freeform_tags

Gets the freeform_tags of this CreateDatasetDetails.

initial_import_dataset_configuration

Gets the initial_import_dataset_configuration of this CreateDatasetDetails.

initial_record_generation_configuration

Gets the initial_record_generation_configuration of this CreateDatasetDetails.

label_set

[Required] Gets the label_set of this CreateDatasetDetails.

labeling_instructions

Gets the labeling_instructions of this CreateDatasetDetails.

__init__(**kwargs)

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

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

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

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

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

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

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

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

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

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

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

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

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

property annotation_format

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

Returns

The annotation_format of this CreateDatasetDetails.

Return type

str

property compartment_id

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

Returns

The compartment_id of this CreateDatasetDetails.

Return type

str

property dataset_format_details

[Required] Gets the dataset_format_details of this CreateDatasetDetails.

Returns

The dataset_format_details of this CreateDatasetDetails.

Return type

oci.data_labeling_service.models.DatasetFormatDetails

property dataset_source_details

[Required] Gets the dataset_source_details of this CreateDatasetDetails.

Returns

The dataset_source_details of this CreateDatasetDetails.

Return type

oci.data_labeling_service.models.DatasetSourceDetails

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this CreateDatasetDetails.

Return type

str

property display_name

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

Returns

The display_name of this CreateDatasetDetails.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property initial_import_dataset_configuration

Gets the initial_import_dataset_configuration of this CreateDatasetDetails.

Returns

The initial_import_dataset_configuration of this CreateDatasetDetails.

Return type

oci.data_labeling_service.models.InitialImportDatasetConfiguration

property initial_record_generation_configuration

Gets the initial_record_generation_configuration of this CreateDatasetDetails.

Returns

The initial_record_generation_configuration of this CreateDatasetDetails.

Return type

oci.data_labeling_service.models.InitialRecordGenerationConfiguration

property label_set

[Required] Gets the label_set of this CreateDatasetDetails.

Returns

The label_set of this CreateDatasetDetails.

Return type

oci.data_labeling_service.models.LabelSet

property labeling_instructions

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

Returns

The labeling_instructions of this CreateDatasetDetails.

Return type

str