@opentiny/tiny-robot-kit 0.2.0-alpha.0

package/README.md

@@ -0,0 +1,164 @@
+# tiny-robot-kit
+
+封装与与AI大模型的交互逻辑与数据处理，适配多种模型提供商，提供统一的API接口。
+
+## API参考
+
+### AIClient
+
+主要客户端类，用于与AI模型交互。
+
+#### 构造函数
+
+```typescript
+new AIClient(config: AIModelConfig)
+```
+
+#### 方法
+
+- `chat(request: ChatCompletionRequest): Promise<ChatCompletionResponse>`
+  发送聊天请求并获取响应。
+
+- `chatStream(request: ChatCompletionRequest, handler: StreamHandler): Promise<void>`
+  发送流式聊天请求并通过处理器处理响应。
+
+
+## 基本用法
+
+### 创建客户端并发送消息
+
+```typescript
+import { AIClient } from '@opentiny/tiny-robot-kit';
+
+// 创建客户端
+const client = new AIClient({
+  provider: 'openai',
+  apiKey: 'your-api-key',
+  defaultModel: 'gpt-3.5-turbo'
+});
+
+// 发送消息并获取响应
+async function chat() {
+  try {
+    const response = await client.chat({
+      messages: [
+        { role: 'system', content: '你是一个有用的助手。' },
+        { role: 'user', content: '你好，请介绍一下自己。' }
+      ],
+      options: {
+        temperature: 0.7
+      }
+    });
+    
+    console.log(response.choices[0].message.content);
+  } catch (error) {
+    console.error('聊天出错:', error);
+  }
+}
+
+chat();
+```
+
+### 使用流式响应
+
+```typescript
+import { AIClient } from '@opentiny/tiny-robot-kit';
+
+const client = new AIClient({
+  provider: 'openai',
+  apiKey: 'your-api-key'
+});
+
+async function streamChat() {
+  try {
+    const controller: AbortController = new AbortController()
+    await client.chatStream({
+      messages: [
+        { role: 'user', content: '写一个简短的故事。' }
+      ],
+      options: {
+        stream: true, // 启用流式响应
+        signal: controller.signal  // 传递 AbortController 的 signal用于中断请求
+      }
+    }, {
+      onData: (data) => {
+        // 处理流式数据
+        const content = data.choices[0]?.delta?.content || '';
+        process.stdout.write(content);
+      },
+      onError: (error) => {
+        console.error('流式响应错误:', error);
+      },
+      onDone: () => {
+        console.log('\n流式响应完成');
+      }
+    });
+    // controller.abort() // 中断请求
+  } catch (error) {
+    console.error('流式聊天出错:', error);
+  }
+}
+
+streamChat();
+```
+
+### useMessage
+
+#### 选项
+
+`useMessage` 接受以下选项：
+
+```typescript
+interface UseMessageOptions {
+  /** AI客户端实例 */
+  client: AIClient;
+  /** 是否默认使用流式响应 */
+  useStreamByDefault?: boolean;
+  /** 错误消息模板 */
+  errorMessage?: string;
+  /** 初始消息列表 */
+  initialMessages?: ChatMessage[];
+}
+```
+
+#### 返回值
+
+`useMessage` 返回以下内容：
+```typescript
+interface UseMessageReturn {
+  messages: ChatMessage[];
+  /** 消息状态 */
+  messageState: Reactive<MessageState>;
+  /** 输入消息 */
+  inputMessage: Ref<string>;
+  /** 是否使用流式响应 */
+  useStream: Ref<boolean>;
+  /** 发送消息 */
+  sendMessage: (content?: string, clearInput?: boolean) => Promise<void>
+  /** 清空消息 */
+  clearMessages: () => void;
+  /** 添加消息 */
+  addMessage: (message: ChatMessage) => void;
+  /** 中止请求 */
+  abortRequest: () => void;
+  /** 重试请求 */
+  retryRequest: () => Promise<void>;
+}
+```
+
+#### MessageState 接口
+```typescript
+interface MessageState {
+  status: STATUS
+  errorMsg: string | null
+}
+
+enum STATUS {
+  INIT = 'init', // 初始状态
+  PROCESSING = 'processing', // AI请求正在处理中, 还未响应，显示加载动画
+  STREAMING = 'streaming', // 流式响应中分块数据返回中
+  FINISHED = 'finished', // AI请求已完成
+  ABORTED = 'aborted', // 用户中止请求
+  ERROR = 'error', // AI请求发生错误
+}
+```

