Feedback Aide API Evaluation Options

Controls whether citations in the response are highlighted with an annotation.

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

In-text citations are references to external sources that appear directly within the body of a response.

The comment for these annotations will be a copy of the full reference if it exists later in the response.

Examples

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

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

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

Values

Default false

Type boolean