Paragraphs

Assessment type description

• Scores English paragraphs and provides real-time feedback.

• Feedback dimensions include overall pronunciation score, accuracy, integrity, and fluency.

Assessment request parameters

Parameter example

{
    "coreType": "en.pred.score",
    "refText": "Learning another language may seem more challenge than it's worth. The advantages of knowing another language, however, make it well worth the hard work. A foreign language is a window into another culture. It expresses the way people in that society think and view the world. To know another language is thus to view life through new lens. Knowing another language also provides access to different ways of dealing with problems common to us all. It is also an advantage in the business world, where multinational partners are becoming more common. Finally, understanding a different language enables you to look at your own culture from a fresh perspective.",
    "rank": 100,
    "precision": 0.5,
    "attachAudioUrl":1
}

Example response

{
    "applicationId": "axxx",    // The authorized assessment account, which is the AppKey.
    "tokenId": "59b0ff9796ddf81da4000001",    // The unique ID of the user request.
    "recordId": "11e793a4881333c4974ca120320158d",   // The unique ID of the audio file.
    "dtLastResponse": "2021-08-05 16:14:24:21",   // The timestamp of the cloud response.
    "result": {                    // The assessment result node.
        "fluency": 81,          // The fluency score.
        "pron": 77,              // The pronunciation score, which is the same as the accuracy score.
        "version": "0.0.80.2021.5.28.13:23:19",  // The version of the DPI engine, including the release time.
        "wavetime": 49990,       // The audio duration in ms.
        "rank": 100,           // The scoring scale. You can set this to any value in the request. The final score is recalculated based on its ratio to 100.
        "res": "eng.snt.online.1.0",   // The resource version.
        "delaytime": 81,         // The time taken by the cloud from the end of audio feeding to result retrieval, in ms.
        "integrity": 81,         // The integrity score.
        "overall": 77,           // The overall score.
        "systime": 11423,    // The total time taken for the entire assessment process, in ms.
        "pretime": 165,         // The time taken by the cloud to call the Start API, in ms.
        "accuracy": 77,         // The pronunciation score, which is the same as the accuracy score.
        "details": [            // The node for sentence score details.
            {
                "fluency": {     // The node for sentence fluency feedback.
                    "pause": 2,    // The number of pauses.
                    "overall": 71,  // The sentence fluency score.
                    "speed": 2      // The sentence speech rate. 0: Slow. 1: Normal. 2: Fast. The default is 0. The value is also 0 for missed words.
                },
                "snt_details": [   // The node for word score details in the sentence.
                    {
                        "char": "Learning",  // The word text.
                        "score": 42           // The word pronunciation score.
                    },
                    ......
                    {
                        "char": "worth",
                        "score": 68
                    }
                ],
                "score": 57,            // The sentence pronunciation score.
                "text": "Learning another language may seem more challenge than it's worth"
            },
            {
                "fluency": {
                    "pause": 0,
                    "overall": 87,
                    "speed": 1
                },
                "snt_details": [
                    {
                        "char": "The",
                        "score": 94
                    },
                    ......
                    {
                        "char": "language",
                        "score": 88
                    }
                ],
                "score": 70,
                "text": "The advantages of knowing another language"
            }
......
        ],
        "precision": 1,   // The scoring precision set in the request. Valid values are 0.1, 0.5, and 1. The default value is 1. If you set this to a value other than 0.1 or 0.5, it is processed as 1.
        "info": {
            "volume": 54,    // The recording volume. Range: 0 dB to 180 dB.
            "clip": 0,          // Audio clipping occurred because the volume was too high. Range: 0 to 1. If this parameter affects the score, a corresponding tipId is set.
            "snr": 12.811419,  // The signal-to-noise ratio (SNR). A higher value indicates clearer audio. Range: 0 dB to 40 dB. If this parameter affects the score, a corresponding tipId is set.
            "tipId": 10004     // The audio quality. For more information, see the tipId description table.
        }
    }, 
    "eof": 1,     // 0 indicates that the response is not complete and more results will follow. 1 indicates that all results for this assessment have been returned.

    "params": {
        "app": {
            "timestamp": "1504772030",
            "sig": "d2d96b467ab7b6d110335478516c4f2f3f181687",
           "applicationId": "aXXX",
            "userId": "ssound_text",
            "clientId": "000c2933841a"
        },
        "request": {                // The scoring request node.
            "coreType": "en.pred.score",
            "tokenId": "59b0ff9796ddf81da4000001",
            "refText": "Learning another language may seem more challenge than it's worth. The advantages of knowing another language, however, make it well worth the hard work. A foreign language is a window into another culture. It expresses the way people in that society think and view the world. To know another language is thus to view life through new lens. Knowing another  language also provides access to different ways of dealing with problems common to us all. It is also an advantage in the business world, where multinational partners are becoming more common. Finally, understanding a different language enables you to look at your own culture from a fresh perspective.",
            "rank": 100,
            "precision": 1
        },
        "audio": {    // The audio parameter node for the scoring request.
            "sampleRate": 16000,
            "channel": 1,
            "sampleBytes": 2,
            "audioType": "ogg"  
        }
    },
    "refText": "Learning another language may seem more challenge than it's worth. The advantages of knowing another language, however, make it well worth the hard work. A foreign language is a window into another culture. It expresses the way people in that society think and view the world. To know another language is thus to view life through new lens. Knowing another  language also provides access to different ways of dealing with problems common to us all. It is also an advantage in the business world, where multinational partners are becoming more common. Finally, understanding a different language enables you to look at your own culture from a fresh perspective."
}

Response description

Suggestions for displaying assessment results

Response for a failed assessment

• If the result structure in the response is empty, the assessment failed.

• You can retrieve the errId and error from the response. Your product can then perform further checks and handle the error based on the error code.

Error codes

• For more information, see Assessment error codes.