ChivoxAI

/docs

en.scne.exam

Kernel Description

A question type suitable for question and answer. Users can say the answer based on the stem or prompt content. The answer is generally no more than two sentences.
Applicable question types: situational question and answer, communication application, answering questions, answering after listening, etc.

Request Parameters

Parameters Type Required Description
coreType String true “en.scne.exam” means Semi-Open kernel.
rank int true Overall score points system, support arbitrary points system.
precision float false Rating accuracy, support 1 and 0.5. Default value is 1
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 keywords (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. There can be many possible answers and expressions.
It is recommended not to exceed two sentences for each answer.
It is recommended to fill in more than 10 answers
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.scne.exam", 
  "rank": 100, 
  "precision": 0.5, 
  "attachAudioUrl": 1,
  "keyWords": ["week"],
  "sensitiveWords": ["month"],
  "refText": {
		"lm": [
			{
				"text": "For a week. "
			},
			{
				"text": "Bill stayed for a week. "
			},
			{
				"text": "He stayed for a week. "
			},
			{
				"text": "For one week. "
			},
			{
				"text": "Bill stayed for one week. "
			},
			{
				"text": "He stayed for one week. "
			}
		]
  },
  "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
- - multi_dim object
- - - grammar int Grammar score
valuation of the grammatical structure of the user’s actual pronunciation, independent of the content of the reference answer.
Suggest to display
- - - cnt int Content score
Measure how close the content of the user's answer is to the reference answer.
Suggest to display
- - - flu int Fluency score
Evaluation of the fluency of the user's reading aloud, regardless of the content of the reference.
Suggest to display
- - - pron int Pronunciation score
The evaluation of the user’s pronunciation is not related to the content of the reference answer.
Suggest to display
- - keywords object Correct keywords hit node. Suggest to display
- - - count number Number of correct 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 Data sample
2. build network failed Data sample
3. not related english Data sample
4. Exception call 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
- 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.

SDK, API, MCP and Function Calling documentation on this site.