Feedback Aide API Evaluation Options

Controls whether the feedback comment reveals the correct answer or only guides the learner towards it.

You would want to guide learners when they should work out the answer themselves, for example in formative practice, and reveal the answer when they should be told what a correct response contains.

When guiding, the comment asks short guiding questions and does not state, quote, paraphrase or confirm the correct answer, even when the learner response is fully correct.

Examples

// Example for evaluate endpoints where the comment states the correct response
{
    "options": {
        "feedback": {
            "cueing": "reveal"
        }
    }
}

// Example using the JavaScript API where the comment states the correct response
const feedbackSession = await feedbackApp.feedbackSession(
    { /* security token */ },
    {
        state: '...',
        session_uuid: '...',
        // ...

        options: {
            feedback: {
                cueing: "reveal"
            }
        },
    }
);

Values

Default "guiding"

Type string

Possible values

• "guiding" - Guides the learner towards the answer without revealing it.
• "reveal" - States the correct response when something is missing or wrong.

Caveats

For the sr-xfromy rubric type with "guiding", the comment can acknowledge the valid points the learner has made, but does not supply any missing valid points.