cn.rec.raw

Kernel Description

Pass multiple text branches to the kernel, and the kernal feeds back the text branches read by the user, and gives the total score, fluency score, completeness score, accuracy score, and each word score. If a word in the text content is a keyword that needs to be detected, you can use AITalk Kernel.

• Applicable question types: Multiple-choice questions, man-machine dialogue.

Request Parameters

Parameter	Type	Required	Description
coreType	String	true	cn.rec.raw means Limited Branching Kernel
refText	String	true	Text branches, separated by | between branches, allowing 2-10 branches. 5-20 Chinese characters are recommended for each branch. Supported punctuationClick to view
attachAudioUrl	number	false	Enable to return audio url or not. 0: Disable 1: Enable
result	object	false	Result control parameters
- use_details	number	false	Enable to output the score of each Chinese character，Default is 0 0: Disable 1: Enable

Sample Code

{
	"coreType": "cn.rec.raw",
	"refText": "今天天气晴朗 | 今天天气阴沉沉的 | 我喜欢今天的天气",
	"rank":100,
	"attachAudioUrl": 1,
	"result":{
		"use_details":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
- conf	number	Confidence score. The matching degree between the recognized reading content and an answer branch in the text passed to the kernel. The threshold is set by the application layer to determine whether the result is correct (generally 75, which can be adjusted up and down according to the difficulty of the question).	Suggest to display
- rec	string	Recognized text branch.	Suggest to display
- overall	number	The overall score for evaluating the identified branch options.	Suggest to display
- integrity	number	Score of integrity.	Suggest to display
- accuracy	number	Score of accuracy(pronunciation evaluation of the read part).	For reference
- 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
- starttime	number	Start time of pronunciation, in milliseconds (ms)	For reference
- endtime	number	End time of pronunciation, in milliseconds (ms)	For reference
- details	array
- - chn_char	string	Chinese character	Suggest to display
- - char	string	Pinyin	Suggest to display
- - overall	number	Total score of Chinese character	Suggest to display
- - phn	number	Pronunciation score without tone	Suggest to display
- - tonescore	number	Tone score	Suggest to display
- - tone	number	Standard tone value (0~4)	Suggest to display
- - confidence	array	Pronunciation tone confidence, a total of 5 digits, respectively indicate the probability of being pronounced as soft, one, two, three, and four tones. The tone with the largest number is the actual tone of the pronunciation.	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
- 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.

Suggestions for handling scoring results

Firstly, it is judged whether the value of the conf field exceeds the set threshold. If it exceeds, the content of the rec field is extracted, that is, the branch text read by the user is recognized this time. Otherwise, the user is prompted to try to read aloud again or not hear your pronunciation clearly.