@butlerbot/sdk/dist/types/ai_response_v3.d.ts

The official ButlerBot SDK

import { AIToolStatusData } from "./ai_tools_v3";
import { ErrorCode } from "./error";
export type AIChatResultFail = {
    success: false;
    errorcode: ErrorCode;
};
export type AIChatResultSuccess = {
    success: true;
    response: AIResponse[];
    usage: any;
};
export type AIChatResult = AIChatResultFail | AIChatResultSuccess;
type AIChatProfileDisplayEntity = {
    name?: string;
    avatarUrl?: string;
};
export type BaseAIResponseMetadata = {
    /** The model that generated this message */
    model: string;
    /** The actual model ID that generated this message */
    modelId: string;
    /** The time when this action started (represents time of first action, meaning in streamed messages it'll hold the time the first chunk was sent) */
    firstTimestamp: number;
    /** Epoch time for when this happened (represents time of last action, meaning in streamed messages it'll hold the time the last chunk was sent) */
    timestamp: number;
};
type AIMessageResponse = {
    /** Specifies type to be a message */
    type: "message";
    payload: {
        /** Message to send to the user */
        message: string;
        /** The associated message id */
        messageId: string;
        /** Whether this message was completed */
        completed: boolean;
    };
    metadata: BaseAIResponseMetadata & {
        /** Display data for this message response, such as the author's name and profile picture */
        display?: AIChatProfileDisplayEntity;
    };
};
export type AIReasoningResponse = {
    /** Specifies type to be a reasoning update */
    type: "reasoning";
    payload: {
        /** The reasoning text */
        reasoning: string;
        /** The associated reasoning id */
        reasoningId: string;
        /** Whether this reasoning step is completed */
        completed: boolean;
    };
    metadata: BaseAIResponseMetadata;
};
export type AIFileResponse = {
    /** Specifies type to be a message */
    type: "file";
    payload: {
        /** URL location of the file */
        url?: string;
        /** Base64 representation of the file */
        base64?: string;
        /** The media type of the file */
        mediaType: string;
    };
    metadata: BaseAIResponseMetadata & {
        /** Display data for this message response, such as the author's name and profile picture */
        display?: AIChatProfileDisplayEntity;
    };
};
export type AIResponseStatusResponse = {
    /** Specifies type to be a status update for the response */
    type: "response_status";
    payload: {
        /** Whether the entire AI response is completed */
        completed: boolean;
    };
};
export type AIConvoStatusResponse = {
    /** Specifies type to be a status update for the conversation */
    type: "convo_status";
    payload: {
        /** Whether the entire AI convo has been disabled, a disabled convo cannot be restarted */
        disabled: boolean;
        /** Whether the AI convo has been stopped, a stopped convo can be restarted
         * although just because it's not stopped does not necasserily mean it's an ongoing conversation */
        stopped: boolean;
    };
};
export type AIToolResponse = {
    /** Specifies type to be a tool use status update */
    type: "tool";
    payload: {
        status: string;
        info: AIToolStatusData;
    };
    metadata: BaseAIResponseMetadata & {};
};
export type AIResponse = AIMessageResponse | AIToolResponse | AIConvoStatusResponse | AIResponseStatusResponse | AIFileResponse | AIReasoningResponse;
export {};