Possible SR Results for REST

This documentation provides detailed information about various recognition results and error scenarios. Please refer to the relevant section as needed for proper usage and troubleshooting.

1 - Normal Recognition Result

• Description: This response represents a successful recognition result with high confidence.

{
    "audioLink": "http://example.com/audio.wav",
    "confidence": 1.0,
    "detectedAudioContent": "recognizable-speech",
    "errorCode": null,
    "errorMessage": null,
    "moreInfo": null,
    "nbestlist": {
        "utterances": [
            {
                "confidence": 99,
                "nlsmlResult": "",
                "recognizedWords": [
                    {
                        "confidence": 99,
                        "endTimeMsec": 930,
                        "startTimeMsec": 240,
                        "word": "merhaba",
                        "wordType": "Normal"
                    }
                ]
            }
        ]
    },
    "resultText": "merhaba",
    "success": true
}

2 - Missing Model Parameter

• Description: This error occurs when the ModelName parameter is missing.

missing parameter: ModelName

3 - Empty Audio Content

• Description: This response indicates that the provided audio content is empty.

{
    "detectedAudioContent": "empty",
    "errorCode": null,
    "errorMessage": null,
    "moreInfo": null,
    "success": true
}

4 - Model is Not Available

• Description: This error occurs when the specified model is not available.

{
    "errorCode": "http-422",
    "errorMessage": "model name(tr2), tenant(Default) and version(1) is not available",
    "moreInfo": "",
    "success": false
}

5 - Invalid Audio Content

• Description: This error indicates that the provided audio content is invalid.

{
    "errorCode": "http-422",
    "errorMessage": "invalid audio content",
    "moreInfo": "",
    "success": false
}

6 - Acquire License Has Failed

• Description: This error occurs when acquiring a license for recognition has failed.

{
    "errorCode": "http-402",
    "errorMessage": "Acquire license has failed",
    "moreInfo": "",
    "success": false
}

7 - Initialize Recognizer Has Failed

• Description: This error indicates a failure in initializing the recognizer.

{
    "errorCode": "http-500",
    "errorMessage": "internal-server-error",
    "moreInfo": "recognizer initialization failed : [initialize result]",
    "success": false
}

8 - Audio Splitter is Not Configured

• Description: This error occurs when there is no proper audio splitter configured.

{
    "errorCode": "http-500",
    "errorMessage": "internal-server-error",
    "moreInfo": "no proper audio splitter has been configured",
    "success": false
}

9 - Starting Recognition Has Failed

• Description: This error indicates a failure in starting the recognition process.

{
    "errorCode": "http-500",
    "errorMessage": "internal-server-error",
    "moreInfo": "Starting recognition failed : [start result]",
    "success": false
}

10 - Unrecognizable Speech

• Description: This response indicates that the audio contains unrecognizable speech.

{
    "detectedAudioContent": "unrecognizable-speech",
    "errorCode": null,
    "errorMessage": null,
    "moreInfo": null,
    "success": true
}

11 - Invalid Start Time (Longer than Audio Duration)

• Description: This error occurs when the start time is longer than the audio duration.

{
    "errorCode": "http-422",
    "errorMessage": "Start time cannot be longer than the audio duration",
    "moreInfo": "",
    "success": false
}

12 - Invalid Start Time (Greater than or Equal to End Time)

• Description: This error occurs when the start time is greater than or equal to the end time.

{
    "errorCode": "http-422",
    "errorMessage": "Start time cannot be greater than or equal to end time",
    "moreInfo": "",
    "success": false
}

13 - Noisy Speech

• Description: This occurs when the audio recording is detected too noisy.

{
    "detectedAudioContent": "noise",
    "errorCode": null,
    "errorMessage": null,
    "moreInfo": null,
    "success": true
}