package/dist/index.d.mts

@@ -0,0 +1,351 @@
+import { Ref, Reactive } from 'vue';
+
+/**
+ * 消息角色类型
+ */
+type MessageRole = 'system' | 'user' | 'assistant';
+/**
+ * 聊天消息接口
+ */
+interface ChatMessage {
+    role: MessageRole;
+    content: string;
+    name?: string;
+}
+/**
+ * 聊天历史记录
+ */
+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;
+}
+/**
+ * 聊天完成响应选择
+ */
+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;
+}
+/**
+ * 流式聊天完成响应选择
+ */
+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;
+    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: () => void;
+}
+
+/**
+ * AI客户端类
+ * 负责根据配置选择合适的提供商并处理请求
+ */
+
+/**
+ * AI客户端类
+ */
+declare class AIClient {
+    private provider;
+    private config;
+    /**
+     * 构造函数
+     * @param config AI模型配置
+     */
+    constructor(config: AIModelConfig);
+    /**
+     * 创建提供商实例
+     * @param config AI模型配置
+     * @returns 提供商实例
+     */
+    private createProvider;
+    /**
+     * 发送聊天请求并获取响应
+     * @param request 聊天请求参数
+     * @returns 聊天响应
+     */
+    chat(request: ChatCompletionRequest): Promise<ChatCompletionResponse>;
+    /**
+     * 发送流式聊天请求并通过处理器处理响应
+     * @param request 聊天请求参数
+     * @param handler 流式响应处理器
+     */
+    chatStream(request: ChatCompletionRequest, handler: StreamHandler): Promise<void>;
+    /**
+     * 获取当前配置
+     * @returns AI模型配置
+     */
+    getConfig(): AIModelConfig;
+    /**
+     * 更新配置
+     * @param config 新的AI模型配置
+     */
+    updateConfig(config: Partial<AIModelConfig>): void;
+}
+
+/**
+ * 模型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;
+}
+
+/**
+ * OpenAI提供商
+ * 用于与OpenAI API进行交互
+ */
+
+declare class OpenAIProvider extends BaseModelProvider {
+    private baseURL;
+    private apiKey;
+    private defaultModel;
+    /**
+     * @param config AI模型配置
+     */
+    constructor(config: AIModelConfig);
+    /**
+     * 发送聊天请求并获取响应
+     * @param request 聊天请求参数
+     * @returns 聊天响应
+     */
+    chat(request: ChatCompletionRequest): Promise<ChatCompletionResponse>;
+    /**
+     * 发送流式聊天请求并通过处理器处理响应
+     * @param request 聊天请求参数
+     * @param handler 流式响应处理器
+     */
+    chatStream(request: ChatCompletionRequest, handler: StreamHandler): Promise<void>;
+    /**
+     * 更新配置
+     * @param config 新的AI模型配置
+     */
+    updateConfig(config: AIModelConfig): 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[];
+}
+/**
+ * useMessage返回值接口
+ */
+interface UseMessageReturn {
+    messages: Ref<ChatMessage[]>;
+    /** 消息状态 */
+    messageState: Reactive<MessageState>;
+    /** 输入消息 */
+    inputMessage: Ref<string>;
+    /** 是否使用流式响应 */
+    useStream: Ref<boolean>;
+    /** 发送消息 */
+    sendMessage: (content?: string, clearInput?: boolean) => Promise<void>;
+    /** 清空消息 */
+    clearMessages: () => void;
+    /** 添加消息 */
+    addMessage: (message: ChatMessage) => void;
+    /** 中止请求 */
+    abortRequest: () => void;
+    /** 重试请求 */
+    retryRequest: (msgIndex: number) => Promise<void>;
+}
+/**
+ * useMessage composable
+ * 提供消息管理和状态控制功能
+ *
+ * @param options useMessage选项
+ * @returns UseMessageReturn
+ */
+declare function 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, ErrorType, FinalStatus, GeneratingStatus, type MessageRole, type MessageState, OpenAIProvider, STATUS, StreamEventType, type StreamHandler, type UseMessageOptions, type UseMessageReturn, extractTextFromResponse, formatMessages, useMessage };