Interface PredictionPayload

prediction request payload

structure for requesting content ranking predictions. used for personalized ranking, a/b testing, and contextual bandit scenarios.

interface PredictionPayload {
    useCase: {
        uuid: string;
    };
    context: PredictionUnit;
    actions: PredictionUnit[];
    no_trace?: boolean;
}

Properties

useCase: {
    uuid: string;
}

use case configuration with uuid

context: PredictionUnit

context features (user_id, session_id, device_type, etc.)

actions: PredictionUnit[]

array of items to rank with their features

no_trace?: boolean

skip storing prediction for analytics (default: false)