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 or use the SDK sample code generated by API Explorer.
URI
POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks
| 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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| auto_sync_dataset | No | Boolean | Whether to automatically synchronize the result of a team labeling task to the dataset. Options:
|
| data_sync_type | No | Integer | Synchronization type. Options:
|
| 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:
|
| 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. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| agency | No | String | Administrator |
| workforces | No | Array of WorkforceConfig objects | List of teams that execute labeling tasks. |
| 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: !<>=&"' |
| 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: ^!<>=&"' |
| | No | String | Email address of a labeling team member. |
| role | No | Integer | Role. Options:
|
| status | No | Integer | Current login status of a labeling team member. Options:
|
| 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
| 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.