Feedback Aide API Evaluation Options

Controls configuration options for text-highlighting based annotations on the learner's response.

You would want to use this feature to support graders by generating AI-driven annotations.

Important Only available for essay models.

Examples

// Example for evaluate endpoints
{
    "options": {
        "agents": {
            "explainability": {
                "grader_annotations": {
                    "thesis": true,
                    "evidence": true,
                    "citations": true
                }
            }
        }
    }
}

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

        options: {
            agents: {
                explainability: {
                    grader_annotations: {
                        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.