Update an Annotation Set Property API
Call the Update an Annotation Set Property API to update the name of an existing annotation set for an Automatic Speech Recognition (ASR) Evaluation.
HTTP method and path
PUT v1/skills/{skillId}/asrAnnotationSets/{annotationSetId} HTTP/1.1
Field | Type | Description | Required |
---|---|---|---|
skillId |
String | Skill Id as part of the URI path. | Yes |
annotationSetId |
String | Annotation Id as part of the URI path. | Yes |
Request
Request headers
Content-Type: application/json
Accept: application/json
Request body
{
"name": string
}
Attributes | Type | Description | Required |
---|---|---|---|
name | String | Name of the annotation set. The length of the name can't exceed 170 chars. | Yes |
Response
HTTP status
HTTP 204 No Content
Response headers
None.
Response body
None.
Error response
This section lists call-specific errors. For a reference of errors that can apply to all ASR APIs, see Automatic Speech Recognition API Error Reference.
HTTP Status Code | Error Code | Scenario |
---|---|---|
400 Bad Request |
MISSING_REQUIRED_PROPERTY |
Required fields are missing in the request payload |
CONTENT_PARSE_FAILURE |
Request payload is malformed |
|
INVALID_STRING_LENGTH |
Length of name field isn't within allowed range |
|
INVALID_REQUEST_PARAMETER |
Name field contains invalid characters. |
|
404 Not Found |
RESOURCE_NOT_FOUND |
Requested skill does not exist |
500 Internal Server Error |
INTERNAL_SERVER_ERROR |
Request failed due to an internal server error |
Examples
Sample Request | Sample Response |
---|---|
PUT v1/skills/amzn.skill.id.1234/asrAnnotationSets/123456-1234123-123123 HTTP/1.1
Content-Type: application/json
Accept: application/json
{
"name": "my new annotation set name"
}
|
HTTP 204 No Content
|
PUT v1/skills/amzn.skill.id.1234/asrAnnotationSets/123456-1234123-123123/properties HTTP/1.1
{
"name": ""
}
|
HTTP 400 BadRequest
Content-Type: application/json
{
"message": "Payload validations failed",
"violations": [{
"message": "The \"name\" property at property path \"$.name\" is outside the allowed range. Actual length: 0, Minimum length: 1",
"code": "INVALID_STRING_LENGTH"
}]
}
|
Related topics
- What is Automatic Speech Recognition?
- Create an Annotation Set for Automatic Speech Recognition (ASR)
- Run an Automatic Speech Recognition (ASR) Evaluation
- Improve your Automatic Speech Recognition (ASR) Test Results
- Create annotation set API
- Update annotation set annotations API
- Post ASR evaluation API
- Get ASR evaluation results API
- Create catalog API
- Batch Test Your Natural Language Understanding (NLU) Model