Updating a Label by Label Names¶

Function¶

This API is used to update a label by label names.

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

PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name}

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
dataset_id	Yes	String	Dataset ID.
label_name	Yes	String	Label name.
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
label_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 label 103: text triplet entity label 200: sound classification 201: speech content 202: speech paragraph labeling 600: video labeling

**Table 3** Request body parameters¶
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: 204

**Table 4** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
success	Boolean	Whether the operation is successful. Options: true: successful false: failed

Updating a Label by Label Names

{
  "@modelarts:color" : "#93c47d"
}

Status code: 204

No Content

{ }

last updated: 2024-11-14 08:44 UTC - commit: 3b80612feba1452e3d3adbec6770d8e1b5070820