ChivoxAI

/docs

cn.sent.score

Kernel Description

Evaluate Chinese phrases and sentences, outputting scores of overall, fluency, accuracy, integrity, ench pinyin, initial and final

  • Support whole-syllable
  • Support initial and final evaluation
  • Support difficulty adjustment

Request Parameters

Parameter Type Required Description
coreType String true cn.sent.score means Chinese phrases and sentences evaluation
res String true Resources
For children groups, please configure "chn.snt.G4.A2"
For adult groups, please configure "chn.snt.G4.A7"
refText String true Reference text
Use pinyin plus numbers to mark, support 2~20 Chinese characters scoring;
Marking rules: initial + final + tone, 0/1/2/3/4Corresponding to :
Softly、ˉ ˊ ˇ ˋtone;
final ü : mark with v, for example, "女" is marked with "nv3";
The pinyin is separated by spaces.
Support initial and final evaluation, please refer to List of initials and finals
Supported punctuation Click to view
rank int false 4 or 100, Default value is 100, means full score is 100.
attachAudioUrl number false Enable to return audio url or not.
  • 0: Disable
  • 1: Enable
result object false Result control parameters
- details object false Detailed scoring options
- - gop_adjust number false Increase or reduce the evaluation scores.
value range[-1,-0.9, ... 0.9, 1]。
Default value is 0, which means using original scores.
The passing parameter is a positive number to increase the scoring score. The larger the passing parameter, the more the score will be improved.
Pass parameter is negative, reduce the scoring score, the smaller the pass parameter, the more the score will be reduced

Sample Code

{
  "coreType": "cn.sent.score", 
  "res": "chn.snt.G4.A2",
  "refText": "kuai4 guo4 nian2 le0, qu4 ban4 dianr3 nian2 huo4.", 
  "rank": 100, 
  "attachAudioUrl": 1
}

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). For reference
- phn number Pronunciation score without tone Suggest to display
- tone number Tone score Suggest to display
- details object
- - char string Pinyin For reference
- - overall number Syllable overall score: Integrated syllable pronunciation without tone(phn) and tone (tone) Suggest to display
- - tonescore number Tone score Suggest to display
- - phn number Pronunciation score without tone Suggest to display
- - tone number Standard tone value (0~4) Suggest to display
- - confidence array Pronunciation tone confidence, a total of 5 digits,
respectively indicate the probability of being pronounced as soft, one, two, three, and four tones.
The tone with the largest number is the actual tone of the pronunciation.
Suggest to display
- - phone number
- - - char string Syllable For reference
- - - score number Syllable score For reference
- - 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
- - dur number duration (Unit: milliseconds). For reference
- info object
- - tipId number Audio quality
For details, please refer toTipId 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.