Exercises

Generate mcq format exercises

• Check the diagnostic test to see why this api is also asynchronous

• You can use this API to generate the mcq format exercises

Path: /api/v1/exercises/mcqs/

Method: POST

Payload Definition

• curriculum(required): object

  • content: string

    • We will use this content to generate test questions

  • topics: list of string

    • for which topics questions need to be generated

• grade(required): number

  • Grade of student

• level(required): number

  • The level for which the mcqs need to be generated

• demography(required): string

  • demography of student(urban,semi-urban, rural…)

• interest(required): string

  • Interests of students like sports, cooking, etc…

• generation(Mandatory): number

  • 1: The first individual in a family tree to complete at least one baccalaureate degree.

  • 2: The individual whose parents have completed at least one baccalaureate degree.

  • 3: The individual whose grandparents and parents have completed at least one baccalaureate degree.

• question_type(required): string

  • Type of question which needs to be generated. If the type of question is passed we will generate those types of questions if not it will generate a mix of questions.

• num_of_questions(Optional): number

  • A maximum of 25 mcqs can be generated

  • If the parameter is not passed we will generate the 10 questions which is the default value.

• lexemes(Optional): list of string

  • words need to be emphasized while generating the passage & questions.

Request Data

{
    “curriculum”: {
	“content”: <string>, 
	"topics": [<string>]
     },
     "grade": <number>,
     “level”: <number>,
     “demography”: <"urban" | "semi-urban" | "rural">,
     “generation”: <1 | 2>,
     "num_of_questions": <number>,
     "question_type": <“fill_in_the_blanks” | "true-false" | "phonetics" | "missing words" | "vocabulary" | "grammar">,
     "lexemes": [<string>], // comma separated string
}

Response Data

{
    "id": <mcq_exercises_id:ID>,
    "mcq_exercises_status_url": /api/v1/exercises/mcqs/<mcq_exercise_id>/status/,
    "status": “pending” | “in_progress” | “completed” | “failed”,
    "error": <string> | <None>,
    "data": <None>
}

Examples

Request Data

{
    “curriculum”: {
	“content”: "Air is all around us Lorem ipsum dorto",
	"topics": 
    },
    "grade": 1,
     “level”: 1,
     “demography”: "semi-urban",
     “generation”: “1st_generation”
     “interest”: "cartoon",
     "num_of_questions": 2,
     "question_type": “phonics",
     "lexemes": ["air", "ballon"], //comma separated string
}

Response Data

{
    "id": 1,
    "mcq_exercises_status_url": /api/v1/exercises/mcqs/<mcq_exercise_id>/status/,
    "status": “in_progress”,
    "error": <None>,
    "data": <None>
}

Check the status of the mcq exercise creation

• Use this api to poll/check the status of mcq exercise creation

Path: /api/v1/exercises/mcqs/<mcq_exercises_id>/status/

Method: GET

Request Data

{}

Response Data

{
    id: <mcq_exercises:ID>,
    mcq_exercises__status_url: /api/v1/exercises/mcqs/<mcq_exercises_id>/status/,
    status: “completed”,
    error: <None>,
    data: [
	{
	    “question”: <string>,
	    "question_type":  <“fill_in_the_blanks” | "true-false" | "phonetics" | "missing words" | "vocabulary" | "grammar">,
	    “options”: [
                {
                 "option": <string>,
                 "type": “text” | “boolean”,
                 "is_correct": <boolean>,
                },
                {
                 "option": <string>,
                 "type": “text” | “boolean”
                 "is_correct": <boolean>,
                }
                ...
     ],
}
]
}

Example

Request Data

{}

Response Data

{
  "id": 1,  
  "mcq_exercises__status_url": "/api/v1/exercises/mcqs/<mcq_exercises_id>/status/",
  "status": "complete",
  "error": null,
  "data": [
    {
      "question": "Fill in the blank: She ___ her homework.",
      "question_type": "fill_in_the_blanks",  
      "options": [
        {
          "option": "does",
          "type": "text",
          "is_correct": true,
        },
        {
          "option": "do",
          "type": "text",
          "is_correct": false,
        },
        {
          "option": "doing",
          "type": "text",
          "is_correct": false,
        },
        {
          "option": "did",
          "type": "text",
          "is_correct": false,
        }
      ]
    },
    ...
  ]
}