en.word.score

Kernel Description

Evaluate word pronunciation and provide feedback on total score and score of each phonetic symbol;

• Supports outputting the correspondence between phonetic symbols and letters.
• Supports syllable stress detection.
• Supports specifying British or American pronunciation.

Request Parameters

Parameters	Type	Required	Description
coreType	string	true	"en.word.score" means word fusion kernel, adaptive to children and adults
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. Now about 4000 words have been marked British and American pronunciation in our dictionary.
refText	string	true	reference text, only supports words without any punctuation, such as "present"
rank	int	false	4 or 100, Default value is 100, means full score is 100.
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
result	object	false	Result control parameters
- details	object	false	Detailed scoring options
- - gop_adjust	number	false	Increase or reduce the evaluation scores. The value range is between[-1,1] and the precision is 0.1 . Default value is 0, which means using original scores. If the value is between [0,1]. The larger the value is, the higher degree the score will be increased. If the value is between [-1,0], the smaller the value is, the higher degree the scores will be reduced.

Sample Code

{
  "coreType": "en.word.score", 
  "refText": "sport", 
  "accent":2,
  "voiced": 1,
  "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 phoneme score
- - char	string	Word	Suggest to display
- - 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
- - 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
- - score	number	Word pronunciation score	Suggest to display
- - phonics	array	Phonetic symbols and corresponding letter scores
- - - spell	string	Letter or letter combination	Suggest to display
- - - phoneme	array	Phonetic symbols The default is IPA88 phonetic symbols. If you need KK phonetic symbols, please set the value of accent field to 2 in the request parameters.	Suggest to display
- - - overall	number	Phonetic score	Suggest to display
- - stress	array	Phoneme stress results.	Suggest to display
- - - char	string	Syllable	Suggest to display
- - - ref	number	Whether the syllable should be stressed as marked in dictionary. The value is 0 or 1： 0：Should not be stressed. 1：Should be stressed.	Suggest to display
- - - score	number	Whether the syllable is stressed, The value is 0 or 1： 0：It is stressed. 1：It is not stressed.	Suggest to display
- info	object
- - tipId	number	Audio quality For details, please refer to TipId field description	For reference
- - tips	string	Error information 1. rec failed Data sample 2. post proc failed. Data sample These errors may be that the audio was not recorded successfully or the engine did not detect the user's valid voice, which can 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.