Show / Hide Table of Contents

Namespace Oci.DatalabelingService.Models

Classes

AddDatasetLabelsDetails

Adds a subset of Labels to the Dataset's LabelSet. This LabelSet will be merged with the current Dataset's LabelSet. Requests with duplicate Labels will be rejected.

AnnotationFormat

annotation format

AnnotationFormatCollection

Collection of annotation formats.

AnnotationFormatSummary

annotation format summary

ChangeDatasetCompartmentDetails

The payload sent to the Change Dataset compartment operation.

CreateDatasetDetails

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.

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.

DatasetCollection

Results of a dataset list operation. Contains DatasetSummary items.

DatasetFormatDetails

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

DatasetFormatDetailsModelConverter

DatasetSourceDetails

This allows the customer to specify the source of the dataset.

DatasetSourceDetailsModelConverter

DatasetSummary

A dataset summary is the representation returned in list views. It is usually a subset of the full dataset entity and should not contain any potentially sensitive information.

DelimitedFileTypeMetadata

Metadata of delimited files.

DocumentDatasetFormatDetails

It indicates the dataset is comprised of document files. It is open for further configurability.

ExportFormat

Specifies the export format to be used for exporting snapshot.

GenerateDatasetRecordsDetails

Generate Records from the Dataset's source.

ImageDatasetFormatDetails

It indicates the dataset is comprised of images.

ImportFormat

File format details used for importing dataset

ImportMetadataPath

Object storage path for the metadata file

ImportMetadataPathModelConverter

ImportPreAnnotatedDataDetails

Allows user to import dataset labels, records and annotations from dataset files

InitialImportDatasetConfiguration

Initial import dataset configuration. Allows user to create dataset from existing dataset files.

InitialRecordGenerationConfiguration

The initial generate records configuration. It generates records from the dataset's source.

Label

It represents a label.

LabelSet

An ordered collection of labels that are unique by name.

ObjectStorageImportMetadataPath

Object Storage details for import metadata path.

ObjectStorageSnapshotExportDetails

Specifies where to output the export in Object Storage.

ObjectStorageSourceDetails

Specifies the dataset location in object storage. This requires that all records are in this bucket, and under this prefix. We do not support a dataset with objects in arbitrary locations across buckets or prefixes.

RemoveDatasetLabelsDetails

Removes a subset of Labels from the Dataset's LabelSet. This LabelSet will be subtracted from the current Dataset's LabelSet. Requests\u00A0with non-existent Labels will be rejected.

RenameDatasetLabelsDetails

Renames a subset of Labels in the Dataset's LabelSet. The Labels in the source LabelSet will be replaced with the Labels in the target LabelSet. Labels are correlated by index, i.e. the first Label in the source LabelSet will be replaced by the first Label in the target LabelSet. If the size of the\u00A0source and target LabelSets are not equal, the request will be rejected.

SnapshotDatasetDetails

Allows outputting the latest records paired with annotations and write them to object storage.

SnapshotExportDetails

Specifies where to output the export.

SnapshotExportDetailsModelConverter

TextDatasetFormatDetails

It indicates the dataset is comprised of TXT files.

TextFileTypeMetadata

Metadata for files with text content.

TextFileTypeMetadataModelConverter

UpdateDatasetDetails

Once the Dataset is defined, it's largely immutable from a metadata perspective. The records found in the data source itself, may change over time.

WorkRequest

A description of workrequest status

WorkRequestError

An error encountered while executing a work request.

WorkRequestErrorCollection

Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.

WorkRequestLogEntry

A log message from the execution of a work request.

WorkRequestLogEntryCollection

Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.

WorkRequestResource

A resource created or operated on by a work request.

WorkRequestSummary

A summary of the status of a work request.

WorkRequestSummaryCollection

Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

Enums

ActionType

Possible types of actions.

Dataset.LifecycleStateEnum

Dataset.LifecycleSubstateEnum

DatasetFormatDetails.FormatTypeEnum

DatasetSourceDetails.SourceTypeEnum

ExportFormat.NameEnum

ExportFormat.VersionEnum

ImportFormat.NameEnum

ImportFormat.VersionEnum

ImportMetadataPath.SourceTypeEnum

OperationStatus

Possible operation status.

OperationType

Possible operation types.

SnapshotExportDetails.ExportTypeEnum

SortOrder

Sort orders.

TextFileTypeMetadata.FormatTypeEnum

WorkRequestResourceMetadataKey

Possible Metadata keys for workRequest resource metadata

In this article
Back to top