Feedback Aide API Evaluation Options

Specifies how the system identifies and separates paragraphs in the essay.

You would want to use this to choose the most appropriate method for paragraph detection based on the expected formatting of responses. For example, using the advanced mode for more complex essays where paragraphs may not be clearly separated by newlines or paragraph tags.

Examples

// Example for evaluate endpoints
{
    "options": {
        "structure_check": {
            "enabled": true,
            "paragraph_mode": "advanced"
        }
    }
}

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

        options: {
            structure_check: {
                enabled: true,
                paragraph_mode: "advanced"
            }
        },
    }
);

Values

Default "simple"

Type string

Possible values

• "simple" - splits the document structure based on newline characters or HTML paragraph tags.
• "advanced" - uses AI to separate paragraphs.