This API is used to update the sample status by confirming the acceptance scope and whether the labeled data is overwritten before the acceptance of the team labeling task is completed.
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 about how to obtain the project ID, see Obtaining a Project ID. |
workforce_task_id |
Yes |
String |
ID of a team labeling task. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
locale |
Yes |
String |
Language. The options are as follows: en-us: English (default value) |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action |
No |
Integer |
Acceptance action. The options are as follows:
|
locale |
No |
String |
Language. The options are as follows: en-us: English (default value) |
overwrite_last_result |
No |
Boolean |
Whether to overwrite labeled data. The options are as follows:
|
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. The options are as follows:
|
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> |
Details about difficulties, including description, causes, and suggestions of difficult problems. |
labelers |
Array of Worker objects |
Labeling personnel list of sample assignment. The labelers record the team members to which the sample is allocated for team labeling. |
labels |
Array of SampleLabel objects |
Sample label list. |
metadata |
SampleMetadata object |
Key-value pair of the sample metadata attribute. |
review_accept |
Boolean |
Whether to accept the review, which is used for team labeling. The options are as follows:
|
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 |
Sample data list. |
sample_dir |
String |
Sample path. |
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. The options are as follows:
|
sample_time |
Long |
Sample time, when OBS is last modified. |
sample_type |
Integer |
Sample type. The options are as follows:
|
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 |
Creation time. |
description |
String |
Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' |
String |
Email address of a labeling team member. |
|
role |
Integer |
Role. The options are as follows:
|
status |
Integer |
Current login status of a labeling team member. The options are as follows:
|
update_time |
Long |
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 distinguish whether a video is labeled manually or automatically. The options are as follows:
|
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. |
type |
Integer |
Label type. The options are as follows:
|
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 are as follows.- If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the start_index and end_index values of "Barack Hussein Obama II" are 0 and 23, respectively.- If the text content is "By the end of 2018, the company has more than 100 employees.", the start_index and end_index values of "By the end of 2018" are 0 and 18, respectively. |
@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:- bndbox: consists of two points, for example, [[0,10],[50,95]]. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point.- polygon: consists of multiple points that are connected in sequence to form a polygon, for example, [[0,100],[50,95],[10,60],[500,400]].- circle: consists of the center point and radius, for example, [[100,100],[50]].- line: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.- dashed: consists of two points, for example, [[0,100],[50,95]]. The first point is the start point, and the second point is the end point.- point: consists of one point, for example, [[0,100]].- polyline: consists of multiple points, for example, [[0,100],[50,95],[10,60],[500,400]]. |
@modelarts:from |
String |
ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. |
@modelarts:hard |
String |
Sample labeled as a hard sample or not, which is a default attribute. Options:
|
@modelarts:hard_coefficient |
String |
Coefficient of difficulty of each label level, which is a default attribute. The value range is [0,1]. |
@modelarts:hard_reasons |
String |
Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, 3-20-21-19. The options are as follows:
|
@modelarts:shape |
String |
Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows:
|
@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 |
ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. |
Parameter |
Type |
Description |
---|---|---|
@modelarts:hard |
Double |
Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows:
|
@modelarts:hard_coefficient |
Double |
Coefficient of difficulty of each sample level, which is a default attribute. The value range is [0,1]. |
@modelarts:hard_reasons |
Array of integers |
ID of a hard sample reason, which is a default attribute. The options are as follows:
|
@modelarts:size |
Array of objects |
Image size (width, height, and depth of the image), which is a default attribute, with type of List. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is 3). For example, [100,200,3] and [100,200] are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. |
All Tasks Are Accepted.
{ "action" : 0 }
Status code: 200
OK
{ }
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
See Error Codes.