cn.sent.raw

Kernel Description

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

• Support whole-syllable
• Support difficulty adjustment

Request Parameters

Parameter	Type	Required	Description
coreType	String	true	cn.sent.raw 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，support 2~20 Chinese characters scoring; Supports custom pinyin for Chinese characters, just add parentheses after the corresponding Chinese characters and mark the pinyin and tone (a Chinese character can only be marked with one pinyin), please refer to sample 2 below for details; Supports custom pinyin for non-single Chinese characters (such as numbers, English words), please refer to sample 2 below for details Supported punctuationClick 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

Sample1 Chinese text

{
  "coreType": "cn.sent.raw",  
  "res":"chn.snt.G4.A2",
  "refText": "快过年了，去办点儿年货", 
  "rank": 100, 
  "attachAudioUrl": 1
}

Sample2 Customize the pinyin of a Chinese character

{
  "coreType": "cn.sent.raw", 
  "res":"chn.snt.G4.A2",
  "refText": "风吹草低见(xian4)牛羊，思援弓缴(zhuo2)而射之", 
  "rank": 100, 
  "attachAudioUrl": 1
}

Sample3 Customize the pinyin of non-Chinese character text

{
  "coreType": "cn.sent.raw", 
  "res":"chn.snt.G4.A2",
  "refText": {
    "text": "呼叫10087，hello一心以为有鸿鹄将至,真牛X(cha1)。", 
    "prons": [
      {
        "10087": "yao1 ling2 ling2 ba1 qi1"
      }, 
      {
        "hello": "ha1 lou2"
      }
    ]
  }, 
  "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
- phn	number	Pronunciation score without tone	Suggest to display
- tone	number	Tone score	Suggest to display
- integrity	number	Score of integrity.	Suggest to display
- accuracy	number	Score of accuracy(pronunciation evaluation of the read part).	For reference
- 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
- chars	object	Chinese characters and pinyin
- - chn_input	string	Chinese character	Suggest to display
- - pinyin	array	pinyin
- details	array
- - chn_char	string	Chinese character	Suggest to display
- - char	string	pinyin	Suggest to display
- - overall	number	Total score of Chinese character	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	array
- - - 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.