MandarinVocab

Description

Assessment words according to Mandarin standards, output the total score, the score for each Chinese character, the initials and finals, and the tone scores.

Request Parameters

Parameter	Type	Required	Description
coreType	String	true	cn.vocab.raw means Chinese words evaluation
refText	String	true	Evaluation text, supports 2 to 4 Chinese characters, supports the following 2 types of text input 1.Chinese character："你好" 2.Chinese character+pinyin: "今天(tian1)"
rank	int	false	Range 1~100, default 100
attachAudioUrl	number	false	Enable to return audio url or not. 0: Disable 1: Enable

Sample Code

Sample1 Chinese character

{
  "coreType": "cn.vocab.raw",  
  "refText": "你好", 
  "rank": 100, 
  "attachAudioUrl": 1
}

Sample2 Chinese character + pinyin

{
  "coreType": "cn.vocab.raw",  
  "refText": "今天(tian1)", 
  "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
- remark	string	remark from the engine	For reference
- details	array	Detailed Score
- - chn_ref	string	Chinese character
- - ref	string	Pinyin
- - score	number	Chinese character score
- - phone	array	syllable score result
- - - ref	string	initials/finals	For reference
- - - score	int	initials/finals 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.