@opentiny/tiny-robot-kit 0.4.0-alpha.0 → 0.4.0-alpha.1

package/dist/index.d.mts

@@ -1,482 +1,369 @@
-import { Ref, Reactive } from 'vue';
+import { Ref, ComputedRef } from 'vue';
 
-/**
- * 模型Provider基类
- */
-declare abstract class BaseModelProvider {
-    protected config: AIModelConfig;
-    /**
-     * @param config AI模型配置
-     */
-    constructor(config: AIModelConfig);
-    /**
-     * 发送聊天请求并获取响应
-     * @param request 聊天请求参数
-     * @returns 聊天响应
-     */
-    abstract chat(request: ChatCompletionRequest): Promise<ChatCompletionResponse>;
-    /**
-     * 发送流式聊天请求并通过处理器处理响应
-     * @param request 聊天请求参数
-     * @param handler 流式响应处理器
-     */
-    abstract chatStream(request: ChatCompletionRequest, handler: StreamHandler): Promise<void>;
-    /**
-     * 更新配置
-     * @param config 新的AI模型配置
-     */
-    updateConfig(config: AIModelConfig): void;
-    /**
-     * 获取当前配置
-     * @returns AI模型配置
-     */
-    getConfig(): AIModelConfig;
-    /**
-     * 验证请求参数
-     * @param request 聊天请求参数
-     */
-    protected validateRequest(request: ChatCompletionRequest): void;
-}
+type MaybePromise<T> = T | Promise<T>;
 
 /**
- * 消息角色类型
- */
-type MessageRole = 'system' | 'user' | 'assistant';
-/**
- * 聊天消息接口
- */
-interface ChatMessage {
-    role: MessageRole;
-    content: string | {
-        type: string;
-        [x: string]: unknown;
-    }[];
-    name?: string;
-    [x: string]: unknown;
-}
-/**
- * 聊天历史记录
- */
-type ChatHistory = ChatMessage[];
-/**
- * 聊天完成请求选项
+ * 工具函数模块
+ * 提供一些实用的辅助函数
  */
