Get Annotation Set Metadata API
Note: Register now for Alexa Live, Amazon’s annual Alexa developer conference on July 20, 2022.
Call the Get Annotation Set Metadata API to return the metadata for the specified annotation set.
HTTP method and path
GET v1/skills/{skillId}/asrAnnotationSets/{annotationSetId}
Attributes | Type | Description | Required |
---|---|---|---|
skillId | String | Skill Id as part of the request URI. | Yes |
annotationSetId | String | Annotation set Id as part of the request URI. | Yes |
Request
Request headers
Content-Type: application/json
Accept: application/json
Request body
None.
Response
HTTP status
HTTP 200 OK
Response headers
Content-Type: application/json
Response body
{
"annotationSets": [
{
"id": string,
"name": String,
"annotationCount": integer,
"lastUpdatedTimestamp": timestamp,
"eligibleForEvaluation": boolean
}
],
"paginationContext": {
"nextToken": string
}
}
Attributes | Type | Description | Required |
---|---|---|---|
name | String | Name of the annotation set. | Yes |
annotationCount | Integer | Number of annotations in the annotation set. | Yes |
lastUpdatedTimestamp | String | Timestamp for the last update to the annotation set (ISO 8601 format). | Yes |
eligibleForEvaluation | Boolean | Indicates if the annotation set is eligible for evaluation. A set is ineligible for evaluation if any annotation within the set has a missing uploadId , filePathInUpload , expectedTranscription , or expectedTranscription . |
Yes |
Error response
The following table lists call-specific errors. For a reference of errors that can apply to all Automatic Speech Recognition (ASR) APIs, see Automatic Speech Recognition API Error Reference.
HTTP Status Code | Error Code | Scenario |
---|---|---|
404 Not Found |
RESOURCE_NOT_FOUND |
Requested skill does not exist |
Requested annotation set does not exist |
||
400 Bad Request |
INVALID_REQUEST_PARAMETER |
Annotation set Id is malformed |
500 Internal Server Error |
INTERNAL_SERVER_ERROR |
Request failed due to an internal server error |
Examples
Sample Request | Sample Response |
---|---|
GET /v1/skills/1234/asrAnnotationSets/1234-1234123-1234 HTTP/1.1
Accept: application/json
|
HTTP 200 OK
Content-Type: application/json
{
"name": "my annotation set",
"annotationCount": 12,
"lastUpdatedTimestamp": "2019-08-12T18:46:31.674Z"
}
|
GET /v1/skills/1234/asrAnnotationSets/1234-1234123-1234 HTTP/1.1
Accept: application/json
|
HTTP 404 Not Found
Content-Type: application/json
{
"message": "Resource with identfier \"1234-1234123-1234\" cannot be found",
"code": "RESOURCE_NOT_FOUND"
}
|
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