Updated on 2024-08-14 GMT+08:00

Parameter Overview

You can use LabelingStep to create a labeling phase. The following is an example of defining a LabelingStep.

Table 1 LabelingStep

Parameter

Description

Mandatory

Data Type

name

Name of a labeling phase. The name contains a maximum of 64 characters, including only letters, digits, underscores (_), and hyphens (-). It must start with a letter and must be unique in a workflow.

Yes

str

inputs

Inputs of the labeling phase

Yes

LabelingInput or LabelingInput list

outputs

Outputs of the labeling phase

Yes

LabelingOutput or LabelingOutput list

properties

Configurations for dataset labeling

Yes

LabelTaskProperties

title

Title for frontend display

No

str

description

Description of the labeling phase

No

str

policy

Phase execution policy

No

StepPolicy

depend_steps

Dependency phases

No

Step or step list

Table 2 LabelingInput

Parameter

Description

Mandatory

Data Type

name

Input name of the labeling phase. The name can contain a maximum of 64 characters, including only letters, digits, underscores (_), and hyphens (-), and must start with a letter. The input name of a step must be unique.

Yes

str

data

Input data object of the labeling phase

Yes

Dataset or labeling job object. Currently, only Dataset, DatasetConsumption, DatasetPlaceholder, LabelTask, LabelTaskPlaceholder, LabelTaskConsumption, and DataConsumptionSelector are supported.

Table 3 LabelingOutput

Parameter

Description

Mandatory

Data Type

name

Output name of the labeling phase. The name can contain a maximum of 64 characters, including only letters, digits, underscores (_), and hyphens (-), and must start with a letter. The output name of a step must be unique.

Yes

str

Table 4 LabelTaskProperties

Parameter

Description

Mandatory

Data Type

task_type

Type of a labeling job. Jobs of the specified type are returned.

Yes

LabelTaskTypeEnum

task_name

Labeling job name. The value contains 1 to 100 characters, including only letters, digits, hyphens (-), and underscores (_).

This parameter is mandatory when the input is a dataset object.

No

str, Placeholder

labels

Labels to be created

No

Label

properties

Attributes of a labeling job. You can update this field to record custom information.

No

dict

auto_sync_dataset

Whether to automatically synchronize the result of a labeling job to the dataset. Options:

  • true: The labeling result of the labeling job is automatically synchronized to the dataset. (Default)
  • false: The labeling result of the labeling job is not automatically synchronized to the dataset.

No

bool

content_labeling

Whether to enable content labeling for speech paragraph labeling. This function is enabled by default.

No

bool

description

Labeling job description. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"'

No

str

Table 5 Label

Parameter

Description

Mandatory

Data Type

name

Tag name

No

str

property

Basic attribute key-value pair of a label, such as color and shortcut keys

No

str, dic, Placeholder

type

Tag type

No

LabelTypeEnum

Enumerated Type

Enumerated Value

LabelTaskTypeEnum

IMAGE_CLASSIFICATION

OBJECT_DETECTION

IMAGE_SEGMENTATION

TEXT_CLASSIFICATION

NAMED_ENTITY_RECOGNITION

TEXT_TRIPLE

AUDIO_CLASSIFICATION

SPEECH_CONTENT

SPEECH_SEGMENTATION

DATASET_TABULAR

VIDEO_ANNOTATION

FREE_FORMAT