oci.DataLabellingService.Dataset
Explore with Pulumi AI
This resource provides the Dataset resource in Oracle Cloud Infrastructure Data Labeling Service service.
Creates a new Dataset.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDataset = new oci.datalabellingservice.Dataset("test_dataset", {
annotationFormat: datasetAnnotationFormat,
compartmentId: compartmentId,
datasetFormatDetails: {
formatType: datasetDatasetFormatDetailsFormatType,
textFileTypeMetadata: {
columnIndex: datasetDatasetFormatDetailsTextFileTypeMetadataColumnIndex,
formatType: datasetDatasetFormatDetailsTextFileTypeMetadataFormatType,
columnDelimiter: datasetDatasetFormatDetailsTextFileTypeMetadataColumnDelimiter,
columnName: datasetDatasetFormatDetailsTextFileTypeMetadataColumnName,
escapeCharacter: datasetDatasetFormatDetailsTextFileTypeMetadataEscapeCharacter,
lineDelimiter: datasetDatasetFormatDetailsTextFileTypeMetadataLineDelimiter,
},
},
datasetSourceDetails: {
bucket: datasetDatasetSourceDetailsBucket,
namespace: datasetDatasetSourceDetailsNamespace,
sourceType: datasetDatasetSourceDetailsSourceType,
prefix: datasetDatasetSourceDetailsPrefix,
},
labelSet: {
items: [{
name: datasetLabelSetItemsName,
}],
},
definedTags: datasetDefinedTags,
description: datasetDescription,
displayName: datasetDisplayName,
freeformTags: datasetFreeformTags,
initialImportDatasetConfiguration: {
importFormat: {
name: datasetInitialImportDatasetConfigurationImportFormatName,
version: datasetInitialImportDatasetConfigurationImportFormatVersion,
},
importMetadataPath: {
bucket: datasetInitialImportDatasetConfigurationImportMetadataPathBucket,
namespace: datasetInitialImportDatasetConfigurationImportMetadataPathNamespace,
path: datasetInitialImportDatasetConfigurationImportMetadataPathPath,
sourceType: datasetInitialImportDatasetConfigurationImportMetadataPathSourceType,
},
},
initialRecordGenerationConfiguration: {},
labelingInstructions: datasetLabelingInstructions,
});
import pulumi
import pulumi_oci as oci
test_dataset = oci.data_labelling_service.Dataset("test_dataset",
annotation_format=dataset_annotation_format,
compartment_id=compartment_id,
dataset_format_details={
"format_type": dataset_dataset_format_details_format_type,
"text_file_type_metadata": {
"column_index": dataset_dataset_format_details_text_file_type_metadata_column_index,
"format_type": dataset_dataset_format_details_text_file_type_metadata_format_type,
"column_delimiter": dataset_dataset_format_details_text_file_type_metadata_column_delimiter,
"column_name": dataset_dataset_format_details_text_file_type_metadata_column_name,
"escape_character": dataset_dataset_format_details_text_file_type_metadata_escape_character,
"line_delimiter": dataset_dataset_format_details_text_file_type_metadata_line_delimiter,
},
},
dataset_source_details={
"bucket": dataset_dataset_source_details_bucket,
"namespace": dataset_dataset_source_details_namespace,
"source_type": dataset_dataset_source_details_source_type,
"prefix": dataset_dataset_source_details_prefix,
},
label_set={
"items": [{
"name": dataset_label_set_items_name,
}],
},
defined_tags=dataset_defined_tags,
description=dataset_description,
display_name=dataset_display_name,
freeform_tags=dataset_freeform_tags,
initial_import_dataset_configuration={
"import_format": {
"name": dataset_initial_import_dataset_configuration_import_format_name,
"version": dataset_initial_import_dataset_configuration_import_format_version,
},
"import_metadata_path": {
"bucket": dataset_initial_import_dataset_configuration_import_metadata_path_bucket,
"namespace": dataset_initial_import_dataset_configuration_import_metadata_path_namespace,
"path": dataset_initial_import_dataset_configuration_import_metadata_path_path,
"source_type": dataset_initial_import_dataset_configuration_import_metadata_path_source_type,
},
},
initial_record_generation_configuration={},
labeling_instructions=dataset_labeling_instructions)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/DataLabellingService"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := DataLabellingService.NewDataset(ctx, "test_dataset", &DataLabellingService.DatasetArgs{
AnnotationFormat: pulumi.Any(datasetAnnotationFormat),
CompartmentId: pulumi.Any(compartmentId),
DatasetFormatDetails: &datalabellingservice.DatasetDatasetFormatDetailsArgs{
FormatType: pulumi.Any(datasetDatasetFormatDetailsFormatType),
TextFileTypeMetadata: &datalabellingservice.DatasetDatasetFormatDetailsTextFileTypeMetadataArgs{
ColumnIndex: pulumi.Any(datasetDatasetFormatDetailsTextFileTypeMetadataColumnIndex),
FormatType: pulumi.Any(datasetDatasetFormatDetailsTextFileTypeMetadataFormatType),
ColumnDelimiter: pulumi.Any(datasetDatasetFormatDetailsTextFileTypeMetadataColumnDelimiter),
ColumnName: pulumi.Any(datasetDatasetFormatDetailsTextFileTypeMetadataColumnName),
EscapeCharacter: pulumi.Any(datasetDatasetFormatDetailsTextFileTypeMetadataEscapeCharacter),
LineDelimiter: pulumi.Any(datasetDatasetFormatDetailsTextFileTypeMetadataLineDelimiter),
},
},
DatasetSourceDetails: &datalabellingservice.DatasetDatasetSourceDetailsArgs{
Bucket: pulumi.Any(datasetDatasetSourceDetailsBucket),
Namespace: pulumi.Any(datasetDatasetSourceDetailsNamespace),
SourceType: pulumi.Any(datasetDatasetSourceDetailsSourceType),
Prefix: pulumi.Any(datasetDatasetSourceDetailsPrefix),
},
LabelSet: &datalabellingservice.DatasetLabelSetArgs{
Items: datalabellingservice.DatasetLabelSetItemArray{
&datalabellingservice.DatasetLabelSetItemArgs{
Name: pulumi.Any(datasetLabelSetItemsName),
},
},
},
DefinedTags: pulumi.Any(datasetDefinedTags),
Description: pulumi.Any(datasetDescription),
DisplayName: pulumi.Any(datasetDisplayName),
FreeformTags: pulumi.Any(datasetFreeformTags),
InitialImportDatasetConfiguration: &datalabellingservice.DatasetInitialImportDatasetConfigurationArgs{
ImportFormat: &datalabellingservice.DatasetInitialImportDatasetConfigurationImportFormatArgs{
Name: pulumi.Any(datasetInitialImportDatasetConfigurationImportFormatName),
Version: pulumi.Any(datasetInitialImportDatasetConfigurationImportFormatVersion),
},
ImportMetadataPath: &datalabellingservice.DatasetInitialImportDatasetConfigurationImportMetadataPathArgs{
Bucket: pulumi.Any(datasetInitialImportDatasetConfigurationImportMetadataPathBucket),
Namespace: pulumi.Any(datasetInitialImportDatasetConfigurationImportMetadataPathNamespace),
Path: pulumi.Any(datasetInitialImportDatasetConfigurationImportMetadataPathPath),
SourceType: pulumi.Any(datasetInitialImportDatasetConfigurationImportMetadataPathSourceType),
},
},
InitialRecordGenerationConfiguration: nil,
LabelingInstructions: pulumi.Any(datasetLabelingInstructions),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testDataset = new Oci.DataLabellingService.Dataset("test_dataset", new()
{
AnnotationFormat = datasetAnnotationFormat,
CompartmentId = compartmentId,
DatasetFormatDetails = new Oci.DataLabellingService.Inputs.DatasetDatasetFormatDetailsArgs
{
FormatType = datasetDatasetFormatDetailsFormatType,
TextFileTypeMetadata = new Oci.DataLabellingService.Inputs.DatasetDatasetFormatDetailsTextFileTypeMetadataArgs
{
ColumnIndex = datasetDatasetFormatDetailsTextFileTypeMetadataColumnIndex,
FormatType = datasetDatasetFormatDetailsTextFileTypeMetadataFormatType,
ColumnDelimiter = datasetDatasetFormatDetailsTextFileTypeMetadataColumnDelimiter,
ColumnName = datasetDatasetFormatDetailsTextFileTypeMetadataColumnName,
EscapeCharacter = datasetDatasetFormatDetailsTextFileTypeMetadataEscapeCharacter,
LineDelimiter = datasetDatasetFormatDetailsTextFileTypeMetadataLineDelimiter,
},
},
DatasetSourceDetails = new Oci.DataLabellingService.Inputs.DatasetDatasetSourceDetailsArgs
{
Bucket = datasetDatasetSourceDetailsBucket,
Namespace = datasetDatasetSourceDetailsNamespace,
SourceType = datasetDatasetSourceDetailsSourceType,
Prefix = datasetDatasetSourceDetailsPrefix,
},
LabelSet = new Oci.DataLabellingService.Inputs.DatasetLabelSetArgs
{
Items = new[]
{
new Oci.DataLabellingService.Inputs.DatasetLabelSetItemArgs
{
Name = datasetLabelSetItemsName,
},
},
},
DefinedTags = datasetDefinedTags,
Description = datasetDescription,
DisplayName = datasetDisplayName,
FreeformTags = datasetFreeformTags,
InitialImportDatasetConfiguration = new Oci.DataLabellingService.Inputs.DatasetInitialImportDatasetConfigurationArgs
{
ImportFormat = new Oci.DataLabellingService.Inputs.DatasetInitialImportDatasetConfigurationImportFormatArgs
{
Name = datasetInitialImportDatasetConfigurationImportFormatName,
Version = datasetInitialImportDatasetConfigurationImportFormatVersion,
},
ImportMetadataPath = new Oci.DataLabellingService.Inputs.DatasetInitialImportDatasetConfigurationImportMetadataPathArgs
{
Bucket = datasetInitialImportDatasetConfigurationImportMetadataPathBucket,
Namespace = datasetInitialImportDatasetConfigurationImportMetadataPathNamespace,
Path = datasetInitialImportDatasetConfigurationImportMetadataPathPath,
SourceType = datasetInitialImportDatasetConfigurationImportMetadataPathSourceType,
},
},
InitialRecordGenerationConfiguration = null,
LabelingInstructions = datasetLabelingInstructions,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataLabellingService.Dataset;
import com.pulumi.oci.DataLabellingService.DatasetArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetDatasetFormatDetailsArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetDatasetFormatDetailsTextFileTypeMetadataArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetDatasetSourceDetailsArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetLabelSetArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetInitialImportDatasetConfigurationArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetInitialImportDatasetConfigurationImportFormatArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetInitialImportDatasetConfigurationImportMetadataPathArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetInitialRecordGenerationConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testDataset = new Dataset("testDataset", DatasetArgs.builder()
.annotationFormat(datasetAnnotationFormat)
.compartmentId(compartmentId)
.datasetFormatDetails(DatasetDatasetFormatDetailsArgs.builder()
.formatType(datasetDatasetFormatDetailsFormatType)
.textFileTypeMetadata(DatasetDatasetFormatDetailsTextFileTypeMetadataArgs.builder()
.columnIndex(datasetDatasetFormatDetailsTextFileTypeMetadataColumnIndex)
.formatType(datasetDatasetFormatDetailsTextFileTypeMetadataFormatType)
.columnDelimiter(datasetDatasetFormatDetailsTextFileTypeMetadataColumnDelimiter)
.columnName(datasetDatasetFormatDetailsTextFileTypeMetadataColumnName)
.escapeCharacter(datasetDatasetFormatDetailsTextFileTypeMetadataEscapeCharacter)
.lineDelimiter(datasetDatasetFormatDetailsTextFileTypeMetadataLineDelimiter)
.build())
.build())
.datasetSourceDetails(DatasetDatasetSourceDetailsArgs.builder()
.bucket(datasetDatasetSourceDetailsBucket)
.namespace(datasetDatasetSourceDetailsNamespace)
.sourceType(datasetDatasetSourceDetailsSourceType)
.prefix(datasetDatasetSourceDetailsPrefix)
.build())
.labelSet(DatasetLabelSetArgs.builder()
.items(DatasetLabelSetItemArgs.builder()
.name(datasetLabelSetItemsName)
.build())
.build())
.definedTags(datasetDefinedTags)
.description(datasetDescription)
.displayName(datasetDisplayName)
.freeformTags(datasetFreeformTags)
.initialImportDatasetConfiguration(DatasetInitialImportDatasetConfigurationArgs.builder()
.importFormat(DatasetInitialImportDatasetConfigurationImportFormatArgs.builder()
.name(datasetInitialImportDatasetConfigurationImportFormatName)
.version(datasetInitialImportDatasetConfigurationImportFormatVersion)
.build())
.importMetadataPath(DatasetInitialImportDatasetConfigurationImportMetadataPathArgs.builder()
.bucket(datasetInitialImportDatasetConfigurationImportMetadataPathBucket)
.namespace(datasetInitialImportDatasetConfigurationImportMetadataPathNamespace)
.path(datasetInitialImportDatasetConfigurationImportMetadataPathPath)
.sourceType(datasetInitialImportDatasetConfigurationImportMetadataPathSourceType)
.build())
.build())
.initialRecordGenerationConfiguration()
.labelingInstructions(datasetLabelingInstructions)
.build());
}
}
resources:
testDataset:
type: oci:DataLabellingService:Dataset
name: test_dataset
properties:
annotationFormat: ${datasetAnnotationFormat}
compartmentId: ${compartmentId}
datasetFormatDetails:
formatType: ${datasetDatasetFormatDetailsFormatType}
textFileTypeMetadata:
columnIndex: ${datasetDatasetFormatDetailsTextFileTypeMetadataColumnIndex}
formatType: ${datasetDatasetFormatDetailsTextFileTypeMetadataFormatType}
columnDelimiter: ${datasetDatasetFormatDetailsTextFileTypeMetadataColumnDelimiter}
columnName: ${datasetDatasetFormatDetailsTextFileTypeMetadataColumnName}
escapeCharacter: ${datasetDatasetFormatDetailsTextFileTypeMetadataEscapeCharacter}
lineDelimiter: ${datasetDatasetFormatDetailsTextFileTypeMetadataLineDelimiter}
datasetSourceDetails:
bucket: ${datasetDatasetSourceDetailsBucket}
namespace: ${datasetDatasetSourceDetailsNamespace}
sourceType: ${datasetDatasetSourceDetailsSourceType}
prefix: ${datasetDatasetSourceDetailsPrefix}
labelSet:
items:
- name: ${datasetLabelSetItemsName}
definedTags: ${datasetDefinedTags}
description: ${datasetDescription}
displayName: ${datasetDisplayName}
freeformTags: ${datasetFreeformTags}
initialImportDatasetConfiguration:
importFormat:
name: ${datasetInitialImportDatasetConfigurationImportFormatName}
version: ${datasetInitialImportDatasetConfigurationImportFormatVersion}
importMetadataPath:
bucket: ${datasetInitialImportDatasetConfigurationImportMetadataPathBucket}
namespace: ${datasetInitialImportDatasetConfigurationImportMetadataPathNamespace}
path: ${datasetInitialImportDatasetConfigurationImportMetadataPathPath}
sourceType: ${datasetInitialImportDatasetConfigurationImportMetadataPathSourceType}
initialRecordGenerationConfiguration: {}
labelingInstructions: ${datasetLabelingInstructions}
Create Dataset Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Dataset(name: string, args: DatasetArgs, opts?: CustomResourceOptions);
@overload
def Dataset(resource_name: str,
args: DatasetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Dataset(resource_name: str,
opts: Optional[ResourceOptions] = None,
annotation_format: Optional[str] = None,
compartment_id: Optional[str] = None,
dataset_format_details: Optional[_datalabellingservice.DatasetDatasetFormatDetailsArgs] = None,
dataset_source_details: Optional[_datalabellingservice.DatasetDatasetSourceDetailsArgs] = None,
label_set: Optional[_datalabellingservice.DatasetLabelSetArgs] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
initial_import_dataset_configuration: Optional[_datalabellingservice.DatasetInitialImportDatasetConfigurationArgs] = None,
initial_record_generation_configuration: Optional[_datalabellingservice.DatasetInitialRecordGenerationConfigurationArgs] = None,
labeling_instructions: Optional[str] = None)
func NewDataset(ctx *Context, name string, args DatasetArgs, opts ...ResourceOption) (*Dataset, error)
public Dataset(string name, DatasetArgs args, CustomResourceOptions? opts = null)
public Dataset(String name, DatasetArgs args)
public Dataset(String name, DatasetArgs args, CustomResourceOptions options)
type: oci:DataLabellingService:Dataset
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DatasetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DatasetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DatasetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatasetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DatasetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var datasetResource = new Oci.DataLabellingService.Dataset("datasetResource", new()
{
AnnotationFormat = "string",
CompartmentId = "string",
DatasetFormatDetails = new Oci.DataLabellingService.Inputs.DatasetDatasetFormatDetailsArgs
{
FormatType = "string",
TextFileTypeMetadata = new Oci.DataLabellingService.Inputs.DatasetDatasetFormatDetailsTextFileTypeMetadataArgs
{
ColumnIndex = 0,
FormatType = "string",
ColumnDelimiter = "string",
ColumnName = "string",
EscapeCharacter = "string",
LineDelimiter = "string",
},
},
DatasetSourceDetails = new Oci.DataLabellingService.Inputs.DatasetDatasetSourceDetailsArgs
{
Bucket = "string",
Namespace = "string",
SourceType = "string",
Prefix = "string",
},
LabelSet = new Oci.DataLabellingService.Inputs.DatasetLabelSetArgs
{
Items = new[]
{
new Oci.DataLabellingService.Inputs.DatasetLabelSetItemArgs
{
Name = "string",
},
},
},
DefinedTags =
{
{ "string", "string" },
},
Description = "string",
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
InitialImportDatasetConfiguration = new Oci.DataLabellingService.Inputs.DatasetInitialImportDatasetConfigurationArgs
{
ImportFormat = new Oci.DataLabellingService.Inputs.DatasetInitialImportDatasetConfigurationImportFormatArgs
{
Name = "string",
Version = "string",
},
ImportMetadataPath = new Oci.DataLabellingService.Inputs.DatasetInitialImportDatasetConfigurationImportMetadataPathArgs
{
Bucket = "string",
Namespace = "string",
Path = "string",
SourceType = "string",
},
},
InitialRecordGenerationConfiguration = null,
LabelingInstructions = "string",
});
example, err := DataLabellingService.NewDataset(ctx, "datasetResource", &DataLabellingService.DatasetArgs{
AnnotationFormat: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
DatasetFormatDetails: &datalabellingservice.DatasetDatasetFormatDetailsArgs{
FormatType: pulumi.String("string"),
TextFileTypeMetadata: &datalabellingservice.DatasetDatasetFormatDetailsTextFileTypeMetadataArgs{
ColumnIndex: pulumi.Int(0),
FormatType: pulumi.String("string"),
ColumnDelimiter: pulumi.String("string"),
ColumnName: pulumi.String("string"),
EscapeCharacter: pulumi.String("string"),
LineDelimiter: pulumi.String("string"),
},
},
DatasetSourceDetails: &datalabellingservice.DatasetDatasetSourceDetailsArgs{
Bucket: pulumi.String("string"),
Namespace: pulumi.String("string"),
SourceType: pulumi.String("string"),
Prefix: pulumi.String("string"),
},
LabelSet: &datalabellingservice.DatasetLabelSetArgs{
Items: datalabellingservice.DatasetLabelSetItemArray{
&datalabellingservice.DatasetLabelSetItemArgs{
Name: pulumi.String("string"),
},
},
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
InitialImportDatasetConfiguration: &datalabellingservice.DatasetInitialImportDatasetConfigurationArgs{
ImportFormat: &datalabellingservice.DatasetInitialImportDatasetConfigurationImportFormatArgs{
Name: pulumi.String("string"),
Version: pulumi.String("string"),
},
ImportMetadataPath: &datalabellingservice.DatasetInitialImportDatasetConfigurationImportMetadataPathArgs{
Bucket: pulumi.String("string"),
Namespace: pulumi.String("string"),
Path: pulumi.String("string"),
SourceType: pulumi.String("string"),
},
},
InitialRecordGenerationConfiguration: nil,
LabelingInstructions: pulumi.String("string"),
})
var datasetResource = new Dataset("datasetResource", DatasetArgs.builder()
.annotationFormat("string")
.compartmentId("string")
.datasetFormatDetails(DatasetDatasetFormatDetailsArgs.builder()
.formatType("string")
.textFileTypeMetadata(DatasetDatasetFormatDetailsTextFileTypeMetadataArgs.builder()
.columnIndex(0)
.formatType("string")
.columnDelimiter("string")
.columnName("string")
.escapeCharacter("string")
.lineDelimiter("string")
.build())
.build())
.datasetSourceDetails(DatasetDatasetSourceDetailsArgs.builder()
.bucket("string")
.namespace("string")
.sourceType("string")
.prefix("string")
.build())
.labelSet(DatasetLabelSetArgs.builder()
.items(DatasetLabelSetItemArgs.builder()
.name("string")
.build())
.build())
.definedTags(Map.of("string", "string"))
.description("string")
.displayName("string")
.freeformTags(Map.of("string", "string"))
.initialImportDatasetConfiguration(DatasetInitialImportDatasetConfigurationArgs.builder()
.importFormat(DatasetInitialImportDatasetConfigurationImportFormatArgs.builder()
.name("string")
.version("string")
.build())
.importMetadataPath(DatasetInitialImportDatasetConfigurationImportMetadataPathArgs.builder()
.bucket("string")
.namespace("string")
.path("string")
.sourceType("string")
.build())
.build())
.initialRecordGenerationConfiguration()
.labelingInstructions("string")
.build());
dataset_resource = oci.data_labelling_service.Dataset("datasetResource",
annotation_format="string",
compartment_id="string",
dataset_format_details=oci.data_labelling_service.DatasetDatasetFormatDetailsArgs(
format_type="string",
text_file_type_metadata=oci.data_labelling_service.DatasetDatasetFormatDetailsTextFileTypeMetadataArgs(
column_index=0,
format_type="string",
column_delimiter="string",
column_name="string",
escape_character="string",
line_delimiter="string",
),
),
dataset_source_details=oci.data_labelling_service.DatasetDatasetSourceDetailsArgs(
bucket="string",
namespace="string",
source_type="string",
prefix="string",
),
label_set=oci.data_labelling_service.DatasetLabelSetArgs(
items=[oci.data_labelling_service.DatasetLabelSetItemArgs(
name="string",
)],
),
defined_tags={
"string": "string",
},
description="string",
display_name="string",
freeform_tags={
"string": "string",
},
initial_import_dataset_configuration=oci.data_labelling_service.DatasetInitialImportDatasetConfigurationArgs(
import_format=oci.data_labelling_service.DatasetInitialImportDatasetConfigurationImportFormatArgs(
name="string",
version="string",
),
import_metadata_path=oci.data_labelling_service.DatasetInitialImportDatasetConfigurationImportMetadataPathArgs(
bucket="string",
namespace="string",
path="string",
source_type="string",
),
),
initial_record_generation_configuration=oci.data_labelling_service.DatasetInitialRecordGenerationConfigurationArgs(),
labeling_instructions="string")
const datasetResource = new oci.datalabellingservice.Dataset("datasetResource", {
annotationFormat: "string",
compartmentId: "string",
datasetFormatDetails: {
formatType: "string",
textFileTypeMetadata: {
columnIndex: 0,
formatType: "string",
columnDelimiter: "string",
columnName: "string",
escapeCharacter: "string",
lineDelimiter: "string",
},
},
datasetSourceDetails: {
bucket: "string",
namespace: "string",
sourceType: "string",
prefix: "string",
},
labelSet: {
items: [{
name: "string",
}],
},
definedTags: {
string: "string",
},
description: "string",
displayName: "string",
freeformTags: {
string: "string",
},
initialImportDatasetConfiguration: {
importFormat: {
name: "string",
version: "string",
},
importMetadataPath: {
bucket: "string",
namespace: "string",
path: "string",
sourceType: "string",
},
},
initialRecordGenerationConfiguration: {},
labelingInstructions: "string",
});
type: oci:DataLabellingService:Dataset
properties:
annotationFormat: string
compartmentId: string
datasetFormatDetails:
formatType: string
textFileTypeMetadata:
columnDelimiter: string
columnIndex: 0
columnName: string
escapeCharacter: string
formatType: string
lineDelimiter: string
datasetSourceDetails:
bucket: string
namespace: string
prefix: string
sourceType: string
definedTags:
string: string
description: string
displayName: string
freeformTags:
string: string
initialImportDatasetConfiguration:
importFormat:
name: string
version: string
importMetadataPath:
bucket: string
namespace: string
path: string
sourceType: string
initialRecordGenerationConfiguration: {}
labelSet:
items:
- name: string
labelingInstructions: string
Dataset Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Dataset resource accepts the following input properties:
- Annotation
Format string - The annotation format name required for labeling records.
- Compartment
Id string - (Updatable) The OCID of the compartment of the resource.
- Dataset
Format DatasetDetails Dataset Format Details - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- Dataset
Source DatasetDetails Dataset Source Details - This allows the customer to specify the source of the dataset.
- Label
Set DatasetLabel Set - An ordered collection of labels that are unique by name.
- Dictionary<string, string>
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- Description string
- (Updatable) A user provided description of the dataset
- Display
Name string - (Updatable) A user-friendly display name for the resource.
- Dictionary<string, string>
- (Updatable) 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"}
- Initial
Import DatasetDataset Configuration Initial Import Dataset Configuration - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- Initial
Record DatasetGeneration Configuration Initial Record Generation Configuration - The initial generate records configuration. It generates records from the dataset's source.
- Labeling
Instructions string (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Annotation
Format string - The annotation format name required for labeling records.
- Compartment
Id string - (Updatable) The OCID of the compartment of the resource.
- Dataset
Format DatasetDetails Dataset Format Details Args - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- Dataset
Source DatasetDetails Dataset Source Details Args - This allows the customer to specify the source of the dataset.
- Label
Set DatasetLabel Set Args - An ordered collection of labels that are unique by name.
- map[string]string
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- Description string
- (Updatable) A user provided description of the dataset
- Display
Name string - (Updatable) A user-friendly display name for the resource.
- map[string]string
- (Updatable) 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"}
- Initial
Import DatasetDataset Configuration Initial Import Dataset Configuration Args - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- Initial
Record DatasetGeneration Configuration Initial Record Generation Configuration Args - The initial generate records configuration. It generates records from the dataset's source.
- Labeling
Instructions string (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- annotation
Format String - The annotation format name required for labeling records.
- compartment
Id String - (Updatable) The OCID of the compartment of the resource.
- dataset
Format DatasetDetails Dataset Format Details - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- dataset
Source DatasetDetails Dataset Source Details - This allows the customer to specify the source of the dataset.
- label
Set DatasetLabel Set - An ordered collection of labels that are unique by name.
- Map<String,String>
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- description String
- (Updatable) A user provided description of the dataset
- display
Name String - (Updatable) A user-friendly display name for the resource.
- Map<String,String>
- (Updatable) 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"}
- initial
Import DatasetDataset Configuration Initial Import Dataset Configuration - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- initial
Record DatasetGeneration Configuration Initial Record Generation Configuration - The initial generate records configuration. It generates records from the dataset's source.
- labeling
Instructions String (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- annotation
Format string - The annotation format name required for labeling records.
- compartment
Id string - (Updatable) The OCID of the compartment of the resource.
- dataset
Format DatasetDetails Dataset Format Details - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- dataset
Source DatasetDetails Dataset Source Details - This allows the customer to specify the source of the dataset.
- label
Set DatasetLabel Set - An ordered collection of labels that are unique by name.
- {[key: string]: string}
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- description string
- (Updatable) A user provided description of the dataset
- display
Name string - (Updatable) A user-friendly display name for the resource.
- {[key: string]: string}
- (Updatable) 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"}
- initial
Import DatasetDataset Configuration Initial Import Dataset Configuration - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- initial
Record DatasetGeneration Configuration Initial Record Generation Configuration - The initial generate records configuration. It generates records from the dataset's source.
- labeling
Instructions string (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- annotation_
format str - The annotation format name required for labeling records.
- compartment_
id str - (Updatable) The OCID of the compartment of the resource.
- dataset_
format_ datalabellingservice.details Dataset Dataset Format Details Args - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- dataset_
source_ datalabellingservice.details Dataset Dataset Source Details Args - This allows the customer to specify the source of the dataset.
- label_
set datalabellingservice.Dataset Label Set Args - An ordered collection of labels that are unique by name.
- Mapping[str, str]
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- description str
- (Updatable) A user provided description of the dataset
- display_
name str - (Updatable) A user-friendly display name for the resource.
- Mapping[str, str]
- (Updatable) 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"}
- initial_
import_ datalabellingservice.dataset_ configuration Dataset Initial Import Dataset Configuration Args - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- initial_
record_ datalabellingservice.generation_ configuration Dataset Initial Record Generation Configuration Args - The initial generate records configuration. It generates records from the dataset's source.
- labeling_
instructions str (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- annotation
Format String - The annotation format name required for labeling records.
- compartment
Id String - (Updatable) The OCID of the compartment of the resource.
- dataset
Format Property MapDetails - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- dataset
Source Property MapDetails - This allows the customer to specify the source of the dataset.
- label
Set Property Map - An ordered collection of labels that are unique by name.
- Map<String>
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- description String
- (Updatable) A user provided description of the dataset
- display
Name String - (Updatable) A user-friendly display name for the resource.
- Map<String>
- (Updatable) 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"}
- initial
Import Property MapDataset Configuration - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- initial
Record Property MapGeneration Configuration - The initial generate records configuration. It generates records from the dataset's source.
- labeling
Instructions String (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Outputs
All input properties are implicitly available as output properties. Additionally, the Dataset resource produces the following output properties:
- Additional
Properties 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 string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details 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.
- Lifecycle
Substate string - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- State string
- 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.
- Time
Created string - The date and time the resource was created, in the timestamp format defined by RFC3339.
- Time
Updated string - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- Additional
Properties map[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 string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details 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.
- Lifecycle
Substate string - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- State string
- 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.
- Time
Created string - The date and time the resource was created, in the timestamp format defined by RFC3339.
- Time
Updated string - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- additional
Properties Map<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 String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- lifecycle
Substate String - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- state String
- 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.
- time
Created String - The date and time the resource was created, in the timestamp format defined by RFC3339.
- time
Updated String - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- additional
Properties {[key: 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 string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- lifecycle
Substate string - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- state string
- 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.
- time
Created string - The date and time the resource was created, in the timestamp format defined by RFC3339.
- time
Updated string - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- additional_
properties Mapping[str, str] - 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 str
- The provider-assigned unique ID for this managed resource.
- lifecycle_
details str - 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.
- lifecycle_
substate str - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- state str
- 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.
- time_
created str - The date and time the resource was created, in the timestamp format defined by RFC3339.
- time_
updated str - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- additional
Properties Map<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 String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details 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.
- lifecycle
Substate String - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- state String
- 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.
- time
Created String - The date and time the resource was created, in the timestamp format defined by RFC3339.
- time
Updated String - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
Look up Existing Dataset Resource
Get an existing Dataset resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DatasetState, opts?: CustomResourceOptions): Dataset
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_properties: Optional[Mapping[str, str]] = None,
annotation_format: Optional[str] = None,
compartment_id: Optional[str] = None,
dataset_format_details: Optional[_datalabellingservice.DatasetDatasetFormatDetailsArgs] = None,
dataset_source_details: Optional[_datalabellingservice.DatasetDatasetSourceDetailsArgs] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
initial_import_dataset_configuration: Optional[_datalabellingservice.DatasetInitialImportDatasetConfigurationArgs] = None,
initial_record_generation_configuration: Optional[_datalabellingservice.DatasetInitialRecordGenerationConfigurationArgs] = None,
label_set: Optional[_datalabellingservice.DatasetLabelSetArgs] = None,
labeling_instructions: Optional[str] = None,
lifecycle_details: Optional[str] = None,
lifecycle_substate: Optional[str] = None,
state: Optional[str] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> Dataset
func GetDataset(ctx *Context, name string, id IDInput, state *DatasetState, opts ...ResourceOption) (*Dataset, error)
public static Dataset Get(string name, Input<string> id, DatasetState? state, CustomResourceOptions? opts = null)
public static Dataset get(String name, Output<String> id, DatasetState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Additional
Properties 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"}
- Annotation
Format string - The annotation format name required for labeling records.
- Compartment
Id string - (Updatable) The OCID of the compartment of the resource.
- Dataset
Format DatasetDetails Dataset Format Details - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- Dataset
Source DatasetDetails Dataset Source Details - This allows the customer to specify the source of the dataset.
- Dictionary<string, string>
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- Description string
- (Updatable) A user provided description of the dataset
- Display
Name string - (Updatable) A user-friendly display name for the resource.
- Dictionary<string, string>
- (Updatable) 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"}
- Initial
Import DatasetDataset Configuration Initial Import Dataset Configuration - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- Initial
Record DatasetGeneration Configuration Initial Record Generation Configuration - The initial generate records configuration. It generates records from the dataset's source.
- Label
Set DatasetLabel Set - An ordered collection of labels that are unique by name.
- Labeling
Instructions string (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Lifecycle
Details 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.
- Lifecycle
Substate string - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- State string
- 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.
- Time
Created string - The date and time the resource was created, in the timestamp format defined by RFC3339.
- Time
Updated string - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- Additional
Properties map[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"}
- Annotation
Format string - The annotation format name required for labeling records.
- Compartment
Id string - (Updatable) The OCID of the compartment of the resource.
- Dataset
Format DatasetDetails Dataset Format Details Args - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- Dataset
Source DatasetDetails Dataset Source Details Args - This allows the customer to specify the source of the dataset.
- map[string]string
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- Description string
- (Updatable) A user provided description of the dataset
- Display
Name string - (Updatable) A user-friendly display name for the resource.
- map[string]string
- (Updatable) 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"}
- Initial
Import DatasetDataset Configuration Initial Import Dataset Configuration Args - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- Initial
Record DatasetGeneration Configuration Initial Record Generation Configuration Args - The initial generate records configuration. It generates records from the dataset's source.
- Label
Set DatasetLabel Set Args - An ordered collection of labels that are unique by name.
- Labeling
Instructions string (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Lifecycle
Details 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.
- Lifecycle
Substate string - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- State string
- 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.
- Time
Created string - The date and time the resource was created, in the timestamp format defined by RFC3339.
- Time
Updated string - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- additional
Properties Map<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"}
- annotation
Format String - The annotation format name required for labeling records.
- compartment
Id String - (Updatable) The OCID of the compartment of the resource.
- dataset
Format DatasetDetails Dataset Format Details - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- dataset
Source DatasetDetails Dataset Source Details - This allows the customer to specify the source of the dataset.
- Map<String,String>
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- description String
- (Updatable) A user provided description of the dataset
- display
Name String - (Updatable) A user-friendly display name for the resource.
- Map<String,String>
- (Updatable) 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"}
- initial
Import DatasetDataset Configuration Initial Import Dataset Configuration - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- initial
Record DatasetGeneration Configuration Initial Record Generation Configuration - The initial generate records configuration. It generates records from the dataset's source.
- label
Set DatasetLabel Set - An ordered collection of labels that are unique by name.
- labeling
Instructions String (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- lifecycle
Details 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.
- lifecycle
Substate String - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- state String
- 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.
- time
Created String - The date and time the resource was created, in the timestamp format defined by RFC3339.
- time
Updated String - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- additional
Properties {[key: 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"}
- annotation
Format string - The annotation format name required for labeling records.
- compartment
Id string - (Updatable) The OCID of the compartment of the resource.
- dataset
Format DatasetDetails Dataset Format Details - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- dataset
Source DatasetDetails Dataset Source Details - This allows the customer to specify the source of the dataset.
- {[key: string]: string}
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- description string
- (Updatable) A user provided description of the dataset
- display
Name string - (Updatable) A user-friendly display name for the resource.
- {[key: string]: string}
- (Updatable) 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"}
- initial
Import DatasetDataset Configuration Initial Import Dataset Configuration - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- initial
Record DatasetGeneration Configuration Initial Record Generation Configuration - The initial generate records configuration. It generates records from the dataset's source.
- label
Set DatasetLabel Set - An ordered collection of labels that are unique by name.
- labeling
Instructions string (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- lifecycle
Details 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.
- lifecycle
Substate string - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- state string
- 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.
- time
Created string - The date and time the resource was created, in the timestamp format defined by RFC3339.
- time
Updated string - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- additional_
properties Mapping[str, str] - 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"}
- annotation_
format str - The annotation format name required for labeling records.
- compartment_
id str - (Updatable) The OCID of the compartment of the resource.
- dataset_
format_ datalabellingservice.details Dataset Dataset Format Details Args - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- dataset_
source_ datalabellingservice.details Dataset Dataset Source Details Args - This allows the customer to specify the source of the dataset.
- Mapping[str, str]
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- description str
- (Updatable) A user provided description of the dataset
- display_
name str - (Updatable) A user-friendly display name for the resource.
- Mapping[str, str]
- (Updatable) 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"}
- initial_
import_ datalabellingservice.dataset_ configuration Dataset Initial Import Dataset Configuration Args - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- initial_
record_ datalabellingservice.generation_ configuration Dataset Initial Record Generation Configuration Args - The initial generate records configuration. It generates records from the dataset's source.
- label_
set datalabellingservice.Dataset Label Set Args - An ordered collection of labels that are unique by name.
- labeling_
instructions str (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- lifecycle_
details str - 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.
- lifecycle_
substate str - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- state str
- 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.
- time_
created str - The date and time the resource was created, in the timestamp format defined by RFC3339.
- time_
updated str - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- additional
Properties Map<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"}
- annotation
Format String - The annotation format name required for labeling records.
- compartment
Id String - (Updatable) The OCID of the compartment of the resource.
- dataset
Format Property MapDetails - It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
- dataset
Source Property MapDetails - This allows the customer to specify the source of the dataset.
- Map<String>
- (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example:
{"foo-namespace": {"bar-key": "value"}}
- description String
- (Updatable) A user provided description of the dataset
- display
Name String - (Updatable) A user-friendly display name for the resource.
- Map<String>
- (Updatable) 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"}
- initial
Import Property MapDataset Configuration - Initial import dataset configuration. Allows user to create dataset from existing dataset files.
- initial
Record Property MapGeneration Configuration - The initial generate records configuration. It generates records from the dataset's source.
- label
Set Property Map - An ordered collection of labels that are unique by name.
- labeling
Instructions String (Updatable) The labeling instructions for human labelers in rich text format
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- lifecycle
Details 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.
- lifecycle
Substate String - The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
- state String
- 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.
- time
Created String - The date and time the resource was created, in the timestamp format defined by RFC3339.
- time
Updated String - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
Supporting Types
DatasetDatasetFormatDetails, DatasetDatasetFormatDetailsArgs
- Format
Type string - The format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are TXT files.
- Text
File DatasetType Metadata Dataset Format Details Text File Type Metadata - Metadata for files with text content.
- Format
Type string - The format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are TXT files.
- Text
File DatasetType Metadata Dataset Format Details Text File Type Metadata - Metadata for files with text content.
- format
Type String - The format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are TXT files.
- text
File DatasetType Metadata Dataset Format Details Text File Type Metadata - Metadata for files with text content.
- format
Type string - The format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are TXT files.
- text
File DatasetType Metadata Dataset Format Details Text File Type Metadata - Metadata for files with text content.
- format_
type str - The format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are TXT files.
- text_
file_ datalabellingservice.type_ metadata Dataset Dataset Format Details Text File Type Metadata - Metadata for files with text content.
- format
Type String - The format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are TXT files.
- text
File Property MapType Metadata - Metadata for files with text content.
DatasetDatasetFormatDetailsTextFileTypeMetadata, DatasetDatasetFormatDetailsTextFileTypeMetadataArgs
- Column
Index int - The index of a selected column. This is a zero-based index.
- Format
Type string - It defines the format type of text files.
- Column
Delimiter string - A column delimiter
- Column
Name string - The name of a selected column.
- Escape
Character string - An escape character.
- Line
Delimiter string - A line delimiter.
- Column
Index int - The index of a selected column. This is a zero-based index.
- Format
Type string - It defines the format type of text files.
- Column
Delimiter string - A column delimiter
- Column
Name string - The name of a selected column.
- Escape
Character string - An escape character.
- Line
Delimiter string - A line delimiter.
- column
Index Integer - The index of a selected column. This is a zero-based index.
- format
Type String - It defines the format type of text files.
- column
Delimiter String - A column delimiter
- column
Name String - The name of a selected column.
- escape
Character String - An escape character.
- line
Delimiter String - A line delimiter.
- column
Index number - The index of a selected column. This is a zero-based index.
- format
Type string - It defines the format type of text files.
- column
Delimiter string - A column delimiter
- column
Name string - The name of a selected column.
- escape
Character string - An escape character.
- line
Delimiter string - A line delimiter.
- column_
index int - The index of a selected column. This is a zero-based index.
- format_
type str - It defines the format type of text files.
- column_
delimiter str - A column delimiter
- column_
name str - The name of a selected column.
- escape_
character str - An escape character.
- line_
delimiter str - A line delimiter.
- column
Index Number - The index of a selected column. This is a zero-based index.
- format
Type String - It defines the format type of text files.
- column
Delimiter String - A column delimiter
- column
Name String - The name of a selected column.
- escape
Character String - An escape character.
- line
Delimiter String - A line delimiter.
DatasetDatasetSourceDetails, DatasetDatasetSourceDetailsArgs
- Bucket string
- The object storage bucket that contains the dataset data source.
- Namespace string
- The namespace of the bucket that contains the dataset data source.
- Source
Type string - The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.
- Prefix string
- A common path prefix shared by the objects that make up the dataset. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix.
- Bucket string
- The object storage bucket that contains the dataset data source.
- Namespace string
- The namespace of the bucket that contains the dataset data source.
- Source
Type string - The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.
- Prefix string
- A common path prefix shared by the objects that make up the dataset. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix.
- bucket String
- The object storage bucket that contains the dataset data source.
- namespace String
- The namespace of the bucket that contains the dataset data source.
- source
Type String - The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.
- prefix String
- A common path prefix shared by the objects that make up the dataset. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix.
- bucket string
- The object storage bucket that contains the dataset data source.
- namespace string
- The namespace of the bucket that contains the dataset data source.
- source
Type string - The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.
- prefix string
- A common path prefix shared by the objects that make up the dataset. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix.
- bucket str
- The object storage bucket that contains the dataset data source.
- namespace str
- The namespace of the bucket that contains the dataset data source.
- source_
type str - The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.
- prefix str
- A common path prefix shared by the objects that make up the dataset. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix.
- bucket String
- The object storage bucket that contains the dataset data source.
- namespace String
- The namespace of the bucket that contains the dataset data source.
- source
Type String - The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.
- prefix String
- A common path prefix shared by the objects that make up the dataset. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix.
DatasetInitialImportDatasetConfiguration, DatasetInitialImportDatasetConfigurationArgs
- Import
Format DatasetInitial Import Dataset Configuration Import Format - File format details used for importing dataset
- Import
Metadata DatasetPath Initial Import Dataset Configuration Import Metadata Path - Object storage path for the metadata file
- Import
Format DatasetInitial Import Dataset Configuration Import Format - File format details used for importing dataset
- Import
Metadata DatasetPath Initial Import Dataset Configuration Import Metadata Path - Object storage path for the metadata file
- import
Format DatasetInitial Import Dataset Configuration Import Format - File format details used for importing dataset
- import
Metadata DatasetPath Initial Import Dataset Configuration Import Metadata Path - Object storage path for the metadata file
- import
Format DatasetInitial Import Dataset Configuration Import Format - File format details used for importing dataset
- import
Metadata DatasetPath Initial Import Dataset Configuration Import Metadata Path - Object storage path for the metadata file
- import_
format datalabellingservice.Dataset Initial Import Dataset Configuration Import Format - File format details used for importing dataset
- import_
metadata_ datalabellingservice.path Dataset Initial Import Dataset Configuration Import Metadata Path - Object storage path for the metadata file
- import
Format Property Map - File format details used for importing dataset
- import
Metadata Property MapPath - Object storage path for the metadata file
DatasetInitialImportDatasetConfigurationImportFormat, DatasetInitialImportDatasetConfigurationImportFormatArgs
DatasetInitialImportDatasetConfigurationImportMetadataPath, DatasetInitialImportDatasetConfigurationImportMetadataPathArgs
- Bucket string
- Bucket name
- Namespace string
- Bucket namespace name
- Path string
- Path for the metadata file.
- Source
Type string - The type of data source. OBJECT_STORAGE - The source details for an object storage bucket.
- Bucket string
- Bucket name
- Namespace string
- Bucket namespace name
- Path string
- Path for the metadata file.
- Source
Type string - The type of data source. OBJECT_STORAGE - The source details for an object storage bucket.
- bucket String
- Bucket name
- namespace String
- Bucket namespace name
- path String
- Path for the metadata file.
- source
Type String - The type of data source. OBJECT_STORAGE - The source details for an object storage bucket.
- bucket string
- Bucket name
- namespace string
- Bucket namespace name
- path string
- Path for the metadata file.
- source
Type string - The type of data source. OBJECT_STORAGE - The source details for an object storage bucket.
- bucket str
- Bucket name
- namespace str
- Bucket namespace name
- path str
- Path for the metadata file.
- source_
type str - The type of data source. OBJECT_STORAGE - The source details for an object storage bucket.
- bucket String
- Bucket name
- namespace String
- Bucket namespace name
- path String
- Path for the metadata file.
- source
Type String - The type of data source. OBJECT_STORAGE - The source details for an object storage bucket.
DatasetLabelSet, DatasetLabelSetArgs
- Items
List<Dataset
Label Set Item> - An ordered collection of labels that are unique by name.
- Items
[]Dataset
Label Set Item - An ordered collection of labels that are unique by name.
- items
List<Dataset
Label Set Item> - An ordered collection of labels that are unique by name.
- items
Dataset
Label Set Item[] - An ordered collection of labels that are unique by name.
- items
Sequence[datalabellingservice.
Dataset Label Set Item] - An ordered collection of labels that are unique by name.
- items List<Property Map>
- An ordered collection of labels that are unique by name.
DatasetLabelSetItem, DatasetLabelSetItemArgs
- Name string
- An unique name for a label within its dataset.
- Name string
- An unique name for a label within its dataset.
- name String
- An unique name for a label within its dataset.
- name string
- An unique name for a label within its dataset.
- name str
- An unique name for a label within its dataset.
- name String
- An unique name for a label within its dataset.
Import
Datasets can be imported using the id
, e.g.
$ pulumi import oci:DataLabellingService/dataset:Dataset test_dataset "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.