/docs

en.prtl.exam

Kernel Description

Applicable question types: retelling after listening, story retelling, topic briefing, speaking with pictures, oral composition, oral expression, information relaying, information relaying after listening, etc.
Evaluation dimensions: total score, fluency score, grammar score, content score, pronunciation score.

Request Parameters

Parameters	Type	Required	Description
coreType	String	true	"en.prtl.exam" means open questions kernel.
rank	int	true	Overall score points system, support arbitrary points system.
precision	float	true	Rating accuracy, support 1 and 0.5.
attachAudioUrl	number	false	Enable to return audio url or not. 0: Disable 1: Enable
keyWords	array	false	Correct key words, phrases, phrases. Notes: 1. Extract important scoring points as keywords as possible. It is recommended to set at least one keyword per sentence; 2. Support parallel keywords, input multiple synonyms at the same level to represent the same point, see the parameter example below for details; 3. Please make sure that the keywords are correct. The user’s pronunciation does not include keywords, which will directly affect the content dimension score and thus the total score; 4. Keywords need to appear in the reference answer content of the refText field below;
sensitiveWords	array	false	Incorrect key words (words, terms, phrases or numbers) are only detected and do not affect the evaluation score.
refText	object	true	Reference answer node.
- lm	object	true
- - text	String	true	Reference answer. Each answer generally requires 4-7 sentences. At least 3~5 answers need to be set. For text format, please refer to Text Symbol Description Notes： 1.The answer needs to be filled in with the correct content, and there must be no incorrect text or grammatical errors, etc. 2.The answers try to cover all possible expressions of students. In the recommended quantity, you can pass in more. 3.The answer should be written from the perspective of the end user.
result	object	true	Results control parameters
- details	object	true
- - use_inherit_rank	number	true	Unify the scoring system of each dimension, set to 1
- - num_order	number	false	Whether the numeric keywords are matched in order, the default value is 0. 0: Not matched in order 1: Matched in order

Sample Code

{
	"coreType": "en.prtl.exam",
    "keyWords": ["drinking", "eating a banana", "giraffes", ["love","like"]], //Love and like are input side by side, which means they are synonyms, and they are entered in the same [] 
    "refText": {
                "lm": [
                   {
					"text": "Look, what are these animals doing now in the zoo? Four elephants are drinking water. Two cute pandas are sleeping on the tree. AThere is a monkey over there and it is eating a banana. And a tiger is swimming in the water. Two giraffes are running! I like these animals."
				}, 
				{
					"text": "Look, what are these animals doing now in the zoo? There are four elephants in the zoo and they are drinking water. Two cute pandas are sleeping on the tree. A monkey is eating a banana. And a tiger is swimming in the water. Two giraffes are running! I like these animals."
				}, 
				{
					"text": "Look, what are these animals doing now in the zoo? Four elephants are drinking water. Two fat pandas are on the tree and they are sleeping. A monkey is sitting over there and eating a banana. And a tiger is swimming in the water. Two giraffes are running! I like these animals."
				}, 
            ...
                ]
            },
    "rank": 100,
    "precision": 1,
    "result": {
       "details": 
	   {
	      "use_inherit_rank": 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	object	Detailed score
- - multi_dim	object
- - - grammar	number	Grammar score Evaluation of the audio's grammer structure regardless of relevance.	Suggest to display
- - - cnt	number	Content score Measure how completely the audio covers main ideas of the reference answers.	Suggest to display
- - - flu	number	Fluency score Evaluation of the audio's fluency regardless of relevance.	Suggest to display
- - - pron	number	Pronunciation score Evaluation of the audio’s pronunciation regardless of relevance.	Suggest to display
- - keywords	object	Keywords hit node.	Suggest to display
- - - count	number	Number of keywords hit.	Suggest to display
- - - item_info	array	Hit keyword details.
- - - - char	string	Keyword or key phrase.	Suggest to display
- - - - hits	number	Number of the word or phrase hit.	Suggest to display
- - sensitivewords	object	Incorrect keywords hit node.	Suggest to display
- - - count	number	Number of incorret keywords hit.	Suggest to display
- - - item_info	array	Hit keyword details.
- - - - char	string	Keyword or key phrase.	Suggest to display
- - - - hits	number	Number of the word or phrase hit.	Suggest to display
- tips	string	Error information 1. no voice recognized 2. build network failed 3. not related english 4. Exception call 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

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