Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com> Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
104 KiB
Updating Status of a Team Labeling Acceptance Task
Function
Determine the acceptance scope for a team labeling task, including all labeled data, and update the sample data accordingly.
Debugging
You can debug this API in which supports automatic authentication. API Explorer can automatically generate SDK code examples and provide the SDK code example debugging.
URI
PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/status
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dataset_id |
Yes |
String |
Dataset ID |
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID and Name. |
workforce_task_id |
Yes |
String |
ID of a team labeling task. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
locale |
Yes |
String |
Language |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action |
Yes |
Integer |
Acceptance action. Options: |
overwrite_last_result |
No |
Boolean |
Whether to overwrite labeled data. Options: |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
sample_count |
Integer |
Total number of accepted samples |
samples |
Array of DescribeSampleResp objects |
List of accepted samples |
Parameter |
Type |
Description |
---|---|---|
check_accept |
Boolean |
Whether the acceptance is passed, which is used for team labeling. Options: |
check_comment |
String |
Acceptance comment, which is used for team labeling. |
check_score |
String |
Acceptance score, which is used for team labeling. |
deletion_reasons |
Array of strings |
Reason for deleting a sample, which is used for healthcare. |
hard_details |
Map<String,HardDetail> |
Difficult problem details, including description, causes, and suggestions of difficult problems. |
labelers |
Array of Worker objects |
Labeling personnel list of sample allocation. The list records the team members receiving the samples, which is used for team labeling. |
labels |
Array of SampleLabel objects |
List of sample labels |
metadata |
SampleMetadata object |
Attribute key-value pair of the sample metadata |
review_accept |
Boolean |
Whether to accept the review, which is used for team labeling. Options: |
review_comment |
String |
Review comment, which is used for team labeling. |
review_score |
String |
Review score, which is used for team labeling. |
sample_data |
Array of strings |
List of sample data |
sample_dir |
String |
Path for storing a sample |
sample_id |
String |
Sample ID |
sample_name |
String |
Sample name |
sample_size |
Long |
Sample size or text length, in bytes |
sample_status |
String |
Sample status. Options: |
sample_time |
Long |
Sample time, when OBS is last modified. |
sample_type |
Integer |
Sample type. Options: |
score |
String |
Comprehensive score, which is used for team labeling. |
source |
String |
Source address of sample data |
sub_sample_url |
String |
Subsample URL, which is used for healthcare. |
worker_id |
String |
ID of a labeling team member, which is used for team labeling. |
Parameter |
Type |
Description |
---|---|---|
alo_name |
String |
Alias |
id |
Integer |
Reason ID |
reason |
String |
Reason description |
suggestion |
String |
Handling suggestion |
Parameter |
Type |
Description |
---|---|---|
create_time |
Long |
Worker creation time |
description |
String |
Labeling team member description. The value contains 0 to 256 characters. Special characters (^!<>=&"') are not allowed. |
String |
Email address of a labeling team member |
|
role |
Integer |
Role. Options: |
status |
Integer |
Current login status of a labeled member. Options: |
update_time |
Long |
Worker update time |
worker_id |
String |
ID of a labeling team member |
workforce_id |
String |
ID of a labeling team |
Parameter |
Type |
Description |
---|---|---|
annotated_by |
String |
Video labeling method, which is used to determine whether a video is labeled manually or automatically. Options: |
id |
String |
Label ID |
name |
String |
Label name |
property |
SampleLabelProperty object |
Attribute key-value pair of the sample label, such as the object shape and shape feature |
score |
Float |
Confidence. The value ranges from 0 to 1. |
type |
Integer |
Label type. Options: |
Parameter |
Type |
Description |
---|---|---|
@modelarts:content |
String |
Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points) |
@modelarts:end_index |
Integer |
End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of end_index. Examples: |
@modelarts:end_time |
String |
Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.) |
@modelarts:feature |
Object |
Shape feature, which is a default attribute dedicated to the object detection label, with type of List The upper left corner of an image is used as the coordinate origin [0, 0]. Each coordinate point is represented by [x, y]. x indicates the horizontal coordinate, and y indicates the vertical coordinate (both x and y are greater than or equal to 0). The format of each shape is as follows:
|
@modelarts:from |
String |
Start entity ID of the triplet relationship label, which is a default attribute dedicated to the triplet relationship label |
@modelarts:hard |
String |
Whether the sample is labeled as a hard example, which is a default attribute. Options: |
@modelarts:hard_coefficient |
String |
Coefficient of difficulty of each label level, which is a default attribute. The value ranges from 0 to 1. |
@modelarts:hard_reasons |
String |
Reasons why the sample is a hard example, which is a default attribute. Use a hyphen (-) to separate every two hard example reason IDs, for example, 3-20-21-19. Options:
|
@modelarts:shape |
String |
Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. Options: |
@modelarts:source |
String |
Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator |
@modelarts:start_index |
Integer |
Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of start_index. |
@modelarts:start_time |
String |
Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of hh:mm:ss.SSS. (hh indicates hour; mm indicates minute; ss indicates second; and SSS indicates millisecond.) |
@modelarts:to |
String |
Direction entity ID of the triplet relationship label, which is a default attribute dedicated to the triplet relationship label |
Request Example
The following shows an example indicating that all tasks are accepted.
{ "action" : 0 }
Response Example
Status code: 200
OK
{ }
Status Code
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Code
For details, see Error Codes.