Updated on 2024-05-30 GMT+08:00

Creating a Team Labeling Task

Function

This API is used to create a team labeling task.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

dataset_id

Yes

String

Dataset ID.

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

auto_sync_dataset

No

Boolean

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

  • true: Automatically synchronize the result of a team labeling task to the dataset. (Default value)

  • false: Do not automatically synchronize the result of a team labeling task to the dataset.

data_sync_type

No

Integer

Synchronization type. Options:

  • 0: unsynchronization

  • 1: data synchronization

  • 2: label synchronization

  • 3: data and label synchronization

repetition

No

Integer

Number of persons who label each sample in a team labeling task. The minimum value is 1.

sample_conditions

No

String

Search conditions of dataset samples. Samples that meet the conditions are filtered for team labeling.

synchronize_auto_labeling_data

No

Boolean

Whether to synchronize the auto labeling result of a team labeling task. Options:

  • true: Synchronize the results to be confirmed to team members after auto labeling is complete.

  • false: Do not synchronize the auto labeling results. (Default value)

workforces_config

No

WorkforcesConfig object

Team labeling task information: Tasks can be assigned by the team administrator or a specified team.

task_name

No

String

Name of a team labeling task.

synchronize_data

No

Boolean

Whether to synchronously update new data.

Table 3 WorkforcesConfig

Parameter

Mandatory

Type

Description

agency

No

String

Administrator

workforces

No

Array of WorkforceConfig objects

List of teams that execute labeling tasks.

Table 4 WorkforceConfig

Parameter

Mandatory

Type

Description

workers

No

Array of Worker objects

List of labeling team members.

workforce_id

No

String

ID of a labeling team.

workforce_name

No

String

Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"'

Table 5 Worker

Parameter

Mandatory

Type

Description

create_time

No

Long

Creation time.

description

No

String

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

email

No

String

Email address of a labeling team member.

role

No

Integer

Role. Options:

  • 0: labeling personnel

  • 1: reviewer

  • 2: team administrator

  • 3: dataset owner

status

No

Integer

Current login status of a labeling team member. Options:

  • 0: The invitation email has not been sent.

  • 1: The invitation email has been sent but the user has not logged in.

  • 2: The user has logged in.

  • 3: The labeling team member has been deleted.

update_time

No

Long

Update time.

worker_id

No

String

ID of a labeling team member.

workforce_id

No

String

ID of a labeling team.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

task_id

String

ID of a team labeling task.

Example Requests

The following is an example of how to create a team labeling task. The task name has been set to task-eb17, synchronize_data has been set to false, and synchronize_auto_labeling_data has been set to false.

{
  "task_name" : "task-eb17",
  "synchronize_data" : false,
  "synchronize_auto_labeling_data" : false,
  "workforces_config" : {
    "workforces" : [ {
      "workforce_id" : "feSUo5NUIUnQAQNNTiS",
      "workers" : [ {
        "email" : "xxx@xxx.com"
      }, {
        "email" : "xxx@xxx.com"
      }, {
        "email" : "xxx@xxx.com"
      } ]
    } ]
  },
  "auto_sync_dataset" : false
}

Example Responses

Status code: 200

OK

{
  "task_id" : "6phXEto29utpaMwbQkg"
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.