@botonic/plugin-hubtype-analytics/lib/esm/types.d.ts

Plugin for tracking in the Hubtype backend to see the results in the Hubtype Dashbord

export declare enum EventType {
    BotEvent = "botevent",
    WebEvent = "webevent"
}
export declare enum EventAction {
    FeedbackCase = "feedback_case",
    FeedbackMessage = "feedback_message",
    FeedbackConversation = "feedback_conversation",
    FeedbackKnowledgebase = "feedback_knowledgebase",
    FeedbackWebview = "feedback_webview",
    FlowNode = "flow_node",
    HandoffOption = "handoff_option",
    HandoffSuccess = "handoff_success",
    HandoffFail = "handoff_fail",
    Keyword = "nlu_keyword",
    Intent = "nlu_intent",
    IntentSmart = "nlu_intent_smart",
    Knowledgebase = "knowledgebase",
    Fallback = "fallback",
    WebviewStep = "webview_step",
    WebviewEnd = "webview_end",
    Custom = "custom"
}
export interface HtBaseEventProps {
    action: EventAction;
}
export interface EventFeedback extends HtBaseEventProps {
    action: EventAction.FeedbackCase | EventAction.FeedbackConversation | EventAction.FeedbackMessage | EventAction.FeedbackWebview;
    feedbackTargetId: string;
    feedbackGroupId: string;
    possibleOptions: string[];
    possibleValues?: number[];
    option: string;
    value?: number;
    comment?: string;
}
export interface EventFeedbackKnowledgebase extends HtBaseEventProps {
    action: EventAction.FeedbackKnowledgebase;
    knowledgebaseInferenceId: string;
    feedbackBotInteractionId: string;
    feedbackTargetId: string;
    feedbackGroupId: string;
    possibleOptions: string[];
    possibleValues?: number[];
    option: string;
    value?: number;
    comment?: string;
}
export interface EventFlow extends HtBaseEventProps {
    action: EventAction.FlowNode;
    flowThreadId: string;
    flowId: string;
    flowName: string;
    flowNodeId: string;
    flowNodeContentId: string;
    flowNodeIsMeaningful?: boolean;
}
export interface EventHandoff extends HtBaseEventProps {
    action: EventAction.HandoffSuccess | EventAction.HandoffFail;
    flowThreadId?: string;
    queueId: string;
    queueName: string;
    caseId?: string;
    isQueueOpen?: boolean;
    isAvailableAgent?: boolean;
    isThresholdReached?: boolean;
}
export interface EventHandoffOption extends HtBaseEventProps {
    action: EventAction.HandoffOption;
    flowThreadId?: string;
    queueId?: string;
    queueName?: string;
}
export interface EventIntent extends HtBaseEventProps {
    action: EventAction.Intent;
    flowThreadId: string;
    flowId: string;
    flowNodeId: string;
    nluIntentLabel: string;
    nluIntentConfidence: number;
    nluIntentThreshold: number;
    nluIntentMessageId: string;
    userInput: string;
}
export interface EventKeyword extends HtBaseEventProps {
    action: EventAction.Keyword;
    flowThreadId: string;
    flowId: string;
    flowNodeId: string;
    nluKeywordName: string;
    nluKeywordIsRegex?: boolean;
    nluKeywordMessageId: string;
    userInput: string;
}
export interface EventIntentSmart extends HtBaseEventProps {
    action: EventAction.IntentSmart;
    flowThreadId: string;
    flowId: string;
    flowNodeId: string;
    nluIntentSmartTitle: string;
    nluIntentSmartNumUsed: number;
    nluIntentSmartMessageId: string;
    userInput: string;
}
export interface EventKnowledgeBase extends HtBaseEventProps {
    action: EventAction.Knowledgebase;
    flowThreadId: string;
    flowId: string;
    flowNodeId: string;
    knowledgebaseInferenceId: string;
    knowledgebaseFailReason?: KnowledgebaseFailReason;
    knowledgebaseSourcesIds: string[];
    knowledgebaseChunksIds: string[];
    knowledgebaseMessageId: string;
    userInput: string;
}
export declare enum KnowledgebaseFailReason {
    NoKnowledge = "no_knowledge",
    Hallucination = "hallucination"
}
export interface EventFallback extends HtBaseEventProps {
    action: EventAction.Fallback;
    userInput: string;
    fallbackOut: number;
    fallbackMessageId: string;
}
export interface EventWebviewStep extends HtBaseEventProps {
    action: EventAction.WebviewStep;
    flowThreadId?: string;
    webviewThreadId: string;
    webviewName: string;
    webviewStepName: string;
    webviewStepNumber: number;
}
export interface EventWebviewEnd extends HtBaseEventProps {
    action: EventAction.WebviewEnd;
    flowThreadId?: string;
    webviewThreadId: string;
    webviewName: string;
    webviewStepName?: string;
    webviewStepNumber?: number;
    webviewEndFailType?: WebviewEndFailType;
    webviewEndFailMessage?: string;
}
export declare enum WebviewEndFailType {
    CanceledByUser = "canceled_by_user",
    ApiError = "api_error",
    NeedsEscalation = "needs_escalation"
}
export interface EventCustom extends HtBaseEventProps {
    action: EventAction.Custom;
    customFields?: Record<string, any>;
    customSensitiveFields?: Record<string, any>;
}
export type HtEventProps = EventFeedback | EventFeedbackKnowledgebase | EventFlow | EventHandoff | EventHandoffOption | EventIntent | EventKeyword | EventIntentSmart | EventKnowledgeBase | EventFallback | EventWebviewStep | EventWebviewEnd | EventCustom;
export interface RequestData {
    userId?: string;
    botInteractionId: string;
    userLocale: string;
    userCountry: string;
    systemLocale: string;
}