en.vocabs.pron

Kernel Description

Evaluate multiple words

• Support out-of-order reading
• Output overall score, pronunciation score for each word
• Support British and American pronunciation distinction

Request Parameters

Parameters	Type	Required	Description
coreType	String	true	en.vocabs.pron means vocabulary assessment
refText	String	true	The words you want to evaluate. It is recommended that the number of words is less than 20, and there are no words that have semantic or pronunciation influences on each other.
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

Sample Code

{
  "coreType": "en.vocabs.pron", 
  "refText": "are map green color morning evening", 
  "rank": 100, 
  "voiced":1,
  "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
- details	array	Words scores
- - words	array	Word score details
- - - char	string	Word	Suggest to display
- - - score	number	Word pronunciation score	Suggest to display
- - - is_err	number	pronunciation type 0: correct 1: superfluous reading 2: missing reading.	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
- - - toBeRemoved	number	superfluous vowels	For reference
- - - toBeImproved	number	phonemes that need to practice	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
- - - 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. If the value is -1, it means that this is a multi-read word.	Suggest to display
- - - endindex	number	The word last letter's index. If the value is -1, it means that this is a multi-read word.	Suggest to display
- info	object
- - tipId	number	Audio quality For details, please refer to TipId field description	For reference
- - tips	string	Error message prompt 1. "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; 2. "fa decode failed!": Decoding failure caused by poor audio quality, 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.