@zhengxs/wechaty-plugin-assistant/dist-types/interfaces/options.d.ts

基于 wechaty 的聊天助手插件

import { MemoryCache } from './cache';
import { ConversationContext } from './context';
import { ChatModel } from './llm';
import { PluginObject } from './plugin';
import { MaybePromise } from './typescript';

type AssistantConfigBase = {
    /**
     * 是否开启调试模式
     */
    debug?: boolean;
    /**
     * 是否开启测试模式
     */
    testing?: boolean;
    /**
     * 大语言模型
     */
    llm: ChatModel;
    /**
     * 缓存
     */
    cache?: MemoryCache;
    /**
     * 禁用过期检测
     */
    disabledOutdatedDetection?: boolean;
    /**
     * 输出帮助信息
     */
    help?: (ctx: ConversationContext) => MaybePromise<void>;
    /**
     * 维护者列表
     */
    maintainers?: string[];
};
export type AssistantConfig = AssistantConfigBase & Omit<PluginObject, 'name'>;
export type AssistantOptions = Required<AssistantConfigBase> & Omit<PluginObject, 'name'>;
export {};