Class Dataset
A dataset is a logical collection of records. The dataset contains all the information necessary to describe a record's source, format, the type of annotations allowed for the record, and the labels allowed on annotations.
Inherited Members
Namespace: Oci.DatalabelingservicedataplaneService.Models
Assembly: OCI.DotNetSDK.Datalabelingservicedataplane.dll
Syntax
public class Dataset
Properties
AdditionalProperties
Declaration
[JsonProperty(PropertyName = "additionalProperties")]
public Dictionary<string, string> AdditionalProperties { 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"} |
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"} |
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the Dataset. |
Remarks
Required
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 |
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type | Description |
---|---|
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
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Dataset.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
Dataset.LifecycleStateEnum? | 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. |
Remarks
Required
LifecycleSubstate
Declaration
[JsonProperty(PropertyName = "lifecycleSubstate")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Dataset.LifecycleSubstateEnum? LifecycleSubstate { get; set; }
Property Value
Type | Description |
---|---|
Dataset.LifecycleSubstateEnum? | The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported. |
SystemTags
Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | The usage of system tag keys. These predefined keys are scoped to namespaces. For Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the resource was created, in the timestamp format defined by RFC3339. |
Remarks
Required
TimeUpdated
Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the resource was last updated, in the timestamp format defined by RFC3339. |
Remarks
Required