Feedback Aide API Evaluation Options

The relatedness level determines whether a response is considered on topic. Any responses below the selected level will be flagged as off-topic.

You would want to use this when you are certain you want to grade off-topic responses with a score of 0, for example.

When a response is marked as off-topic, no further grading will occur. The feedback will be returned as not scorable which will also improve the overall processing time.

Note The topic_check.enabled option must be set to true for this setting to take effect.

Examples

// Example for evaluate endpoints where all responses must be highly related to the topic
{
    "options": {
        "agents": {
            "content": {
                "topic_check": {
                    "enabled": true,
                    "relatedness": 3
                }
            }
        }
    }
}

// Example using the JavaScript API where all responses must be highly related to the topic
const feedbackSession = await feedbackApp.feedbackSession(
    { /* security token */ },
    {
        state: '...',
        session_uuid: '...',
        // ...

        options: {
            agents: {
                content: {
                    topic_check: {
                        enabled: true,
                        relatedness: 3
                    }
                }
            }
        },
    }
);

Values

Default 1

Type integer

Possible values

• 0 - Responses with no relation to the topic are accepted.
• 1 - Responses must be at least slightly related to the topic.
• 2 - Responses must be at least moderately related to the topic.
• 3 - Responses must be at least highly related to the topic.
• 4 - All responses must be completely on topic.

Note Setting the value to 0 will flag all responses as on topic. In this case, it is preferable to set the topic_check.enabled option to false instead and skip the check entirely.