/docs

en.nsp.score

Description

Evaluate English spelling pronunciation and feedback phonetic symbols and word scores

Request Parameters

Parameter	Type	Required	Description
coreType	String	true	en.nsp.score means phonics
refText	String	true	reference text, just mark the pronunciation phonetic symbols after the corresponding text, and support mark stress position. For detail, please refer to the parameter example below
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.
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	Results control parameters
- - 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 1

{
  "coreType": "en.nsp.score", 
  "refText": "directory(p:dəˈrektəri)", 
  "rank": 100
}

Sample Code 2

{
  "coreType": "en.nsp.score", 
  "refText": "c(p:k) c(p:k) cat", 
  "rank": 100
}

Sample result

The evaluation result is in json format,sample

Field description of result

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
- 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
- integrity	number	Score of integrity.	Suggest to display
- accuracy	number	Score of accuracy(pronunciation evaluation of the read part).	Suggest to display
- details	array	Words and phoneme scores
- - 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
- - 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
- - beginindex	number	The word first letter's index	Suggest to display
- - endindex	number	The word last letter's index.	Suggest to display

- - phone	array	Phoneme-level scoring results. Refer toPhonetic Comparison Table
- - -char	string	Phoneme	For reference
- - -score	number	Phoneme score	For reference

- info	object
- - tipId	number	Audio quality For details, please refer to TipId 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.