Feedback Aide API Evaluation Options

Controls how the learner-facing feedback comment is worded for short response evaluations.

You would want to use these options to match the feedback to your teaching context, for example to guide learners towards the answer instead of giving it away. They change the wording of the comment only and do not affect the score.

Important Only available for shortresponse models.

Examples

// Example for evaluate endpoints that guides the learner without revealing the answer, in the third person
{
    "options": {
        "feedback": {
            "cueing": "guiding",
            "point_of_view": "third_person",
            "guidance_text": "Focus on method, keep it encouraging."
        }
    }
}

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

        options: {
            feedback: {
                cueing: "guiding",
                point_of_view: "third_person",
                guidance_text: "Focus on method, keep it encouraging."
            }
        },
    }
);

Values

Type object

Properties

• cueing string

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

• guidance_text string

  Provides free-text guidance about the wording, focus or tone of the feedback comment.

• point_of_view string

  Controls the grammatical point of view of the feedback comment.

Caveats

When the structured options (cueing and point_of_view) conflict with guidance_text, the structured options have priority.