Querying the Sample List of a Team Labeling Task by Page¶
Function¶
This API is used to query the sample list of a team labeling task by page.
Debugging¶
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI¶
GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples
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. |
workforce_task_id | Yes | String | ID of a team labeling task. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
label_name | No | String | Label name. |
label_type | No | Integer | Labeling type. Options:
|
limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is 10. |
locale | No | String | Language. |
offset | No | Integer | Start page of the paging list. The default value is 0. |
process_parameter | No | String | Image resizing setting, which is the same as the OBS resizing setting. For details, see . For example, image/resize,m_lfit,h_200 indicates that the target image is resized proportionally and the height is set to 200 pixels. |
sample_state | No | String | Sample status. Options:
|
search_conditions | No | String | Multi-dimensional search condition after URL encoding. The relationship between multiple search conditions is AND. |
Request Parameters¶
None
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
sample_count | Integer | Number of samples. |
samples | Array of DescribeSampleResp objects | Sample list. |
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> | 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. 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 | 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. 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 | 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. Options:
|
status | Integer | Current login status of a labeling team member. Options:
|
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. 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. |
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. Example:
|
@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 the image is used as the coordinate origin [0, 0]. Each coordinate point is represented by [x, y], where x indicates the horizontal coordinate and y indicates the vertical coordinate (both x and y are >=0). The format of each shape is as follows:
|
@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. 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 | 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:import_origin | Integer | Sample source, which is a built-in attribute. |
@modelarts:hard | Double | Whether the sample is labeled as a hard sample, which is a default attribute. Options:
|
@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. Options:
|
@modelarts:size | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of List<Integer>. 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. |
Example Requests¶
Querying the Sample List of a Team Labeling Task by Page
GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples
Example Responses¶
Status code: 200
OK
{
"sample_count" : 2,
"samples" : [ {
"sample_id" : "26c6dd793d80d3274eb89349ec76d678",
"sample_type" : 0,
"labels" : [ ],
"source" : "https://test-obs.obs.xxx.com:443/detect/data/dataset-car-and-person/IMG_kitti_0000_000016.png?AccessKeyId=P19W9X830R1Z39P5X5M5&Expires=1606300137&x-obs-security-token=gQpjbi1ub3J0aC03jKj8N6gtS4VsdTTW3QFoHMtpMoFLtCa6W_J4DxT0nYIfx...",
"metadata" : {
"@modelarts:import_origin" : 0,
"@modelarts:size" : [ 1242, 375, 3 ]
},
"sample_time" : 1598263639997,
"sample_status" : "UN_ANNOTATION",
"worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f",
"labelers" : [ {
"email" : "xxx@xxx.com",
"worker_id" : "afdda13895bc66322ffbf36ae833bcf0",
"role" : 0
} ]
}, {
"sample_id" : "2971815bbb11a462161b48dddf19344f",
"sample_type" : 0,
"labels" : [ ],
"source" : "https://test-obs.obs.xxx.com:443/detect/data/dataset-car-and-person/IMG_kitti_0000_000011.png?AccessKeyId=P19W9X830R1Z39P5X5M5&Expires=1606300137&x-obs-security-token=gQpjbi1ub3J0aC03jKj8N6gtS4VsdTTW3QFoHMtpMoFLtC...",
"metadata" : {
"@modelarts:import_origin" : 0,
"@modelarts:size" : [ 1242, 375, 3 ]
},
"sample_time" : 1598263639997,
"sample_status" : "UN_ANNOTATION",
"worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f",
"labelers" : [ {
"email" : "xxx@xxx.com",
"worker_id" : "305595e1901a526017d2e11f3ab0ffe1",
"role" : 0
} ]
} ]
}
Status Codes¶
Status Code | Description |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Error Codes¶
See Error Codes.