/docs
en.word.pron
Kernel Description
Using phoneme-level pronunciation evaluation, the actual pronunciation phoneme of the user is given, and the detection of missed reading, superfluous reading, and wrong reading is given.
- Support specifying British or American pronunciation.
Request Parameters
| Parameters | Type | Required | Description |
|---|---|---|---|
| coreType | String | true | "en.word.pron" means English Word Pronunciation Correction kernel. |
| accent | int | false | Specify British or American pronunciation. 1, 2 or 3, Default value is 3.
|
| refText | String | true | Grading reference text, only supports words without any punctuation, such as "past". For more details, see Text Symbol Description |
| rank | int | false | The scoring system, the default 5 points system. Support 4-point system, 5-point system or 100-point system, you can fill in 4, 5 or 100. |
| voiced | int | false | Voiced switch, you can fill in 0 or 1, the default is 1. A value of 0 means that the user's voiced and non-voiced pronunciation are both considered correct. The value is 1, which means that the user's pronunciation must be voiced to be correct. |
| attachAudioUrl | number | false | Enable to return audio url or not.
|
| result | Object | false | Results control parameters |
| - details | Object | false | |
| - - gop_adjust | number | false | Increase or reduce the evaluation scores. The value range is between[-1,1] and the precision is 0.1 . Default value is 0, which means using original scores. If the value is between [0,1]. The larger the value is, the higher degree the score will be increased. If the value is between [-1,0], the smaller the value is, the higher degree the scores will be reduced. |
Request Parameters
{
"coreType": "en.word.pron",
"refText": "past",
"rank": 100,
"voiced": 1,
"attachAudioUrl": 1,
"result":{
"details":{
gop_adjust:0.5
}
}
}
Example of Returned Results
- The results are returned using the JSON structure, Example
Introduction to Returned Results
| Key | Type | Description | Recommendations |
|---|---|---|---|
| uuid | string | Unique id of audio. Save uuid in database in case of need. | For reference |
| audioUrl | string | Audio url.Download audio in http protocol: Just add ".mp3" at the end of the URL. Download audio in https protocol: Remove the port number, add ".mp3" at the end, and add "https://" to the prefix. e.g.https://download.cloud.chivox.com/XXXXXXXX.mp3 Tips:
|
For reference |
| result | object | Recognized result. | |
| - overall | number | Overall Score. | Suggest to display |
| - wavetime | number | Audio duration (Unit: milliseconds) | For reference |
| - details | object | Detailed phoneme score. | |
| - - word | array | word score Details | |
| - - - name | string | The English word you want to envalate the recording with | Suggest to display |
| - - - indict | number | Whether the word is included in the evaluation dictionary. 1. The word is included in the evaluation dictionary. 0, the word is not included in the evaluation dictionary. |
|
| - - - accent | int | 0, 1, 2 or 3:
|
Suggest to display |
| - - - lab | string | The standard pronunciation phoneme sequence of the word. See more details, refer to Phoneme Comparison Table |
Suggest to display |
| - - - rec | string | Phoneme recognized. See more details, refer toPhoneme Comparison Table |
Suggest to display |
| - - - is_err | number | Word error type. 0: The pronunciation is correct. 1: superfluous reading/misread. 2: missing reading. |
Suggest to display |
| - - - start | number | The start time of the word in audio (Unit: milliseconds). | For reference |
| - - - end | number | The end time of the word in audio (Unit: milliseconds). | For reference |
| - - - phone | array | Phoneme level evaluation results. | Suggest to display |
| - - - - lab | string | The standard phoneme of the word, if not, is represented by #. See more details, refer to Phoneme Comparison Table |
Suggest to display |
| - - - - is_err | number | Phoneme error type. 0：The pronunciation is correct. 1：superfluous reading. 2：missing reading. 3：misread. 4：The standard requires voicing, and the user's pronunciation is not voicing. |
Suggest to display |
| - - - - rec | string | If there is no recognized phoneme, use # to indicate. For more details, see Phoneme Comparison Table |
Suggest to display |
| - - - - start | number | The start time of the phoneme in audio (Unit: milliseconds). | For reference |
| - - - - end | number | The end time of the phoneme in audio (Unit: milliseconds). | For reference |
| - - - stress | array | The syllable are read stressly. | Suggest to display |
| - - - - char | string | Syllable. | Suggest to display |
| - - - - ref | number | The stress mark status of the syllable in the evaluation dictionary, the value is 0,1.
|
Suggest to display |
| - - - - score | number | Check whether the pronunciation is accented, the value is 0,1.
1：User read the syllable stressly. |
Suggest to display |
| - - - phoneme | object | The Correspondence between letters and phoneme（Phonetic transcription）. Color the corresponding letters based on the phoneme (phonetic transcription) score. The following words do not support this function, and the field in the returned result is {}.
|
Suggest to display |
| - - - - letters | string | Standard letter sequence | Suggest to display |
| - - - - prons | string | Standard pronunciation phoneme sequence. e.g. prons: p_aa_s_t | Suggest to display |
| - info | object | ||
| - - tipId | number | Audio quality For details, please refer to TipId field description |
For reference |
| - - tips | string | Error information1. "post proc failed"2. "fa decode failed!" 3. "empty or too short wav!" These errors may be that the audio was not recorded successfully or the engine did not detect the user's valid voice, which can prompt the user to re-record. | For reference |
Note: The other returned parameters that are not shown above are internal ones, which you don't need to pay much atttention to.