Interface UserFeedbackPayload

Defines the structure for user-provided feedback on a GMI's performance or a specific message. This feedback is crucial for the GMI's adaptive learning capabilities and for system analytics.

Interface

UserFeedbackPayload

interface UserFeedbackPayload {
    rating?: "positive" | "negative" | "neutral";
    score?: number;
    text?: string;
    tags?: string[];
    correctedContent?: string;
    targetMessageId?: string;
    customData?: Record<string, any>;
}

Properties

rating? score? text? tags? correctedContent? targetMessageId? customData?

Properties

Optional rating

rating?: "positive" | "negative" | "neutral"

Polarity label. When set, it decides the polarity even if score disagrees.

Optional score

score?: number

Numeric rating on a 1 to 5 scale, read when rating is absent: 4 and above is positive, 2 and below is negative, anything in between is neutral.

Optional text

text?: string

Free-text comment. Stored in the user's cognitive memory when configured.

Optional tags

tags?: string[]

Optional correctedContent

correctedContent?: string

The answer the user says the assistant should have given. Stored as a semantic memory of the user so later turns can recall it.

Optional targetMessageId

targetMessageId?: string

Identifier of the message the feedback refers to.

Optional customData

customData?: Record<string, any>

Settings

Member Visibility

Theme

On This Page

ratingscoretexttagscorrectedContenttargetMessageIdcustomData