ChivoxAI
sign in

/docs

en.sent.score

Kernel Description

Evaluate speech on sentence reading, outputting scores of overall, fluency, accuracy, integrity and each word.

  • Support specifying British or American pronunciation.
  • Support detection of tone of stress, rising tone at end of sentence, pauses.
  • Support detection of loss of plosion, liaison.

Request Parameters

Parameter Type Required Description
coreType String true "en.sent.score" means sentence fusion kernel, adaptive to children and adults
accent int false Specify British or American pronunciation. 1, 2 or 3, Default value is 3.
  • 1. Accept British pronunciation.
  • 2: Accept American pronunciation.
  • 3: Accept both British and American pronunciation.
Now about 4000 words have been marked British and American pronunciation in our dictionary.
refText String true The English sentence you want to evaluate the recording with.
We recommend sentence consisting of 2 to 20 words, such as " I want to know the past and present of Hong Kong. "
Accepted text punctuations refer to Text Punctuations
For more than 20 words, it is recommended to use Paragraph kernel
rank int false 4 or 100, Default value is 100, means full score is 100.
voiced int false 0 or 1:
0: Accept both voiced and non-voiced pronunciation.
1: Only accept voiced pronunciation.
Default value is 1
attachAudioUrl number false Enable to return audio url or not.
  • 0: Disable
  • 1: Enable
result object false Results control parameters
- details object false Detailed scoring options
- - phone number false Enable to return the phoneme dimension in the evaluation result.
Default value is 0.
0: Disable
1: Enable
- - connti number false Whether to enable detection of loss of plosion and liaison, Default value is 0.
0: Disable
1: Enable
- - 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.
Stress, Rising tone, pause（optional）
  • Symbols can be used to mark the position of stress tone, rising tone and pause in sentences.
  • Accents, ups and downs, and pauses are not counted in the total score.
Type Symbols Sample Description
Stress (s:1) Are(s:1) you ok? "Are" is maked with stressed.
Rising tone (t:1) Are you ok(t:1)? "Ok" is marked with rising tone.
both Stress and rising tone (s:1,t:1) Are you ok(s:1,t:1)? Word “ok” is marked as both stress and rising tone, use commas to separate marks.
pause (g:1) Are you(g:1) ok? Word “you” is marked with pause.
Loss of Plosion、Liaison(optional)
  • Need to be marked with a symbol in the refText field
  • Not counted in the total score
Type Sample Description
Loss of Plosion What(c:1) time is it now? Loss of Plosion occurred between What and time.
Liaison Nice to meet(c:1) you. Liaison occurred between meet and you.

Supported rules，Please refer toClick to view.

Sample Code

{
  "coreType": "en.sent.score", 
  "refText": "I want to know the past and present of the student.", 
  "accent": 1,
  "rank": 100, 
  "voiced":1,
  "attachAudioUrl": 1, 
  "result": {
    "details": {
      "phone": 0，
      "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:
  • Chivox save audio for one week. Please save audio to your own server for long-term storage.
  • The domain name will be different for different access areas, and the actual return shall prevail.
 For reference
result object Scoring result
- wavetime number Audio duration (Unit:milliseconds) For reference
- overall number Overall score Suggest to display
- fluency object Fluency score details
- - overall number Overall score of fluency Suggest to display
- - pause number Number of pauses. Suggest to display
- - speed number Speech rate, which is the number of words read per minute. Suggest to display
- integrity number Score of integrity. Suggest to display
- accuracy number Score of accuracy(pronunciation evaluation of the read part). Suggest to display
- details array Words and phoneme scores
- - char string Word Suggest to display
- - indict int The word's pronunciation is in dictionary or generated by the engine. 0, 1 or 2:
0: The word is not in Chivox’s dictionary and engine failed to generate its pronunciation.
1: The word is in Chivox’s dictionary.
2: The word is not in Chivox’s dictionary but the engine generates its pronunciation successfully.		 For reference
- - accent int 0, 1, 2 or 3:
  • 0: Its pronunciations are not marked with American or British accent.
  • 1: British pronunciation.
  • 2: American pronunciation.
  • 3: English pronunciation is the same as American pronunciation.
 Suggest to display
- - score number Word pronunciation score 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
- - beginindex number The word first letter's index Suggest to display
- - endindex number The word last letter's index. Suggest to display
- - stressref number 0 or 1:
0: Not marked to be stressed.
1: Marked to be stressed.		 Suggest to display
- - stressscore number 0 or 1:
0: Not stressed in audio.
1: Stressed in audio.		 Suggest to display
- - toneref number 0 or 1:
0: Not marked to rising tone.
1: Marked to rising tone.		 Suggest to display
- - tonescore number 0 or 1:
0: Not reading with rising tone.
1: Reading with rising tone.		 Suggest to display
- - pause_ref number 0 or 1:
0: Not marked to pause.
1: Marked to pause.		 Suggest to display
- - pause_score number 0 or 1:
0: Reading without pause after the word.
1: Reading with pause after the word.		 Suggest to display
- - conn_ref number Rule type(Loss of Plosion or Liaison)
0, No rules
1,Indicates liaison
2, Indicates loss of plosion
3, It can be either liaison or loss of plosion.
Note：When conn_ref is 3, please choose according to the actual needs of investigation, whether it is type 1 or type 2		 Suggest to display
- - conn_type number Detect result(Loss of Plosion or Liaison)
0，No liaison or loss of plosion.
1，liaison
2，loss of plosion
conn_ref=conn_type，Indicates that the user’s pronunciation is consistent with the mark.		 Suggest to display
- - phone array Phoneme-level scoring results.
Refer toPhonetic Comparison Table
- - -char string Phoneme For reference
- - -score number Phoneme score For reference
- info object
- - tipId number Audio quality
For details, please refer to TipId field description		 For reference
- - tips string Error message prompt
When prompted "post proc failed", it may be that the audio was not successfully recorded or the engine did not detect the user’s valid voice.
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.

SDK, API, MCP and Function Calling documentation on this site.