1npm install @lingshuai/chat-uniapp

1import { useChat } from '@lingshuai/chat-uniapp';
2
3const {
4  messages, loading, sendMessage,
5  clearHistory, getStorageInfo, exportMessages, importMessages
6} = useChat({
7  apiKey: 'tmp_live_xxxxxxxxxxxxxx'  // ⭐ 用临时Token,
8  appId: 'your-app-id',
9  maxRetries: 3,            // 最大重试次数
10  retryDelay: 1000,         // 重试间隔（毫秒）
11  maxStoredMessages: 200,   // 本地最大存储消息数
12  autoCleanup: true,        // 自动清理旧消息
13});
14
15// 查看存储信息
16const info = await getStorageInfo();
17console.log(`消息数: ${info.messageCount}, 占用: ${info.estimatedSize}`);
18
19// 导出 / 导入消息记录
20const json = await exportMessages();
21await importMessages(json);

1// 消息
2interface Message {
3  id: string;                    // 消息 ID
4  conversationId: string;        // 所属会话 ID
5  role: 'user' | 'assistant' | 'system'; // 角色
6  content: string;               // 消息内容
7  status: 'sending' | 'streaming' | 'success' | 'error'; // 消息状态
8  createdAt: Date;               // 创建时间
9  error?: string;                // 错误信息（status 为 error 时）
10  attachments?: MediaAttachment[]; // 多模态附件
11}
12
13// 媒体类型
14type MediaType = 'image' | 'audio' | 'video' | 'file';
15
16// 媒体附件
17interface MediaAttachment {
18  type: MediaType;               // 附件类型
19  url: string;                   // 公网访问地址
20  mimeType?: string;             // MIME 类型
21  name?: string;                 // 文件名
22  objectName?: string;           // MinIO 对象名称（上传后自动返回）
23  size?: number;                 // 文件大小（字节）
24  duration?: number;             // 时长（秒），音视频专用
25  localPath?: string;            // 本地文件路径（UniApp 端离线预览用）
26}
27
28// 上传结果
29interface UploadResult {
30  url: string;                   // 公网 URL
31  objectName: string;            // 对象存储路径
32  mimeType: string;              // MIME 类型
33  size: number;                  // 文件大小（字节）
34  name?: string;                 // 文件名
35}
36
37// TTS 合成选项
38interface TtsOptions {
39  voice?: string;                // 音色 ID
40  projectId?: string;            // 项目 ID
41  conversationId?: string;       // 会话 ID
42}
43
44// TTS 合成结果
45interface TtsResult {
46  audioUrl: string;              // 音频文件 URL
47  characters: number;            // 字符数
48  model: string;                 // TTS 模型名称
49  voice: string;                 // 使用的音色 ID
50}
51
52// TTS 播放状态
53type TtsPlayState = 'idle' | 'loading' | 'playing' | 'paused' | 'error';
54
55// TTS 音色选项
56interface TtsVoiceOption {
57  id: string;                    // 音色 ID
58  name: string;                  // 音色名称
59  description: string;           // 音色描述
60  isDefault: boolean;            // 是否默认音色
61}
62
63// 本地存储信息
64interface StorageInfo {
65  messageCount: number;          // 已存储消息数
66  estimatedSize: string;         // 预估占用空间（可读格式）
67  oldestMessageTime: number | null; // 最早消息时间戳（毫秒）
68  newestMessageTime: number | null; // 最新消息时间戳（毫秒）
69  conversationId: string | null; // 当前会话 ID
70}
71
72// 语音录制配置
73interface VoiceRecorderConfig {
74  maxDuration?: number;          // 最大录制时长（秒，默认 60）
75  sampleRate?: number;           // 采样率（Hz，各平台自动选择）
76  format?: string;               // 录音格式（各平台自动选择）
77}
78
79// 录音结果
80interface RecordResult {
81  tempFilePath: string;          // 临时文件路径
82  duration: number;              // 时长（秒）
83  fileSize?: number;             // 文件大小（字节）
84  format: string;                // 音频格式
85  mimeType: string;              // MIME 类型（用于上传）
86}
87
88// 录音状态
89type RecorderState = 'idle' | 'recording' | 'paused';
90
91// ASR 语音识别状态
92type AsrState = 'idle' | 'connecting' | 'listening' | 'transcribing' | 'error';
93
94// ASR WebSocket 消息
95interface AsrMessage {
96  type: 'ready' | 'partial' | 'final' | 'complete' | 'error' | 'cancelled';
97  text?: string;               // 转写文本
98  index?: number;              // 句子序号
99  message?: string;            // 错误信息（type 为 error 时）
100}