doc-exports/docs/modelarts/api-ref/ListLabels.html

Querying the Dataset Label List

Function

This API is used to query all labels of a dataset.

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}/data-annotations/labels

Table 1 Path Parameters

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.

Table 2 Query Parameters

Parameter	Mandatory	Type	Description
version_id	No	String	Dataset version ID.
offset	No	Integer	Start page for pagination display. The default value is 0.
limit	No	Integer	Maximum number of records returned on each page. The value ranges from 1 to 100000. The default value is 100000.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter	Type	Description
labels	Array of Label objects	Label list.
total_number	Integer	Number of labels

Table 4 Label

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.
name	String	Label name.
property	LabelProperty object	Basic attribute key-value pair of a label, such as color and shortcut keys.
type	Integer	Label type. Options: 0: image classification 1: object detection 3: image segmentation 100: text classification 101: named entity recognition 102: text triplet relationship 103: text triplet entity 200: sound classification 201: speech content 202: speech paragraph labeling 600: video labeling

Table 5 LabelAttribute

Parameter	Type	Description
default_value	String	Default value of a label attribute.
id	String	Label attribute ID. You can query the tag by invoking the tag list.
name	String	Label attribute name. The value contains a maximum of 64 characters and cannot contain the character. <>=&"'.
type	String	Label attribute type. Options: text: text select: single-choice drop-down list
values	Array of LabelAttributeValue objects	List of label attribute values.

Table 6 LabelAttributeValue

Parameter	Type	Description
id	String	Label attribute value ID.
value	String	Label attribute value.

Table 7 LabelProperty

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: bndbox: rectangle polygon: polygon circle: circle line: straight line dashed: dotted line point: point polyline: polyline
@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 All Labels of a Dataset

GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/labels

Example Responses

Status code: 200

OK

{
  "total_number" : 2,
  "labels" : [ {
    "name" : "Rabbits",
    "type" : 1,
    "property" : {
      "@modelarts:color" : "#3399ff"
    }
  }, {
    "name" : "Bees",
    "type" : 1,
    "property" : {
      "@modelarts:color" : "#3399ff"
    }
  } ]
}

Status Codes

Status Code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Error Codes

See Error Codes.

Parent topic: Data Management (Old Version)