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

package/dist/index.d.mts

@@ -1,216 +1,7 @@
+import { a as AIModelConfig, c as ChatCompletionRequest, d as ChatCompletionResponse, o as StreamHandler, B as BaseModelProvider, l as ChatMessage, M as MaybePromise, T as ToolCall } from './types-CePh-Jcx.mjs';
+export { A as AIAdapterError, b as AIProvider, C as ChatCompletionOptions, e as ChatCompletionResponseChoice, f as ChatCompletionResponseMessage, g as ChatCompletionResponseUsage, h as ChatCompletionStreamResponse, i as ChatCompletionStreamResponseChoice, j as ChatCompletionStreamResponseDelta, k as ChatHistory, E as ErrorType, m as MessageMetadata, n as MessageRole, S as StreamEventType } from './types-CePh-Jcx.mjs';
 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 ToolCall {
-    index: number;
-    id: string;
-    type: 'function';
-    function: {
-        name: string;
-        arguments: string;
-        result?: string;
-    };
-}
-interface MessageMetadata {
-    createdAt?: number;
-    updatedAt?: number;
-    id?: string;
-    model?: string;
-    [key: string]: any;
-}
-/**
- * 聊天消息接口
- */
-interface ChatMessage {
-    role: string;
-    content: string;
-    reasoning_content?: string;
-    metadata?: MessageMetadata;
-    tool_calls?: ToolCall[];
-    tool_call_id?: string;
-    [key: string]: any;
-    [key: symbol]: any;
-}
-/**
- * 聊天历史记录
- */
-type ChatHistory = ChatMessage[];
-/**
- * 聊天完成请求选项
- */
-interface ChatCompletionOptions {
-    model?: string;
-    temperature?: number;
-    top_p?: number;
-    n?: number;
-    stream?: boolean;
-    max_tokens?: number;
-    signal?: AbortSignal;
-}
-/**
- * 聊天完成请求参数
- */
-interface ChatCompletionRequest {
-    messages: ChatMessage[];
-    options?: ChatCompletionOptions;
-}
-/**
- * 聊天完成响应消息
- */
-interface ChatCompletionResponseMessage {
-    role: MessageRole;
-    content: string;
-    [x: string]: unknown;
-}
-/**
- * 聊天完成响应选择
- */
-interface ChatCompletionResponseChoice {
-    index: number;
-    message: ChatCompletionResponseMessage;
-    finish_reason: string;
-}
-/**
- * 聊天完成响应使用情况
- */
-interface ChatCompletionResponseUsage {
-    prompt_tokens: number;
-    completion_tokens: number;
-    total_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 ChatCompletionStreamResponseChoice {
-    index: number;
-    delta: ChatCompletionStreamResponseDelta;
-    finish_reason: string | null;
-}
-/**
- * 流式聊天完成响应
- */
-interface ChatCompletionStreamResponse {
-    id: string;
-    object: string;
-    created: number;
-    model: string;
-    choices: ChatCompletionStreamResponseChoice[];
-}
-/**
- * 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 StreamHandler {
-    onData: (data: ChatCompletionStreamResponse) => void;
-    onError: (error: AIAdapterError) => void;
-    onDone: (finishReason?: string) => void;
-}
-
 /**
  * AI客户端类
  * 负责根据配置选择合适的提供商并处理请求
@@ -294,11 +85,12 @@ interface Tool {
     type: 'function';
     function: {
         name: string;
-        description: string;
+        description?: string;
         /**
          * function 的输入参数，以 JSON Schema 对象描述
          */
-        parameters: any;
+        parameters?: any;
+        inputSchema?: any;
     };
     [key: string]: any;
 }
@@ -352,6 +144,7 @@ interface ChatCompletion {
     choices: CompletionChoice[];
     usage?: Usage;
 }
