ChivoxAI
sign in

/docs

en.rltm.score

Kernel Description

When the user reads the text, feedback on the spoken word and it's corresponding score in real time.

  • Support British and American pronunciation distinction.
  • Support detection of tone of stress, rising tone at end of sentence, pauses.

Request Parameters

Parameters Type Required Description
coreType String true en.rltm.score real-time reading
refText String true The content you want to evaluate. It is recommended that the number of words is less than 20，Accepted text punctuations refer to Text Punctuations
rank int false Default value is 100, 1~100 can be set
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.
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 Return result detailed settings
- details object false Detailed scoring options
- - ext_cur_wrd number false Return the read content in real time. default 1.
0: Disable
1: Enable
Stress, Rising tone, pause（optional）
  • Symbols can be used to make tone, 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.

Sample Code

{
  "coreType": "en.rltm.score", 
  "refText": "Thank you for coming to see me.", 
  "rank": 100, 
  "voiced":1,
  "attachAudioUrl": 1
}

Examples of real-time results


{
  "tokenId": "47e76381-****-****-****-********",
  "result": {
    "details": [
      {
        "score": 80,
        "text": "thank",
        "endindex": 4,
        "beginindex": 0
      }
    ],
    "rec": "thank",
    "phnspeed": 600
  },
  "eof": 0
}

Real-time return result description

Key Type Description Recommendations
eof int Whether the final evaluation result
0: Indicates that the result is returned in real time during the recording process;
1: Indicates that the result is the final evaluation result after the recording is completed;		 Suggest to display
result object Return result description
- rec string During the evaluation process, the newly-recognized words will be returned to the read content in real time. Suggest to display
- phnspeed string Current speaking rate (unit: phoneme). For reference
- details object During the evaluation process, the score of each word of the read content is returned in real time.
- - text string Words that are read. Suggest to display
- - score number Read word score Suggest to display
- - beginindex number The word first letter's index Suggest to display
- - endindex number The word last letter's index. Suggest to display

Example of final return result

  • The result is returned using the JSON structure,Example

Final return result description

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. The default percentage system. 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
- fluency object Fluency score details
- - pause number Number of pauses. Suggest to display
- - overall number Overall score of fluency. Suggest to display
- - speed number Speech rate, which is the number of words read per minute. Suggest to display
- details array Word-level superfluous reading, miss-reading, and wrong-reading detection and correction, and provide word-level scoring.
- - text string Word Suggest to display
- - is_err number pronunciation type.
0: correct.
1: superfluous reading.
2: missing reading.		 Suggest to display
- - score number Word pronunciation score Suggest to display
- - 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
- - 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
- - 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
- - 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
- - beginindex number The word first letter's index Suggest to display
- - endindex number The word last letter's index. Suggest to display
- 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.