Show / Hide Table of Contents

Class 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.

Inheritance
object
CreateDatasetDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DatalabelingService.Models
Assembly: OCI.DotNetSDK.Datalabelingservice.dll
Syntax
public class CreateDatasetDetails

Properties

AnnotationFormat

Declaration
[Required(ErrorMessage = "AnnotationFormat is required.")]
[JsonProperty(PropertyName = "annotationFormat")]
public string AnnotationFormat { get; set; }
Property Value
Type Description
string

The annotation format name required for labeling records.

Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment of the resource.

Remarks

Required

DatasetFormatDetails

Declaration
[Required(ErrorMessage = "DatasetFormatDetails is required.")]
[JsonProperty(PropertyName = "datasetFormatDetails")]
public DatasetFormatDetails DatasetFormatDetails { get; set; }
Property Value
Type Description
DatasetFormatDetails
Remarks

Required

DatasetSourceDetails

Declaration
[Required(ErrorMessage = "DatasetSourceDetails is required.")]
[JsonProperty(PropertyName = "datasetSourceDetails")]
public DatasetSourceDetails DatasetSourceDetails { get; set; }
Property Value
Type Description
DatasetSourceDetails
Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

A user provided description of the dataset

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly display name for the resource.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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"}

InitialImportDatasetConfiguration

Declaration
[JsonProperty(PropertyName = "initialImportDatasetConfiguration")]
public InitialImportDatasetConfiguration InitialImportDatasetConfiguration { get; set; }
Property Value
Type Description
InitialImportDatasetConfiguration

InitialRecordGenerationConfiguration

Declaration
[JsonProperty(PropertyName = "initialRecordGenerationConfiguration")]
public InitialRecordGenerationConfiguration InitialRecordGenerationConfiguration { get; set; }
Property Value
Type Description
InitialRecordGenerationConfiguration

LabelSet

Declaration
[Required(ErrorMessage = "LabelSet is required.")]
[JsonProperty(PropertyName = "labelSet")]
public LabelSet LabelSet { get; set; }
Property Value
Type Description
LabelSet
Remarks

Required

LabelingInstructions

Declaration
[JsonProperty(PropertyName = "labelingInstructions")]
public string LabelingInstructions { get; set; }
Property Value
Type Description
string

The labeling instructions for human labelers in rich text format

In this article
Back to top