+type ResponseProvider<T = ChatCompletion> = (requestBody: MessageRequestBody, abortSignal: AbortSignal) => Promise<T> | AsyncGenerator<T> | Promise<AsyncGenerator<T>>;
 interface UseMessageOptions {
     initialMessages?: ChatMessage[];
     /**
@@ -365,7 +158,7 @@ interface UseMessageOptions {
      */
     requestMessageFieldsExclude?: string[];
     plugins?: UseMessagePlugin[];
-    responseProvider: <T = ChatCompletion>(requestBody: MessageRequestBody, abortSignal: AbortSignal) => Promise<T> | AsyncGenerator<T> | Promise<AsyncGenerator<T>>;
+    responseProvider: ResponseProvider;
     /**
      * 全局的数据块处理钩子，在接收到每个响应数据块时触发。
      * 注意：此钩子与插件中的 onCompletionChunk 有区别。
@@ -501,6 +294,11 @@ interface UseConversationOptions {
      * When provided, conversation list and messages can be loaded and persisted.
      */
     storage?: ConversationStorageStrategy;
+    /**
+     * Called when the initial conversation list has been loaded from storage.
+     * Only fired when storage.loadConversations is available and has completed.
+     */
+    onLoad?: (conversations: ConversationInfo[]) => void;
 }
 interface UseConversationReturn {
     conversations: Ref<ConversationInfo[]>;
@@ -658,21 +456,30 @@ declare function sseStreamToGenerator<T = any>(response: Response, options?: {
 
 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;
 
-/**
- * 消息排除模式：从 messages 数组中直接移除消息。
- * 使用此模式时，消息会被完全从数组中移除，不会保留在 messages 中。
- */
-declare const EXCLUDE_MODE_REMOVE: "remove";
+interface UseMessageToolActionContext extends BasePluginContext {
+    assistantMessage: ChatMessage;
+    /**
+     * @deprecated use `assistantMessage` instead
+     */
+    currentMessage: ChatMessage;
+}
+interface UseMessageCallToolContext extends UseMessageToolActionContext {
+    toolMessage: ChatMessage;
+}
+interface UseMessageToolCallContext extends BasePluginContext {
+    assistantMessage: ChatMessage;
+    /**
+     * @deprecated use `assistantMessage` instead
+     */
+    primaryMessage: ChatMessage;
+    toolMessage: ChatMessage;
+}
 declare const toolPlugin: (options: UseMessagePlugin & {
     /**
      * 获取工具列表的函数。
@@ -681,25 +488,18 @@ declare const toolPlugin: (options: UseMessagePlugin & {
     /**
      * 在处理包含 tool_calls 的响应前调用。
      */
-    beforeCallTools?: (toolCalls: ToolCall[], context: BasePluginContext & {
-        currentMessage: ChatMessage;
-    }) => Promise<void>;
+    beforeCallTools?: (toolCalls: ToolCall[], context: UseMessageToolActionContext) => Promise<void>;
     /**
      * 执行单个工具调用并返回其文本结果的函数。
      */
-    callTool: (toolCall: ToolCall, context: BasePluginContext & {
-        currentMessage: ChatMessage;
-    }) => Promise<string | Record<string, any>> | AsyncGenerator<string | Record<string, any>>;
+    callTool: (toolCall: ToolCall, context: UseMessageCallToolContext) => 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;
+    onToolCallStart?: (toolCall: ToolCall, context: UseMessageToolCallContext) => void;
     /**
      * 工具调用结束时的回调函数。
      * 触发时机：工具调用完成（成功、失败或取消）时触发。
@@ -708,9 +508,7 @@ declare const toolPlugin: (options: UseMessagePlugin & {
      * @param context.status - 工具调用状态：'success' | 'failed' | 'cancelled'
      * @param context.error - 当状态为 'failed' 或 'cancelled' 时，可能包含错误信息
      */
-    onToolCallEnd?: (toolCall: ToolCall, context: BasePluginContext & {
-        primaryMessage: ChatMessage;
-        toolMessage: ChatMessage;
+    onToolCallEnd?: (toolCall: ToolCall, context: UseMessageToolCallContext & {
         status: "success" | "failed" | "cancelled";
         error?: Error;
     }) => void;
@@ -723,20 +521,13 @@ declare const toolPlugin: (options: UseMessagePlugin & {
      */
     toolCallFailedContent?: string;
     /**
-     * 是否在请求被中止时自动补充缺失的 tool 消息。
+     * 是否在请求前自动补充缺失的 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 BasePluginContext, type ChatCompletion, type ChatCompletionOptions, type ChatCompletionRequest, type ChatCompletionResponse, type ChatCompletionResponseChoice, type ChatCompletionResponseMessage, type ChatCompletionResponseUsage, type ChatCompletionStreamResponse, type ChatCompletionStreamResponseChoice, type ChatCompletionStreamResponseDelta, type ChatHistory, type ChatMessage, type Choice, type CompletionChoice, type Conversation, type ConversationInfo, type ConversationStorageStrategy, type DeltaChoice, EXCLUDE_MODE_REMOVE, ErrorType, type IndexedDBConfig, IndexedDBStrategy, type LocalStorageConfig, LocalStorageStrategy, type MaybePromise, type MessageMetadata, type MessageRequestBody, type MessageRole, OpenAIProvider, type RequestProcessingState, type RequestState, StreamEventType, type StreamHandler, type Tool, type ToolCall, type Usage, type UseConversationOptions, type UseConversationReturn, type UseMessageOptions, type UseMessagePlugin, type UseMessageReturn, extractTextFromResponse, fallbackRolePlugin, formatMessages, handleSSEStream, indexedDBStorageStrategyFactory, lengthPlugin, localStorageStrategyFactory, sseStreamToGenerator, thinkingPlugin, toolPlugin, useConversation, useMessage };
+export { AIClient, AIModelConfig, BaseModelProvider, type BasePluginContext, type ChatCompletion, ChatCompletionRequest, ChatCompletionResponse, ChatMessage, type Choice, type CompletionChoice, type Conversation, type ConversationInfo, type ConversationStorageStrategy, type DeltaChoice, type IndexedDBConfig, IndexedDBStrategy, type LocalStorageConfig, LocalStorageStrategy, MaybePromise, type MessageRequestBody, OpenAIProvider, type RequestProcessingState, type RequestState, type ResponseProvider, StreamHandler, type Tool, ToolCall, type Usage, type UseConversationOptions, type UseConversationReturn, type UseMessageCallToolContext, type UseMessageOptions, type UseMessagePlugin, type UseMessageReturn, type UseMessageToolActionContext, type UseMessageToolCallContext, extractTextFromResponse, formatMessages, handleSSEStream, indexedDBStorageStrategyFactory, lengthPlugin, localStorageStrategyFactory, sseStreamToGenerator, thinkingPlugin, toolPlugin, useConversation, useMessage };