Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Dataset

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.

Properties

Optional additionalProperties

additionalProperties: undefined | object

A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {@code {"bar-key": "value"}}

annotationFormat

annotationFormat: string

The annotation format name required for labeling records.

compartmentId

compartmentId: string

The OCID of the compartment of the resource.

datasetFormatDetails

datasetSourceDetails

datasetSourceDetails: ObjectStorageSourceDetails

Optional definedTags

definedTags: undefined | object

The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

A user provided description of the dataset

Optional displayName

displayName: undefined | string

A user-friendly display name for the resource.

Optional freeformTags

freeformTags: undefined | object

A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {@code {"bar-key": "value"}}

id

id: string

The OCID of the Dataset.

Optional initialImportDatasetConfiguration

initialImportDatasetConfiguration: model.InitialImportDatasetConfiguration

Optional initialRecordGenerationConfiguration

initialRecordGenerationConfiguration: model.InitialRecordGenerationConfiguration

labelSet

labelSet: LabelSet

Optional labelingInstructions

labelingInstructions: undefined | string

The labeling instructions for human labelers in rich text format

Optional lifecycleDetails

lifecycleDetails: undefined | string

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.

lifecycleState

lifecycleState: LifecycleState

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.

Optional lifecycleSubstate

lifecycleSubstate: LifecycleSubstate

The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.

Optional systemTags

systemTags: undefined | object

The usage of system tag keys. These predefined keys are scoped to namespaces. For example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

timeCreated

timeCreated: Date

The date and time the resource was created, in the timestamp format defined by RFC3339.

timeUpdated

timeUpdated: Date

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Dataset): object

getJsonObj