MandarinWord

Description

Assessment a single Chinese character, output the total score and the scores of initial and final.

• Support whole-syllable
• Support initial and final assessment
• Support similar pronunciation correction
  

Request Parameters

Parameter	Type	Required	Description
coreType	String	true	cn.word.raw means Chinese single character assessment
res	String	true	Resouces please configure "chn.wrd.G4.D4" Currently only supports children groups
refText	String	true	The evaluation text, support the following 4 types: 1.Chinese character："好" 2.Chinese character+pinyin: 好(hao4) 3.pinyin: hao4 4.initial and final：please refer to List of initials and finals
rank	int	false	Range 1~100, default 100
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
- - cor	int	false	Whether to return pronunciation correction information in the evaluation results, default is 0 0: Disable 1: Enable

Sample Code

Sample1 Chinese character

{
  "coreType": "cn.word.raw",
  "res": "chn.wrd.G4.D4",
  "refText": "美", 
  "rank": 100, 
  "attachAudioUrl": 1,
  "result":{
  	"details":{
		gop_adjust:0.5   
	}
  }
}

Sample2 Chinese character + pinyin

{
  "coreType": "cn.word.raw",
  "res": "chn.wrd.G4.D4",
  "refText": "好(hao4)", 
  "rank": 100, 
  "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: 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
- details	array	Detailed syllable score
- - chn_ref	string	Chinese character
- - ref	string	Pinyin
- - phone	array	score results
- - - ref	string	Standard pronunciation	For reference
- - - rec	string	Actual pronunciation(when the user pronounces it as a similar sound)	For reference
- - - score	number	Syllable score	For reference
- - tone	object	tone	Suggest to display
- - - ref	int	Standard tone value (0~4)	Suggest to display
- - - score	int	Tone score	Suggest to display
- - start	number	The start time of the Chinese character in audio (Unit:milliseconds).	For reference
- - end	number	The end time of the Chinese character in audio (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.