Feedback Aide API Evaluation Options

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

You would want to use this to steer the emphasis of the comment, for example to focus on method or to keep the tone encouraging.

The text only influences the wording of the comment. It cannot change the score or how the rubric is applied.

Examples

// Example for evaluate endpoints where the comment focuses on method and stays encouraging
{
    "options": {
        "feedback": {
            "guidance_text": "Focus on method, keep it encouraging."
        }
    }
}

// Example using the JavaScript API where the comment focuses on method and stays encouraging
const feedbackSession = await feedbackApp.feedbackSession(
    { /* security token */ },
    {
        state: '...',
        session_uuid: '...',
        // ...

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

Values

Default null

Type string

A string of up to 2000 characters.

Caveats

The cueing and point_of_view options have priority over this option when they conflict.