funda-ui/Chatbox/index.d.ts

React components using pure Bootstrap 5+ which does not contain any external style and script libraries.

import React from "react";
export interface CustomMethod {
    name: string;
    func: (...args: any[]) => any;
}
export declare type MessageDetail = {
    sender: string;
    timestamp: string;
    content: string;
    tag: string;
};
export declare type QuestionData = {
    title: string;
    list: Array<string>;
};
export declare type SelectedOption = {
    [key: string]: string | number;
    curIndex: number;
    curValue: string;
};
export interface FloatingButton {
    label: string;
    value: string;
    onClick: string;
    active?: boolean;
    isSelect?: boolean;
    dynamicOptions?: boolean;
    defaultSelected?: number;
    [key: string]: any;
}
export interface FloatingButtonSelectOption {
    label: string;
    value: string;
    onClick: string;
}
export interface RequestConfig {
    apiUrl: string;
    requestBody: string;
    responseExtractor: string;
}
export declare type CustomRequestConfig = {
    requestBody: any;
    apiUrl: string;
    headers: any;
};
export declare type CustomRequestResponse = {
    content: string | Response | null;
    isStream: boolean;
};
export declare type CustomRequestFunction = (message: string, config: CustomRequestConfig, customMethods: CustomMethod[], conversationHistory: MessageDetail[]) => Promise<CustomRequestResponse>;
export declare type VoiceConfig = {
    enableVoiceInput: boolean;
    holdToTalk?: boolean;
    voiceInputAppId?: string;
    voiceInputApiKey?: string;
    voiceInputApiSecret?: string;
    voiceInputSampleRate?: number;
    voiceInputFormat?: string;
    voiceInputEncoding?: string;
    voiceInputHost?: string;
    voiceInputPath?: string;
    voiceInputProtocol?: string;
    voiceInputHmacAlgorithm?: string;
    voiceInputHashAlgorithm?: string;
    voiceInputUrlTemplate?: string;
    voiceInputRequestBodyTemplate?: string;
    voiceInputAudioBodyTemplate?: string;
    voiceInputUuid?: string;
    voiceInputLang?: string;
    voiceInputUtc?: string;
    voiceResponseExtractor?: string;
    voiceInputIdleTimeoutSeconds?: number;
    voiceInputEndTimeoutSeconds?: number;
    generateVoiceSignature?: (params: {
        host: string;
        path: string;
        date: string;
        apiKey: string;
        apiSecret: string;
    }) => string | Promise<string>;
    onVoiceInputStart?: () => void;
    onVoiceInputEnd?: (text: string) => void;
    onVoiceInputError?: (error: Error) => void;
    onVoiceInputInterrupt?: () => void;
};
export declare type ChatboxProps = {
    debug?: boolean;
    defaultRows?: number;
    prefix?: string;
    contentRef?: React.RefObject<any>;
    model?: string;
    baseUrl?: string;
    apiKey?: string;
    token?: string | (() => string);
    defaultMessages?: MessageDetail[];
    verbose?: boolean;
    reasoningSwitchLabel?: string;
    stopLabel?: React.ReactNode;
    questionName?: React.ReactNode;
    answerName?: React.ReactNode;
    questionNameIcon?: string;
    answerNameIcon?: string;
    bubble?: boolean;
    bubbleLabel?: string;
    sendLabel?: string;
    sendLoading?: boolean;
    sendLoadingLabel?: string;
    copyLabel?: string;
    closeLabel?: string;
    placeholder?: string;
    noDataPlaceholder?: string;
    requestConfig: RequestConfig;
    headerConfig?: any;
    maxHistoryLength?: number;
    contextData?: Record<string, any>;
    toolkitButtons?: FloatingButton[];
    newChatButton?: FloatingButton;
    customMethods?: CustomMethod[];
    defaultQuestions?: QuestionData;
    showCopyBtn?: boolean;
    autoCopyReply?: boolean;
    usePopUp?: boolean;
    customRequest?: CustomRequestFunction;
    renderParser?: (input: string) => Promise<string>;
    requestBodyFormatter?: (body: any, contextData: Record<string, any>, conversationHistory: MessageDetail[]) => Promise<Record<string, any>>;
    copiedContentFormatter?: (string: string) => string;
    nameFormatter?: (input: string) => string;
    onCopyCallback?: (res: Record<string, any>) => void;
    onQuestionClick?: (text: string, methods: Record<string, Function>) => void;
    onInputChange?: (controlRef: React.RefObject<any>, val: string) => any;
    onInputCallback?: (input: string) => Promise<string>;
    onChunk?: (controlRef: React.RefObject<any>, lastContent: string, conversationHistory: MessageDetail[]) => any;
    onComplete?: (controlRef: React.RefObject<any>, lastContent: string, conversationHistory: MessageDetail[]) => any;
    voiceConfig?: VoiceConfig;
};
declare const Chatbox: (props: ChatboxProps) => JSX.Element;
export default Chatbox;