Feedback Aide API Evaluation Options

Controls whether to retrieve the justification of score details.

You would want to use this to return the model's explanation of the score for your evaluation workflow, for example.

Note When using the JavaScript API and the createUI() method, ensure that the modules.justification_of_score_view option has a value set, for example with "grader_only", so that the justification results are rendered in the UI.

Examples

// Example for evaluate endpoints
{
    "options": {
        "agents": {
            "explainability": {
                "justification_of_score": {
                    "enabled": true
                }
            }
        }
    }
}

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

        options: {
            agents: {
                explainability: {
                    justification_of_score: {
                        enabled: true
                    }
                }
            }
        },
    }
);

Values

Default false

Type boolean