-interface ChatCompletionOptions {
-    model?: string;
-    temperature?: number;
-    top_p?: number;
-    n?: number;
-    stream?: boolean;
-    max_tokens?: number;
+
+declare function createSSEStreamGenerator<T = any>(response: Response, options?: {
     signal?: AbortSignal;
+}): AsyncGenerator<T, void, unknown>;
+
+interface Tool {
+    type: 'function';
+    function: {
+        name: string;
+        description: string;
+        /**
+         * function 的输入参数，以 JSON Schema 对象描述
+         */
+        parameters: any;
+    };
+    [key: string]: any;
 }
-/**
- * 聊天完成请求参数
- */
-interface ChatCompletionRequest {
-    messages: ChatMessage[];
-    options?: ChatCompletionOptions;
+interface MessageMetadata {
+    createdAt?: number;
+    updatedAt?: number;
+    id?: string;
+    model?: string;
+    [key: string]: any;
 }
-/**
- * 聊天完成响应消息
- */
-interface ChatCompletionResponseMessage {
-    role: MessageRole;
+interface ChatMessage {
+    role: string;
     content: string;
-    [x: string]: unknown;
+    metadata?: MessageMetadata;
+    tool_calls?: ToolCall[];
+    tool_call_id?: string;
+    [key: string]: any;
+    [key: symbol]: any;
 }
-/**
- * 聊天完成响应选择
- */
-interface ChatCompletionResponseChoice {
+interface MessageRequestBody {
+    messages: Partial<ChatMessage>[];
+    [key: string]: any;
+}
+type RequestState = 'idle' | 'processing' | 'completed' | 'aborted' | 'error';
+type RequestProcessingState = 'requesting' | 'completing' | string;
+interface ToolCall {
     index: number;
-    message: ChatCompletionResponseMessage;
-    finish_reason: string;
+    id: string;
+    type: 'function';
+    function: {
+        name: string;
+        arguments: string;
+        result?: string;
+    };
 }
-/**
- * 聊天完成响应使用情况
- */
-interface ChatCompletionResponseUsage {
+interface Usage {
     prompt_tokens: number;
     completion_tokens: number;
     total_tokens: number;
+    prompt_tokens_details?: {
+        cached_tokens: number;
+    };
+    prompt_cache_hit_tokens?: number;
+    prompt_cache_miss_tokens?: number;
 }
-/**
- * 聊天完成响应
- */
-interface ChatCompletionResponse {
-    id: string;
-    object: string;
-    created: number;
-    model: string;
-    choices: ChatCompletionResponseChoice[];
-    usage: ChatCompletionResponseUsage;
-}
-/**
- * 流式聊天完成响应增量
- */
-interface ChatCompletionStreamResponseDelta {
-    content?: string;
-    role?: MessageRole;
-    [x: string]: unknown;
+interface Choice {
+    index: number;
+    message: {
+        role: string;
+        content?: string;
+        tool_calls?: ToolCall[];
+        [key: string]: any;
+    };
+    delta: undefined;
+    logprobs: any;
+    finish_reason: string | null;
 }
-/**
- * 流式聊天完成响应选择
- */
-interface ChatCompletionStreamResponseChoice {
+interface DeltaChoice {
     index: number;
-    delta: ChatCompletionStreamResponseDelta;
+    message: undefined;
+    delta: {
+        role?: string;
+        content?: string;
+        tool_calls?: ToolCall[];
+        [key: string]: any;
+    };
+    logprobs: any;
     finish_reason: string | null;
 }
-/**
- * 流式聊天完成响应
- */
-interface ChatCompletionStreamResponse {
+type CompletionChoice = Choice | DeltaChoice;
+interface ChatCompletion {
     id: string;
     object: string;
     created: number;
     model: string;
-    choices: ChatCompletionStreamResponseChoice[];
+    system_fingerprint: string | null;
+    choices: CompletionChoice[];
+    usage?: Usage;
 }
-/**
- * AI模型提供商类型
- */
-type AIProvider = 'openai' | 'deepseek' | 'custom';
-/**
- * AI模型配置接口
- */
-interface AIModelConfig {
-    provider: AIProvider;
-    providerImplementation?: BaseModelProvider;
-    apiKey?: string;
-    apiUrl?: string;
-    apiVersion?: string;
-    defaultModel?: string;
-    defaultOptions?: ChatCompletionOptions;
-}
-/**
- * 错误类型
- */
-declare enum ErrorType {
-    NETWORK_ERROR = "network_error",
-    AUTHENTICATION_ERROR = "authentication_error",
-    RATE_LIMIT_ERROR = "rate_limit_error",
-    SERVER_ERROR = "server_error",
-    MODEL_ERROR = "model_error",
-    TIMEOUT_ERROR = "timeout_error",
-    UNKNOWN_ERROR = "unknown_error"
-}
-/**
- * AI适配器错误
- */
-interface AIAdapterError {
-    type: ErrorType;
-    message: string;
-    statusCode?: number;
-    originalError?: object;
-}
-/**
- * 流式响应事件类型
- */
-declare enum StreamEventType {
-    DATA = "data",
-    ERROR = "error",
-    DONE = "done"
+interface UseMessageOptions {
+    initialMessages?: ChatMessage[];
+    requestMessageFields?: (keyof ChatMessage)[];
+    plugins?: UseMessagePlugin[];
+    responseProvider: <T = ChatCompletion>(requestBody: MessageRequestBody, abortSignal: AbortSignal) => Promise<T> | AsyncGenerator<T> | Promise<AsyncGenerator<T>>;
+    /**
+     * 全局的数据块处理钩子，在接收到每个响应数据块时触发。
+     * 注意：此钩子与插件中的 onCompletionChunk 有区别。
+     * 如果传入了此参数，默认的 chunk 处理逻辑不会自动执行，需要手动调用 runDefault 来执行默认处理逻辑。
+     */
+    onCompletionChunk?: (context: BasePluginContext & {
+        currentMessage: ChatMessage;
+        chunk: ChatCompletion;
+    }, runDefault: () => void) => void;
 }
-/**
- * 流式响应处理器
- */
-interface StreamHandler {
-    onData: (data: ChatCompletionStreamResponse) => void;
-    onError: (error: AIAdapterError) => void;
-    onDone: (finishReason?: string) => void;
+interface UseMessageReturn {
+    requestState: Ref<RequestState>;
+    processingState: Ref<RequestProcessingState | undefined>;
+    messages: Ref<ChatMessage[]>;
+    responseProvider: Ref<UseMessageOptions['responseProvider']>;
+    isProcessing: ComputedRef<boolean>;
+    sendMessage: (content: string) => Promise<void>;
+    send: (...msgs: ChatMessage[]) => Promise<void>;
+    abortRequest: () => Promise<void>;
 }
-
-/**
- * AI客户端类
- * 负责根据配置选择合适的提供商并处理请求
- */
-
-/**
- * AI客户端类
- */
-declare class AIClient {
-    private provider;
-    private config;
+interface BasePluginContext {
+    messages: ChatMessage[];
+    currentTurn: ChatMessage[];
+    requestState: RequestState;
+    processingState?: RequestProcessingState;
+    requestMessageFields: (keyof ChatMessage)[];
+    plugins: UseMessagePlugin[];
+    setRequestState: (state: RequestState, processingState?: RequestProcessingState) => void;
+    abortSignal: AbortSignal;
     /**
-     * 构造函数
-     * @param config AI模型配置
+     * Custom context data that can be set by plugins
      */
-    constructor(config: AIModelConfig);
+    customContext: Record<string, unknown>;
     /**
-     * 创建提供商实例
-     * @param config AI模型配置
-     * @returns 提供商实例
+     * Set custom context data. Can be used to store plugin-specific data that needs to be shared across hooks.
      */
-    private createProvider;
+    setCustomContext: (data: Record<string, unknown>) => void;
+}
+interface UseMessagePlugin {
     /**
-     * 发送聊天请求并获取响应
-     * @param request 聊天请求参数
-     * @returns 聊天响应
+     * 插件名称。
      */
-    chat(request: ChatCompletionRequest): Promise<ChatCompletionResponse>;
+    name?: string;
     /**
-     * 发送流式聊天请求并通过处理器处理响应
-     * @param request 聊天请求参数
-     * @param handler 流式响应处理器
+     * 是否禁用插件。useMessage 可能会内置一些默认插件，如果需要禁用，可以设置为 true。
      */
-    chatStream(request: ChatCompletionRequest, handler: StreamHandler): Promise<void>;
+    disabled?: boolean;
     /**
-     * 获取当前配置
-     * @returns AI模型配置
+     * 一次对话回合（turn）开始钩子：用户消息入队后、正式发起请求之前触发。
+     * 按插件注册顺序串行执行，便于做有序初始化/校验；出错则中断流程。
      */
-    getConfig(): AIModelConfig;
+    onTurnStart?: (context: BasePluginContext) => MaybePromise<void>;
     /**
-     * 更新配置
-     * @param config 新的AI模型配置
+     * 一次对话回合（turn）结束的生命周期钩子。
+     * 触发时机：本轮对话完成（成功、被中止）后
+     * 执行策略：按插件注册顺序串行执行，有错误则中断流程
      */
-    updateConfig(config: Partial<AIModelConfig>): void;
-}
-
-/**
- * OpenAI提供商
- * 用于与OpenAI API进行交互
- */
-
-declare class OpenAIProvider extends BaseModelProvider {
-    private baseURL;
-    private apiKey;
-    private defaultModel;
+    onTurnEnd?: (context: BasePluginContext) => MaybePromise<void>;
     /**
-     * @param config AI模型配置
+     * 请求开始前的生命周期钩子。
+     * 触发时机：已组装 requestBody，正式发起请求之前。
+     * 执行策略：按插件注册顺序串行执行，避免并发修改 requestBody 产生冲突。
+     * 用途：增补 tools、注入上下文参数、进行参数校验等。
      */
-    constructor(config: AIModelConfig);
+    onBeforeRequest?: (context: BasePluginContext & {
+        requestBody: MessageRequestBody;
+    }) => MaybePromise<void>;
     /**
-     * 发送聊天请求并获取响应
-     * @param request 聊天请求参数
-     * @returns 聊天响应
+     * 请求完成后的生命周期钩子（如收到 AI 响应或需要处理 tool_calls 等）。
+     * 触发时机：本次请求（含流式）结束后。
+     * 执行策略：并行执行（Promise.all），各插件通过 appendMessage 追加消息。
      */
-    chat(request: ChatCompletionRequest): Promise<ChatCompletionResponse>;
+    onAfterRequest?: (context: BasePluginContext & {
+        currentMessage: ChatMessage;
+        lastChoice?: CompletionChoice;
+        appendMessage: (message: ChatMessage | ChatMessage[]) => void;
+        requestNext: () => void;
+    }) => MaybePromise<void>;
     /**
-     * 发送流式聊天请求并通过处理器处理响应
-     * @param request 聊天请求参数
-     * @param handler 流式响应处理器
+     * 数据块处理钩子，在接收到每个响应数据块时触发。
+     * 无论是流式响应（多个增量数据块）还是非流式响应（单个完整数据块），都会触发此钩子。
+     * 用途：自定义增量合并、实时 UI 效果等。
      */
-    chatStream(request: ChatCompletionRequest, handler: StreamHandler): Promise<void>;
-    /**
-     * 更新配置
-     * @param config 新的AI模型配置
-     */
-    updateConfig(config: AIModelConfig): void;
+    onCompletionChunk?: (context: BasePluginContext & {
+        currentMessage: ChatMessage;
+        choice?: CompletionChoice;
+        chunk: ChatCompletion;
+    }) => void;
+    onError?: (context: BasePluginContext & {
+        error: unknown;
+    }) => void;
 }
 
-/**
- * 工具函数模块
- * 提供一些实用的辅助函数
- */
-
-/**
- * 处理SSE流式响应
- * @param response fetch响应对象
- * @param handler 流处理器
- */
-declare function handleSSEStream(response: Response, handler: StreamHandler, signal?: AbortSignal): Promise<void>;
-/**
- * 格式化消息
- * 将各种格式的消息转换为标准的ChatMessage格式
- * @param messages 消息数组
- * @returns 标准格式的消息数组
- */
-declare function formatMessages(messages: Array<ChatMessage | string>): ChatMessage[];
-/**
- * 从响应中提取文本内容
- * @param response 聊天完成响应
- * @returns 文本内容
- */
-declare function extractTextFromResponse(response: ChatCompletionResponse): string;
-
-/**
- * useMessage composable
- * 提供消息管理和状态控制功能
- */
-
-declare enum STATUS {
-    INIT = "init",// 初始状态
-    PROCESSING = "processing",// AI请求正在处理中, 还未响应，显示加载动画
-    STREAMING = "streaming",// 流式响应中分块数据返回中
-    FINISHED = "finished",// AI请求已完成
-    ABORTED = "aborted",// 用户中止请求
-    ERROR = "error"
-}
-declare const GeneratingStatus: STATUS[];
-declare const FinalStatus: STATUS[];
-/**
- * 消息状态接口
- */
-interface MessageState {
-    status: STATUS;
-    errorMsg: string | null;
-}
-/**
- * useMessage选项接口
- */
-interface UseMessageOptions {
-    /** AI客户端实例 */
-    client: AIClient;
-    /** 是否默认使用流式响应 */
-    useStreamByDefault?: boolean;
-    /** 错误消息模板 */
-    errorMessage?: string;
-    /** 初始消息列表 */
-    initialMessages?: ChatMessage[];
-    events?: {
-        onReceiveData?: <T = any>(data: T, messages: Ref<ChatMessage[]>, preventDefault: () => void) => void;
-        onFinish?: (finishReason: string | undefined, context: {
-            messages: Ref<ChatMessage[]>;
-            messageState: Reactive<MessageState>;
-        }, preventDefault: () => void) => void;
-    };
-}
-/**
- * useMessage返回值接口
- */
-interface UseMessageReturn {
-    messages: Ref<ChatMessage[]>;
-    /** 消息状态 */
-    messageState: Reactive<MessageState>;
-    /** 输入消息 */
-    inputMessage: Ref<string>;
-    /** 是否使用流式响应 */
-    useStream: Ref<boolean>;
-    /** 发送消息 */
-    sendMessage: (content?: ChatMessage['content'], clearInput?: boolean) => Promise<void>;
-    /** 手动执行addMessage添加消息后，可以执行send发送消息 */
-    send: () => Promise<void>;
-    /** 清空消息 */
-    clearMessages: () => void;
-    /** 添加消息 */
-    addMessage: (message: ChatMessage | ChatMessage[]) => void;
-    /** 中止请求 */
-    abortRequest: () => void;
-    /** 重试请求 */
-    retryRequest: (msgIndex: number) => Promise<void>;
-}
-/**
- * useMessage composable
- * 提供消息管理和状态控制功能
- *
- * @param options useMessage选项
- * @returns UseMessageReturn
- */
-declare function useMessage(options: UseMessageOptions): UseMessageReturn;
-
-/**
- * useConversation composable
- * 提供会话管理和持久化功能
- */
-
-/**
- * 会话接口
- */
-interface Conversation {
+interface ConversationInfo {
     /** 会话ID */
     id: string;
     /** 会话标题 */
-    title: string;
+    title?: string;
     /** 创建时间 */
     createdAt: number;
     /** 更新时间 */
     updatedAt: number;
     /** 自定义元数据 */
     metadata?: Record<string, unknown>;
-    /** 会话消息 */
-    messages: ChatMessage[];
-}
-/**
- * 存储策略接口
- */
-interface ConversationStorageStrategy {
-    /** 保存会话列表 */
-    saveConversations: (conversations: Conversation[]) => Promise<void> | void;
-    /** 加载会话列表 */
-    loadConversations: () => Promise<Conversation[]> | Conversation[];
 }
-/**
- * 本地存储策略
- */
-declare class LocalStorageStrategy implements ConversationStorageStrategy {
-    private storageKey;
-    constructor(storageKey?: string);
-    saveConversations(conversations: Conversation[]): void;
-    loadConversations(): Conversation[];
+interface Conversation extends ConversationInfo {
+    /**
+     * Message engine instance created by useMessage.
+     */
+    engine: UseMessageReturn;
 }
-/**
- * 会话状态接口
- */
-interface ConversationState {
-    /** 会话列表 */
-    conversations: Conversation[];
-    /** 当前会话ID */
-    currentId: string | null;
-    /** 是否正在加载 */
-    loading: boolean;
+interface ConversationStorageStrategy {
+    /**
+     * Load all conversations (id and title only).
+     */
+    loadConversations?: () => MaybePromise<ConversationInfo[]>;
+    /**
+     * Load all messages for a given conversation.
+     */
+    loadMessages?: (conversationId: string) => MaybePromise<ChatMessage[]>;
+    /**
+     * Persist conversation metadata (create or update).
+     */
+    saveConversation?: (conversation: ConversationInfo) => MaybePromise<void>;
+    /**
+     * Persist messages for a given conversation.
+     */
+    saveMessages?: (conversationId: string, messages: ChatMessage[]) => MaybePromise<void>;
+    /**
+     * Optional method to delete a conversation and its messages.
+     */
+    deleteConversation?: (conversationId: string) => MaybePromise<void>;
 }
-type UseConversationEvents = UseMessageOptions['events'] & {
-    onLoaded?: (conversations: Conversation[]) => void;
-};
-/**
- * useConversation选项接口
- */
 interface UseConversationOptions {
-    /** AI客户端实例 */
-    client: AIClient;
-    /** 存储策略 */
+    /**
+     * Base useMessage options for all conversations.
+     * Per-conversation options passed to createConversation will be merged on top of this.
+     */
+    useMessageOptions: UseMessageOptions;
+    /**
+     * Whether to automatically save messages when they are changed.
+     * @default false
+     */
+    autoSaveMessages?: boolean;
+    /**
+     * Throttle time in milliseconds for auto-save operations.
+     * Ensures messages are saved at most once per this interval during streaming updates.
+     * Only effective when autoSaveMessages is true.
+     * @default 1000
+     */
+    autoSaveThrottle?: number;
+    /**
+     * Optional storage strategy for conversations and messages.
+     * When provided, conversation list and messages can be loaded and persisted.
+     */
     storage?: ConversationStorageStrategy;
-    /** 是否自动保存 */
-    autoSave?: boolean;
-    /** 是否允许空会话 */
-    allowEmpty?: boolean;
-    /** 是否默认使用流式响应 */
-    useStreamByDefault?: boolean;
-    /** 错误消息模板 */
-    errorMessage?: string;
-    /** 事件回调 */
-    events?: UseConversationEvents;
 }
-/**
- * useConversation返回值接口
- */
 interface UseConversationReturn {
-    /** 会话状态 */
-    state: ConversationState;
-    /** 消息管理 */
-    messageManager: UseMessageReturn;
-    /** 创建新会话 */
-    createConversation: (title?: string, metadata?: Record<string, unknown>) => string;
-    /** 切换会话 */
-    switchConversation: (id: string) => void;
-    /** 删除会话 */
-    deleteConversation: (id: string) => void;
-    /** 更新会话标题 */
-    updateTitle: (id: string, title: string) => void;
-    /** 更新会话元数据 */
-    updateMetadata: (id: string, metadata: Record<string, unknown>) => void;
-    /** 保存会话 */
-    saveConversations: () => Promise<void>;
-    /** 加载会话 */
-    loadConversations: () => Promise<void>;
-    /** 生成会话标题 */
-    generateTitle: (id: string) => Promise<string>;
-    /** 获取当前会话 */
-    getCurrentConversation: () => Conversation | null;
+    conversations: Ref<ConversationInfo[]>;
+    activeConversationId: Ref<string | null>;
+    activeConversation: ComputedRef<Conversation | null>;
+    createConversation: (params?: {
+        /** 会话ID，不提供则自动生成 */
+        id?: string;
+        /** 会话标题 */
+        title?: string;
+        /** 自定义元数据 */
+        metadata?: Record<string, unknown>;
+        /** 覆盖默认的消息选项 */
+        useMessageOptions?: Partial<UseMessageOptions>;
+    }) => Conversation;
+    switchConversation: (id: string) => Promise<Conversation | null>;
+    deleteConversation: (id: string) => Promise<void>;
+    updateConversationTitle: (id: string, title?: string) => void;
+    saveMessages: (id?: string) => void;
+    sendMessage: (content: string) => void;
+    abortActiveRequest: () => Promise<void>;
 }
+
+declare const useConversation: (options: UseConversationOptions) => UseConversationReturn;
+
+declare const fallbackRolePlugin: (options?: UseMessagePlugin & {
+    fallbackRole?: string;
+}) => UseMessagePlugin;
+
+declare const lengthPlugin: (options?: UseMessagePlugin & {
+    continueContent?: string;
+}) => UseMessagePlugin;
+
+declare const thinkingPlugin: (options?: UseMessagePlugin) => UseMessagePlugin;
+
 /**
- * useConversation composable
- * 提供会话管理和持久化功能
- *
- * @param options useConversation选项
- * @returns UseConversationReturn
+ * 消息排除模式：从 messages 数组中直接移除消息。
+ * 使用此模式时，消息会被完全从数组中移除，不会保留在 messages 中。
  */
-declare function useConversation(options: UseConversationOptions): UseConversationReturn;
+declare const EXCLUDE_MODE_REMOVE: "remove";
+declare const toolPlugin: (options: UseMessagePlugin & {
+    /**
+     * 获取工具列表的函数。
+     */
+    getTools: () => Promise<Tool[]>;
+    /**
+     * 在处理包含 tool_calls 的响应前调用。
+     */
+    beforeCallTools?: (toolCalls: ToolCall[], context: BasePluginContext & {
+        currentMessage: ChatMessage;
+    }) => Promise<void>;
+    /**
+     * 执行单个工具调用并返回其文本结果的函数。
+     */
+    callTool: (toolCall: ToolCall, context: BasePluginContext & {
+        currentMessage: ChatMessage;
+    }) => Promise<string | Record<string, any>> | AsyncGenerator<string | Record<string, any>>;
+    /**
+     * 工具调用开始时的回调函数。
+     * 触发时机：工具消息已创建并追加后，调用 callTool 之前触发。
+     * @param toolCall - 工具调用对象
+     * @param context - 插件上下文，包含当前工具消息
+     */
+    onToolCallStart?: (toolCall: ToolCall, context: BasePluginContext & {
+        primaryMessage: ChatMessage;
+        toolMessage: ChatMessage;
+    }) => void;
+    /**
+     * 工具调用结束时的回调函数。
+     * 触发时机：工具调用完成（成功、失败或取消）时触发。
+     * @param toolCall - 工具调用对象
+     * @param context - 插件上下文，包含当前工具消息、状态和错误信息
+     * @param context.status - 工具调用状态：'success' | 'failed' | 'cancelled'
+     * @param context.error - 当状态为 'failed' 或 'cancelled' 时，可能包含错误信息
+     */
+    onToolCallEnd?: (toolCall: ToolCall, context: BasePluginContext & {
+        primaryMessage: ChatMessage;
+        toolMessage: ChatMessage;
+        status: "success" | "failed" | "cancelled";
+        error?: Error;
+    }) => void;
+    /**
+     * 当请求被中止时用于工具调用取消的消息内容。
+     */
+    toolCallCancelledContent?: string;
+    /**
+     * 当工具调用执行失败（抛错或拒绝）时使用的消息内容。
+     */
+    toolCallFailedContent?: string;
+    /**
+     * 是否在请求被中止时自动补充缺失的 tool 消息。
+     * 当 assistant 响应了 tool_calls 但未追加对应的 tool 消息时，
+     * 插件将自动补充"工具调用已取消"的 tool 消息。默认：false。
+     */
+    autoFillMissingToolMessages?: boolean;
+    /**
+     * 是否在下一轮对话中，排除包含 tool_calls 的 assistant 消息和对应的 tool 消息，只保留结果。
+     * - 当为 `true` 时，这些消息会被标记为不发送，不会包含在下一次请求的 messages 中。
+     * - 当为 `'remove'` 时，这些消息会直接从 messages 数组中移除。
+     * 默认：false。
+     */
+    excludeToolMessagesNextTurn?: boolean | typeof EXCLUDE_MODE_REMOVE;
+}) => UseMessagePlugin;
+
+declare const useMessage: (options: UseMessageOptions) => UseMessageReturn;
 
-export { type AIAdapterError, AIClient, type AIModelConfig, type AIProvider, BaseModelProvider, type ChatCompletionOptions, type ChatCompletionRequest, type ChatCompletionResponse, type ChatCompletionResponseChoice, type ChatCompletionResponseMessage, type ChatCompletionResponseUsage, type ChatCompletionStreamResponse, type ChatCompletionStreamResponseChoice, type ChatCompletionStreamResponseDelta, type ChatHistory, type ChatMessage, type Conversation, type ConversationState, type ConversationStorageStrategy, ErrorType, FinalStatus, GeneratingStatus, LocalStorageStrategy, type MessageRole, type MessageState, OpenAIProvider, STATUS, StreamEventType, type StreamHandler, type UseConversationEvents, type UseConversationOptions, type UseConversationReturn, type UseMessageOptions, type UseMessageReturn, extractTextFromResponse, formatMessages, handleSSEStream, useConversation, useMessage };
+export { type BasePluginContext, type ChatCompletion, type ChatMessage, type Choice, type CompletionChoice, type Conversation, type ConversationInfo, type ConversationStorageStrategy, type DeltaChoice, EXCLUDE_MODE_REMOVE, type MessageMetadata, type MessageRequestBody, type RequestProcessingState, type RequestState, type Tool, type ToolCall, type Usage, type UseConversationOptions, type UseConversationReturn, type UseMessageOptions, type UseMessagePlugin, type UseMessageReturn, createSSEStreamGenerator, fallbackRolePlugin, lengthPlugin, thinkingPlugin, toolPlugin, useConversation, useMessage };