Delete an Annotation Set API

The Delete an Annotation Set API deletes the annotation set identified by Annotation set Id.

HTTP method and path

DELETE v1/skills/{skillId}/asrAnnotationSets/{annotationSetId}
Attributes Type Description Required
skillId String Skill Id as part of the URI path. Yes
annotationSetId String Annotation set Id as part of the request URI path. Yes

Request

Request headers

 Content-Type: application/json
 Accept: application/json

Request body

None.

Response

HTTP status

HTTP 204 No Content

Response headers

Content-Type: application/json

Response body

None.

Error response

This section 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
400 Bad Request INVALID_REQUEST_PARAMETER Annotation set Id is malformed.
Skill Id is malformed.
409 Conflict RESOURCE_IN_USE The annotation set is currently in use in an evaluation run.

404 Not Found

RESOURCE_NOT_FOUND

Requested skill does not exist.

Requested annotation set does not exist.

500 Internal Server Error

INTERNAL_SERVER_ERROR

Request failed due to an internal server error.

Examples

Sample Request Sample Response
DELETE /v1/skills/1234/asrAnnotationSets/123-1234-1234 HTTP/1.1 Accept: application/json HTTP 204 NO CONTENT
DELETE /v1/skills/1234/asrAnnotationSets/123-1234-1234 HTTP/1.1 Accept: application/json
HTTP 404 Not Found Content-Type: application/json { "message": "Annotation set with id \"123-1234-1234\" cannot be found", "code": "RESOURCE_NOT_FOUND" }