Querying Details About Team Labeling Task Statistics¶
Function¶
This API is used to query details about team labeling task statistics.
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/stats
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 |
|---|---|---|---|
sample_state | No | String | Statistics on a specified sample state. Options:
|
Request Parameters¶
None
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
data_path | String | Path for storing data of a dataset. |
data_spliting_enable | Boolean | Whether the dataset can be split into training set and validation set based on the sample labeling statistics. Options:
|
grouped_label_stats | Map<String,Array<LabelStats>> | Label statistics grouped by labeling type. |
hard_detail_stats | Map<String,PairOfintAndHardDetail> | Statistics on hard example reasons. The type is Map<Integer, Pair<Integer, HardDetail>>. The key of Map indicates the ID of the hard example reason, the key of Pair indicates the number of times that the hard example reason occurs, and the value of Pair indicates the hard example reason. |
key_sample_stats | Map<String,Integer> | Statistics on hard examples. |
label_stats | Array of LabelStats objects | List of label statistics. |
metadata_stats | Map<String,Object> | Statistics on sample metadata, in JSON format. |
sample_stats | Map<String,Integer> | Statistics on sample status. |
Parameter | Type | Description |
|---|---|---|
attributes | Array of LabelAttribute objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. |
count | Integer | Number of labels. |
name | String | Label name. |
property | LabelProperty object | Basic attribute key-value pair of a label, such as color and shortcut keys. |
sample_count | Integer | Number of samples containing the label. |
type | Integer | Label type. Options:
|
Parameter | Type | Description |
|---|---|---|
key | Integer | Number of times that a hard example reason occurs. |
value | HardDetail object | Reason for a hard example. |
Parameter | Type | Description |
|---|---|---|
alo_name | String | Alias. |
id | Integer | Reason ID. |
reason | String | Reason description. |
suggestion | String | Handling suggestion. |
Parameter | Type | Description |
|---|---|---|
default_value | String | Default value of a label attribute. |
id | String | Label attribute ID. |
name | String | Label attribute name. |
type | String | Label attribute type. Options:
|
values | Array of LabelAttributeValue objects | List of label attribute values. |
Parameter | Type | Description |
|---|---|---|
id | String | Label attribute value ID. |
value | String | Label attribute value. |
Parameter | Type | Description |
|---|---|---|
@modelarts:color | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: #FFFFF0. |
@modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. Options:
|
@modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. |
@modelarts:rename_to | String | Default attribute: The new name of the label. |
@modelarts:shortcut | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D. |
@modelarts:to_type | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. |
Example Requests¶
Querying Statistics on Unapproved Samples of a Team Labeling Task
GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/workforce-tasks/tY330MHxV9dqIPVaTRM/data-annotations/stats?sample_state=__unreviewed__
Example Responses¶
Status code: 200
OK
{
"label_stats" : [ {
"name" : "Rabbits",
"type" : 1,
"property" : {
"@modelarts:color" : "#3399ff"
},
"count" : 0,
"sample_count" : 0
}, {
"name" : "Bees",
"type" : 1,
"property" : {
"@modelarts:color" : "#3399ff"
},
"count" : 1,
"sample_count" : 1
} ],
"sample_stats" : {
"un_annotation" : 308,
"total" : 309,
"rejected" : 0,
"unreviewed" : 1,
"accepted" : 0,
"auto_annotation" : 0,
"uncheck" : 0
},
"key_sample_stats" : {
"total" : 309,
"non_key_sample" : 309,
"key_sample" : 0
},
"metadata_stats" : { },
"data_spliting_enable" : false
}
Status Codes¶
Status Code | Description |
|---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Error Codes¶
See Error Codes.