Feedback Aide API Evaluation Options

Checks if the essay is on a topic related to the question.

Important Only available for essay models.

Examples

// Example for evaluate endpoints
{
    "options": {
        "topic_check": {
            "enabled": true,
            "relatedness": 4
        }
    }
}

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

        options: {
            topic_check: {
                enabled: true,
                relatedness: 4
            }
        },
    }
);

Values

Type object

Properties

• enabled boolean

  Controls whether the topic checking functionality should be used.

• relatedness integer

  The relatedness level determines whether an essay is considered on topic.