@mi-gpt/engine/dist/base.d.ts

MiGPT 核心模块

import { IMessage } from '@mi-gpt/chat';
import { StreamResponse } from '@mi-gpt/stream';

interface IReply {
    /**
     * 文字回复
     */
    text?: string;
    /**
     * 音频链接
     */
    url?: string;
    /**
     * 流式响应
     */
    stream?: StreamResponse;
    /**
     * 已经处理过用户的消息了，不再走默认的处理逻辑
     */
    handled?: boolean;
    /**
     * 使用默认的消息处理逻辑
     */
    default?: boolean;
}
interface ISpeaker {
    /**
     * 中断原来小爱的运行
     */
    abortXiaoAI: () => Promise<boolean>;
    /**
     * 播放文字、音频链接
     */
    play: ({ text, url, }: {
        text?: string;
        url?: string;
        bytes?: Uint8Array;
        /**
         * 超时时长（毫秒）
         *
         * 默认 10 分钟
         */
        timeout?: number;
        /**
         * 是否阻塞运行(仅对播放文字、音频链接有效)
         *
         * 如果是则等到音频播放完毕才会返回
         */
        blocking?: boolean;
    }) => Promise<boolean>;
}
declare abstract class BaseEngine {
    status: 'running' | 'stopped';
    abstract config: Record<string, any>;
    abstract speaker: ISpeaker;
    abstract start(config: this['config']): Promise<void>;
    abstract stop(): Promise<void>;
    abstract onMessage(msg: IMessage): Promise<void>;
    abstract askAI(msg: IMessage): Promise<IReply>;
}

export { BaseEngine, type IReply, type ISpeaker };