Feedback Aide API Evaluation Options

Configuration options for checking if the essay matches the required paragraph structure.

You would want to use this to ensure that responses meet the expected structural requirements in a response, which can be important for certain types of assessments or educational standards, for example.

Important Only available for essay models.

Examples

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

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

        options: {
            structure_check: {
                enabled: true,
                min_paragraphs: 3,
                min_paragraph_words: 10,
                paragraph_mode: "advanced"
            }
        },
    }
);

Values

Type object

Properties

• enabled boolean

  Controls whether to use paragraph structure checking for responses.

• min_paragraph_words integer

  Specifies the minimum number of words required to be considered as a paragraph.

• min_paragraphs integer

  Specifies the minimum number of paragraphs required in the response.

• paragraph_mode string

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