Updating a Label by Label Names
Function
This API is used to update a label by label names.
Debugging
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI
PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name}
| 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. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| label_type | No | Integer | Label type. Options:
|
Request 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:
|
| @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. |
Response Parameters
Status code: 204
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
| success | Boolean | Whether the operation is successful. Options:
|
Example Requests
Updating a Label by Label Names
{
"@modelarts:color" : "#93c47d"
} Example Responses
Status code: 204
No Content
{ } Status Codes
| Status Code | Description |
|---|---|
| 204 | No Content |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.