Feedback Aide API Evaluation Options

Controls configuration options for grader annotations on the learner's response.

You would want to use this so that graders (not learners) can quickly review key components of the learner's responses such as: thesis, evidence, and citations.

Important Only available for essay models.

Examples

// Example for evaluate endpoints
{
    options: {
        "annotations": {
            "grader": {
                "thesis": true,
                "evidence": true,
                "citations": true
            }
        }
    },
}

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

        options: {
            "annotations": {
                "grader": {
                    "thesis": true,
                    "evidence": true,
                    "citations": true
                }
            }
        },
    }
);

Values

Type object

Properties

• citations boolean

  Controls whether citations in the response are highlighted with an annotation.

• evidence boolean

  Controls whether supporting evidence in the response is highlighted with an annotation.

• thesis boolean

  Controls whether the response's main thesis statement is highlighted with an annotation.