Feedback Aide API Evaluation Options

Controls whether supporting evidence in the response is highlighted with an annotation.

You would want to use this to automatically highlight all supporting evidence used in the provided response.

Evidence refers to the primary forms of support used to substantiate a claim. This may include facts, statistics, anecdotes, scenarios, case examples, textual references, quotations, and other verifiable information.

Examples

// Example for evaluate endpoints
{
    "options": {
        "annotations": {
            "evidence": true,
        }
    }
}

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

        options: {
            "annotations": {
                "evidence": true,
            }
        },
    }
);

Values

Default false

Type boolean