Deleting Labels in Batches¶

Function¶

This API is used to delete labels in batches.

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/delete

**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
delete_policy	No	Integer	Whether to delete a label and samples containing the label. Options: 0: Delete the label. 1: Delete the label and the samples that only contain this label, but do not delete source files. 2: Delete the label and the samples that only contain this label and also delete source files.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
labels	No	Array of Label objects	List of labels to be deleted.

**Table 4** Label¶
Parameter	Mandatory	Type	Description
attributes	No	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	No	String	Label name.
property	No	LabelProperty object	Basic attribute key-value pair of a label, such as color and shortcut keys.
type	No	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	Mandatory	Type	Description
default_value	No	String	Default value of a label attribute.
id	No	String	Label attribute ID. You can query the tag by invoking the tag list.
name	No	String	Label attribute name. The value contains a maximum of 64 characters and cannot contain the character. <>=&"'.
type	No	String	Label attribute type. Options: text: text select: single-choice drop-down list
values	No	Array of LabelAttributeValue objects	List of label attribute values.

**Table 6** LabelAttributeValue¶
Parameter	Mandatory	Type	Description
id	No	String	Label attribute value ID.
value	No	String	Label attribute value.

**Table 7** LabelProperty¶
Parameter	Mandatory	Type	Description
@modelarts:color	No	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	No	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	No	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	No	String	Default attribute: The new name of the label.
@modelarts:shortcut	No	String	Default attribute: Label shortcut key. By default, this parameter is left blank. For example: D.
@modelarts:to_type	No	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.

Status code: 200

**Table 8** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
results	Array of BatchResponse objects	Response body for deleting a label.
success	Boolean	Check whether the operation is successful. Options: true: The operation is successful. false: The operation is failed.

**Table 9** BatchResponse¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
success	Boolean	Check whether the operation is successful. Options: true: The operation is successful. false: The operation is failed.

The following is an example of how to delete the tag named strawberry.

{
  "labels" : [ {
    "name" : "strawberry"
  } ]
}

Status code: 200

{
  "success" : true
}

last updated: 2024-12-11 13:55 UTC - commit: afb4a7dfa15e256dc933e946d9e874db041cb35c