@fv-ui/ai-chat 1.6.2 → 1.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -37
- package/dist/index.d.ts +702 -37
- package/dist/style.css +1 -1
- package/es/index.mjs +556 -54
- package/lib/index.js +558 -53
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -83,7 +83,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
83
83
|
| isTyping | boolean | — | 打字机模式样式钩子(透传占位) |
|
|
84
84
|
| codeTriggerLangs | string[] | — | 代码块「预览」触发语言(fence 原始 lang 命中列表时注入预览按钮,点击行为由消费方事件委托实现) |
|
|
85
85
|
| tableToolbar | boolean | true | 表格工具栏:表格上方注入复制(复制表格 markdown 源文本)/下载(导出 CSV,带 BOM)单图标按钮 |
|
|
86
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
86
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
87
87
|
|
|
88
88
|
| Ref | 说明 |
|
|
89
89
|
| --- | --- |
|
|
@@ -166,7 +166,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
166
166
|
| backButtonPosition | { bottom?; left? } | {} | 回底按钮位置偏移 |
|
|
167
167
|
| btnIconSize | number | 16 | 回底按钮图标尺寸 |
|
|
168
168
|
| triggerIndices | 'only-last' \| 'all' \| number[] | 'only-last' | @complete 触发索引 |
|
|
169
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
169
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
170
170
|
|
|
171
171
|
| Event | 说明 |
|
|
172
172
|
| --- | --- |
|
|
@@ -190,7 +190,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
190
190
|
| placeholder | string | '' | 占位文案(缺省回落语言包 sender.inputPlaceholder) |
|
|
191
191
|
| autosize | { minRows?; maxRows? } | { minRows: 3, maxRows: 7 } | 自增高(行高 22px;默认 3 行起步,内容多时自动加高至最多 7 行后内部滚动;显式传 {} 退回固定单行) |
|
|
192
192
|
| submitType | 'enter' \| 'shiftEnter' \| 'cmdOrCtrlEnter' \| 'altEnter' | 'enter' | 提交按键模式 |
|
|
193
|
-
| loading | boolean | false | 加载态(
|
|
193
|
+
| loading | boolean | false | 加载态(发送键变停止键,输入区禁用;停止键出现后 600ms 降险窗口内不可停,吸收发送瞬间的快速连点) |
|
|
194
194
|
| disabled | boolean | false | 禁用(阻断提交) |
|
|
195
195
|
| readOnly | boolean | false | 只读 |
|
|
196
196
|
| clearable | boolean | false | 显示清空按钮 |
|
|
@@ -206,13 +206,13 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
206
206
|
| triggerPopoverPlacement | ElPopover placement | 'top-start' | 弹框位置 |
|
|
207
207
|
| allowSpeech | boolean | false | 开启语音输入:麦克风按钮 → 录音条(波形+时长,Esc 取消)→ 确认后转写文本插入光标处;浏览器 SpeechRecognition 实时转写 |
|
|
208
208
|
| allowEmptySubmit | boolean | false | 允许空内容提交(附件场景:只发文件不输文字) |
|
|
209
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
209
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
210
210
|
|
|
211
211
|
| Event | 说明 |
|
|
212
212
|
| --- | --- |
|
|
213
213
|
| update:modelValue / change | 输入值变化 |
|
|
214
214
|
| submit | (value) 提交(提交后内部清空) |
|
|
215
|
-
| cancel | 点击停止按钮 |
|
|
215
|
+
| cancel | 点击停止按钮(loading 翻 true 后 600ms 内的点击被吞不发——防连点误停) |
|
|
216
216
|
| trigger | (keyword, visible) 命中指令串 |
|
|
217
217
|
| recording-change | 语音录制状态变化(预留) |
|
|
218
218
|
| paste-file | (file) 粘贴文件 |
|
|
@@ -242,7 +242,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
242
242
|
| userList | MentionUserInfo[] | [] | @ 触发的候选用户(id/name/avatar/pinyin) |
|
|
243
243
|
| customTrigger | MentionCustomTrigger[] | [] | 自定义触发组 { dialogTitle, prefix, tagList } |
|
|
244
244
|
| asyncMatchFun | (search) => Promise<MentionUserInfo[]> | — | 异步候选(存在时防抖 300ms,后端过滤) |
|
|
245
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
245
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(候选加载文案);内嵌 Sender 的文案经祖先注入(如 AiChat)或全局设置生效 |
|
|
246
246
|
|
|
247
247
|
事件:`update:modelValue` / `change` / `submit` / `cancel` / `trigger` / `recording-change` / `paste-file` / `update:triggerPopoverVisible` / `show-at-dialog`(弹层显隐);其余 props/事件经 `$attrs` 透传给 Sender,slot 经 forwardedSlots 显式转发(header/footer/prefix/action-list/trigger)。
|
|
248
248
|
|
|
@@ -274,7 +274,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
274
274
|
| headerAnimationTimer | number | 300 | 头部过渡时长(ms) |
|
|
275
275
|
| asyncMatchFun | (search) => Promise<EditorUser[]> | — | 异步 @ 候选(防抖 300ms) |
|
|
276
276
|
| customDialog | boolean | false | 选择标签不自弹内置弹窗,仅上抛 show-select-dialog |
|
|
277
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
277
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
278
278
|
|
|
279
279
|
| Event | 说明 |
|
|
280
280
|
| --- | --- |
|
|
@@ -307,14 +307,14 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
307
307
|
| --- | --- | --- | --- |
|
|
308
308
|
| modelValue | boolean(v-model) | false | 展开/收起 |
|
|
309
309
|
| content | string | '' | 思考内容(常配合 #content 插槽嵌 FvMarkdown) |
|
|
310
|
-
| status | 'start' \| 'thinking' \| 'end' \| 'error' | 'start' | 思考状态 |
|
|
310
|
+
| status | 'start' \| 'thinking' \| 'end' \| 'interrupted' \| 'error' | 'start' | 思考状态(interrupted 为用户中断态,警告橙图标) |
|
|
311
311
|
| disabled | boolean | false | 禁用切换 |
|
|
312
312
|
| autoCollapse | boolean | false | status 变为 end 时自动收起 |
|
|
313
313
|
| hideHeader | boolean | false | 隐藏折叠头(单 item 链平铺形态):不渲染切换按钮,内容区常驻展开 |
|
|
314
314
|
| buttonWidth | string | '' | 切换按钮区宽度 |
|
|
315
315
|
| maxWidth | string | '' | 内容区最大宽度 |
|
|
316
316
|
| color / backgroundColor | string | '' | 前景色 / 背景色 |
|
|
317
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
317
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
318
318
|
|
|
319
319
|
| Event | 说明 |
|
|
320
320
|
| --- | --- |
|
|
@@ -343,7 +343,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
343
343
|
| direction | 'vertical' \| 'horizontal' | 'vertical' | 排列方向 |
|
|
344
344
|
| collapsible | boolean | false | 工具步长文案展开/收起(超 3 行截断 + 行尾「展开」) |
|
|
345
345
|
| showDuration | boolean | false | 显示工具步用时 description(text 步 description 不受影响) |
|
|
346
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
346
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
347
347
|
|
|
348
348
|
| Slot | 说明 |
|
|
349
349
|
| --- | --- |
|
|
@@ -408,8 +408,8 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
408
408
|
| errorText | string | '' | 失败原因红字(error 态展示于卡片下方,超宽截断 title 全文) |
|
|
409
409
|
| imageSize | string | '' | 缩略图尺寸(width/height 同值) |
|
|
410
410
|
| onDelete | () => void | — | 删除按钮回调(按钮常驻右上角,hover 浮现) |
|
|
411
|
-
| onDownload | () => void | — | 下载回调:注入时右上角渲染下载按钮(hover
|
|
412
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
411
|
+
| onDownload | () => void | — | 下载回调:注入时右上角渲染下载按钮(28px hover 浮现,比删除按钮大一圈,垂直居中)。消息附件卡走此路(内置触发浏览器下载),输入区附件卡不注入 |
|
|
412
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
413
413
|
|
|
414
414
|
| Slot | 说明 |
|
|
415
415
|
| --- | --- |
|
|
@@ -429,7 +429,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
429
429
|
| upload | (file, item) => Promise\<Partial\<AttachmentItem\> \| undefined \| void\> \| ... | — | 上传钩子(先传后发):选文件即调——入列即 loading,成功返回附件描述(含服务端附件 id)回填列表项置 success,失败(抛错/resolve 错误文案串)置 error 带失败原因(可重传再走钩子);缺省不调(纯本地待发列表,入列直接 success) |
|
|
430
430
|
| disabled | boolean | false | 整体禁用(触发按钮不可点;生成中锁定输入场景,单飞行闸语义) |
|
|
431
431
|
| layout | 'inline' \| 'triggerOnly' \| 'listOnly' | 'inline' | 布局:inline 回形针+列表+提示一行;triggerOnly 只渲染回形针按钮;listOnly 只渲染文件列表(拆分布局供整框组合:按钮进操作栏、列表进输入区上方) |
|
|
432
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
432
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
433
433
|
|
|
434
434
|
| Event | 说明 |
|
|
435
435
|
| --- | --- |
|
|
@@ -458,7 +458,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
458
458
|
| active | string \| number(v-model:active) | undefined | 当前激活会话 key |
|
|
459
459
|
| showBuiltInMenuType | 'hover' \| 'always' | 'hover' | 内置菜单按钮显隐方式 |
|
|
460
460
|
| groupable | (a, b) => number | — | 分组排序比较器(缺省保持插入顺序) |
|
|
461
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
461
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
462
462
|
|
|
463
463
|
| Event | 说明 |
|
|
464
464
|
| --- | --- |
|
|
@@ -519,7 +519,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
519
519
|
| senderShadow | boolean | true | 输入区阴影效果(透传 Sender 的 shadow) |
|
|
520
520
|
| suggestions | AiChatSuggestion[] | [] | 空态建议列表(Prompts 项,key 必填;空态快捷条为胶囊形态,description 不显示) |
|
|
521
521
|
| suggestionsWrap | boolean | true | 空态建议换行模式(true 自动换行;false 不换行,超出横向滚动) |
|
|
522
|
-
| followupStyle | 'list' \| 'chips' | 'list' | 追问建议展示样式(透传 AiMessages→AiMessage):'list' 纵向列表一行一条,渲染在回答操作区下方,顶部灰色分隔线 +
|
|
522
|
+
| followupStyle | 'list' \| 'chips' | 'list' | 追问建议展示样式(透传 AiMessages→AiMessage):'list' 纵向列表一行一条,渲染在回答操作区下方,顶部灰色分隔线 + **加粗**「追问」标题(字号/颜色随正文,标题文案经语言包 `aiMessage.followupsTitle` 自定义),条目 100% 宽、下划线分隔、字号随正文,历史消息同样渲染;'chips' 为旧横向气泡形态(换行铺排,无标题)。**正文打字效果完成后才渲染**(流式 suggestions 事件到达不显示,落定+打完字整体浮现) |
|
|
523
523
|
| features | AiChatFeatures | {} | 特性开关 { artifacts?, tts?, queue?, continueGenerate?, fullscreenEditor? }(当前仅 artifacts 生效);artifacts 传 `true` 用默认配置,传对象 `{ width?, minWidth?, maxWidth?, autoOpen?, codeBlockTrigger? }` 自定义:宽度三参控面板尺寸(默认 420px/360px/60%),autoOpen(默认 true)检测到代码块自动弹面板,codeBlockTrigger(默认 true)在消息 html/svg 代码块右上角显示「预览」按钮、点击打开对应面板 |
|
|
524
524
|
| allowAttachments | boolean | false | 开启输入区附件上传(回形针在操作栏左侧与提交按钮同行,已选列表在输入框上方;只传附件不输文字也可提交) |
|
|
525
525
|
| accept | string | '' | 附件 input accept 属性(透传 Attachments),如 `image/*,.pdf,.txt`。缺省 '' 不限制(zip/exe 等是否可传由消费方自主决定);显式传值时除选择器过滤外组件内注入 beforeUpload 硬校验——白名单外文件(选择器切「所有文件」绕过 accept)不入列,自动 toast 提示(文案经语言包 `errors.attachmentRejected` 自定义,`{name}` 为文件名)并上抛 @attachment-reject |
|
|
@@ -528,7 +528,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
528
528
|
| resolveFileUrl | (file: ChatFile) => Promise\<string\> \| string | undefined | 附件地址解析钩子(鉴权取流):消息气泡渲染附件 url 前调用,返回可直渲地址(如 JWT fetch 换 blob objectURL);缺省原样使用 url(blob/dataURL/公开地址)。远端 url 解析结果组件内按 url 缓存 + 在途去重;解析失败回落原 url 不阻塞渲染 |
|
|
529
529
|
| feedbackHandler | (message, action: 'LIKE' \| 'DISLIKE' \| 'CLEAR', comment?) => Promise\<unknown\> \| unknown | undefined | 消息评价提交钩子(透传 AiMessages→AiMessage;仅 assistant 最终回答行渲染 👍/👎,缺省不渲染按钮)。消费方在此接后端评价端点(如 Fv 系 POST /message/feedback):resolved 即成功;返回错误文案串/抛错触发 feedback-error(乐观更新已回滚);action=CLEAR 取消评价(comment 忽略)。交互语义:点击 👍 直接提交(不弹附言),点击 👎 弹**居中附言弹窗**(textarea ≤500 字 + 提交/跳过),再次点击当前态按钮发 CLEAR 取消评价(附言一并清空);👍↔👎 任意切换,后一次整体覆盖前一次(含附言);提交中按钮禁用防连点 |
|
|
530
530
|
| theme | 'light' \| 'dark' \| 'auto' | 'light' | 主题(向 html 注入/移除 dark class) |
|
|
531
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
531
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(解析后注入整框后代) |
|
|
532
532
|
|
|
533
533
|
**v-model:messages 半受控语义**:外部 `messages` 仅在 setup 时一次性深拷贝灌入(用于恢复历史);组件内部每次变更全量上抛 `update:messages`(同帧去抖),父组件需经 v-model 回写维持单向数据流;父组件后续直接改 prop **不会**回灌生效。
|
|
534
534
|
|
|
@@ -537,7 +537,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
537
537
|
| update:messages | (MessageNode[]) 全量消息链(去抖后) |
|
|
538
538
|
| send | (text, files?) 用户发送(allowAttachments 开启时 files 为降维后的 ChatFile[]) |
|
|
539
539
|
| suggestion-select | (item) 点击空态建议项(先于 send 触发;label 为空的项不发) |
|
|
540
|
-
| followup-select | (item, message) 点击回答尾部追问建议(先于 send 触发;组件内部已接住转 send 开启新一轮,事件仅供消费方可观测/埋点;assistant 消息带 suggestions
|
|
540
|
+
| followup-select | (item, message) 点击回答尾部追问建议(先于 send 触发;组件内部已接住转 send 开启新一轮,事件仅供消费方可观测/埋点;assistant 消息带 suggestions 即渲染,不再限链尾——历史消息同样显示;正文打字效果完成后才渲染) |
|
|
541
541
|
| message-complete | (message) 链尾 assistant 生成完成 |
|
|
542
542
|
| error | (err, message?) 生成出错 |
|
|
543
543
|
| branch-change | (dir, message) 分支切换 |
|
|
@@ -612,9 +612,9 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
612
612
|
| timeFormat | (message, timestamp) => string | undefined | 消息时间自定义格式化(透传 AiMessage) |
|
|
613
613
|
| autoCollapse | boolean | true | 正文出完自动收起思考链(透传 AiMessage;status 落 done 且正文打完才收;error 不收) |
|
|
614
614
|
| resolveFileUrl | (file: ChatFile) => Promise\<string\> \| string | undefined | 附件地址解析钩子(透传 AiMessage;鉴权取流换可直渲地址,见 AiChat) |
|
|
615
|
-
| followupStyle | 'list' \| 'chips' | 'list' | 追问建议展示样式(透传 AiMessage;默认 'list'
|
|
615
|
+
| followupStyle | 'list' \| 'chips' | 'list' | 追问建议展示样式(透传 AiMessage;默认 'list' 纵向列表——顶部灰色分隔线 + 加粗「追问」标题(字号/颜色随正文)、条目 100% 宽下划线分隔字号随正文;'chips' 旧横向气泡,见 AiChat)。**正文打字效果完成后才渲染**(流式 suggestions 事件到达不显示) |
|
|
616
616
|
| feedbackHandler | (message, action, comment?) => Promise\<unknown\> \| unknown | undefined | 消息评价提交钩子(透传 AiMessage;语义见 AiChat,缺省不渲染 👍/👎) |
|
|
617
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
617
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
618
618
|
|
|
619
619
|
| Event | 说明 |
|
|
620
620
|
| --- | --- |
|
|
@@ -673,18 +673,18 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
673
673
|
| showTime | boolean | true | 显示消息时间(操作区按钮之后;时间源:message.createdTime(秒级/毫秒级时间戳或 ISO 字符串自动识别)优先,缺省回落 message.createdAt;两者皆无则不渲染。助手消息 SSE 生成中不显示,正文打完字(未启用打字机则落定)后才显示;error 即显;user 消息恒显示) |
|
|
674
674
|
| timeFormat | (message, timestamp) => string | undefined | 消息时间自定义格式化(透传消息与已归一为 ms 的时间戳;缺省 'YYYY-MM-DD HH:mm',本机时区) |
|
|
675
675
|
| codeTriggerLangs | string[] | — | 代码块「预览」触发语言(透传 Markdown/Typewriter;命中语言的代码块右上角注入按钮,点击行为由消费方事件委托实现) |
|
|
676
|
-
| followupStyle | 'list' \| 'chips' | 'list' | 追问建议展示样式:'list'(默认)纵向列表一行一条,渲染在操作区(工具栏)下方,顶部灰色分隔线 +
|
|
676
|
+
| followupStyle | 'list' \| 'chips' | 'list' | 追问建议展示样式:'list'(默认)纵向列表一行一条,渲染在操作区(工具栏)下方,顶部灰色分隔线 + **加粗**「追问」标题(字号/颜色随正文,经语言包 `aiMessage.followupsTitle` 自定义),条目 100% 宽、下划线分隔、字号随正文;'chips' 旧横向气泡形态(换行铺排,无标题)。assistant 消息带 suggestions 即渲染——历史消息同样显示,不再限链尾;**正文打字效果完成后才渲染**(流式 suggestions 事件到达不显示,落定+打完字整体浮现) |
|
|
677
677
|
| resolveFileUrl | (file: ChatFile) => Promise\<string\> \| string | undefined | 附件地址解析钩子:渲染附件 url 前调用,返回可直渲地址(如 JWT fetch 换 blob objectURL);缺省原样使用 url(blob/dataURL/公开地址),远端地址解析结果按 url 缓存 + 在途去重,失败回落原 url |
|
|
678
678
|
| feedbackHandler | (message, action: 'LIKE' \| 'DISLIKE' \| 'CLEAR', comment?) => Promise\<unknown\> \| unknown | undefined | 消息评价提交钩子:仅 assistant 最终回答行(role=assistant 且 status=done,error/中断/生成中不渲染)渲染 👍/👎,缺省不渲染按钮。点击 👍 直接提交,点击 👎 弹**居中附言弹窗**(ElDialog,textarea ≤500 字 + 提交/跳过,点遮罩/ESC 关闭草稿保留、再点 👎 复填),再次点击当前态按钮发 CLEAR;乐观更新——先翻转 message.feedback 再调钩子,失败回滚并经 feedback-error 上抛,成功经 feedback-change 上抛;返回 resolved 即成功,返回错误文案串/抛错均视为失败。**弹窗标题/占位可自定义**(语言包 `aiMessage.feedback.dislikeTitle`/`dislikePlaceholder`;标题 `{name}` 占位渲染时替换为 assistantName,空串回落 defaultAssistantName) |
|
|
679
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
679
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
680
680
|
|
|
681
681
|
> 用户消息操作区:恒渲染复制按钮,默认透明,鼠标移上消息(或键盘聚焦)时浮现(open-webui 交互)。
|
|
682
682
|
|
|
683
683
|
| Event | 说明 |
|
|
684
684
|
| --- | --- |
|
|
685
685
|
| copy / regenerate / branch-change | (message) / (message) / (dir, message) |
|
|
686
|
-
| followup-select | (item, message) 点击追问建议(item 为建议文本;assistant 消息带 suggestions
|
|
687
|
-
| file-click | (file, message) 点击附件:图片缩略图默认打开内置 ElImageViewer 放大(同消息多图轮播,url 经 resolveFileUrl 解析);文档附件渲染为 FilesCard 卡片(类型图标 + 名称/大小,复用输入区同款)
|
|
686
|
+
| followup-select | (item, message) 点击追问建议(item 为建议文本;assistant 消息带 suggestions 即渲染——历史消息同样显示,不限链尾;**正文打字效果完成后才渲染**,落定后可点;AiChat 内部已接住转 send,直接用 AiMessage 时的消费方需自行接管发送) |
|
|
687
|
+
| file-click | (file, message) 点击附件:图片缩略图默认打开内置 ElImageViewer 放大(同消息多图轮播,url 经 resolveFileUrl 解析);文档附件渲染为 FilesCard 卡片(类型图标 + 名称/大小,复用输入区同款),卡片右上角 28px 下载按钮(hover 浮现)——点击内置触发浏览器下载(url 经 resolveFileUrl 解析),不触发本事件;点击卡片本体仅上抛本事件(无内置下载行为,宿主可埋点/接管) |
|
|
688
688
|
| feedback-change | (message, action: 'LIKE' \| 'DISLIKE' \| 'CLEAR') 评价提交成功(乐观落定后触发;message.feedback 已更新,宿主可埋点/联动) |
|
|
689
689
|
| feedback-error | (message: string) 评价提交失败(钩子 reject/返回错误文案;乐观更新已回滚,message 为错误文案) |
|
|
690
690
|
| typing | 打字机输出中(流式期间节奏性触发) |
|
|
@@ -696,7 +696,7 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
696
696
|
| assistant-avatar | 自定义助手头像(作用域 { status, message },status 为 thinking/done/error,可按状态换头像;优先于 assistantAvatar props;未传插槽且未传 assistantAvatar 时内置头像本身随状态切换) |
|
|
697
697
|
| user-name | 自定义用户名称(作用域 { message };优先于 userName props) |
|
|
698
698
|
| assistant-name | 自定义助手名称(作用域 { message };优先于 assistantName props) |
|
|
699
|
-
| message-files | 自定义附件渲染(作用域 { message, files };默认:图片缩略图按钮(点击内置放大预览),文档 FilesCard 卡片(类型图标 +
|
|
699
|
+
| message-files | 自定义附件渲染(作用域 { message, files };默认:图片缩略图按钮(点击内置放大预览),文档 FilesCard 卡片(类型图标 + 名称/大小,复用输入区同款,卡片右上 28px 下载按钮 hover 浮现可下载);user 消息只传附件无文字时不渲染空正文气泡) |
|
|
700
700
|
| message-actions | 自定义操作区(作用域 { message }) |
|
|
701
701
|
|
|
702
702
|
| Ref | 说明 |
|
|
@@ -712,7 +712,7 @@ Artifacts 预览面板(iframe 沙箱,从消息 ```html / ```svg 代码块提取)
|
|
|
712
712
|
| --- | --- | --- | --- |
|
|
713
713
|
| artifacts | AiArtifactItem[] | [] | artifact 列表 { key(必填), type: 'html'/'svg', content, title? } |
|
|
714
714
|
| activeKey | string | '' | 当前展示的 key;为空时面板隐藏 |
|
|
715
|
-
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en-
|
|
715
|
+
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
716
716
|
|
|
717
717
|
| Event | 说明 |
|
|
718
718
|
| --- | --- |
|
|
@@ -730,17 +730,19 @@ Artifacts 预览面板(iframe 沙箱,从消息 ```html / ```svg 代码块提取)
|
|
|
730
730
|
聊天编排:发送 → 流式回填 → 队列/重生成/续写。
|
|
731
731
|
|
|
732
732
|
```ts
|
|
733
|
-
import { useChat, zhCN,
|
|
733
|
+
import { useChat, zhCN, en, ko, vi, zhHK } from '@fv-ui/ai-chat' // 内置语言包(可换成自建包)
|
|
734
|
+
|
|
735
|
+
const lang = ref<'zh-CN' | 'en' | 'ko' | 'vi' | 'zh-HK'>('zh-CN')
|
|
734
736
|
|
|
735
|
-
const
|
|
737
|
+
const LOCALES = { 'zh-CN': zhCN, en, ko, vi, 'zh-HK': zhHK }
|
|
736
738
|
|
|
737
739
|
const chat = useChat({
|
|
738
740
|
adapter: () => OpenAIAdapter({ baseURL, apiKey }), // 实例或工厂;工厂每次 send 惰性取用
|
|
739
741
|
models: () => selectedModels.value, // 数组或工厂;多模型并行生成兄弟分支
|
|
740
742
|
initial: { messages, currentId }, // 恢复会话
|
|
741
743
|
onToolEvent: (ev) => { /* Fv 系通用 tool{status},展示「正在查询库存…」*/ },
|
|
742
|
-
// 语言包工厂:返回 LocaleMessages 包对象(
|
|
743
|
-
locale: () =>
|
|
744
|
+
// 语言包工厂:返回 LocaleMessages 包对象(内置包或自建包),非语言名字符串
|
|
745
|
+
locale: () => LOCALES[lang.value]
|
|
744
746
|
})
|
|
745
747
|
// chat: { send, stop, regenerate, continueGenerate, enqueue, queue, isLoading,
|
|
746
748
|
// msgs, messages, currentId, chain }
|
|
@@ -770,9 +772,9 @@ const adapter = FvCommonAdapter({
|
|
|
770
772
|
- 同步段失败(Content-Type 非 `text/event-stream`)按 JSON 错误 `{code,message}` 走 `onError`;命中 `errorMessages` 时用映射文案(带 `code` 的 `FvCommonError`)
|
|
771
773
|
- `message_end` 的 `messageId`(最终文本行 id)经 `onBackendMessageId` 回填到 `MessageNode.backendId`——多轮工具循环下与 `message_start` 的首轮 id 不同,UI 落库/对账以它为准
|
|
772
774
|
- `tool` 事件经 `onTool` → `useChat.onToolEvent` → `AiChat @tool-event` 上抛,消费方展示「正在查询库存…」等中间态
|
|
773
|
-
- 追问建议(V58+):`suggestions` 事件(流式收尾 0..1 次,最后一个 delta 后、message_end 前,载荷 `{items: string[]}`)经可选 `onSuggestions` 上抛,`useChat` 回写 `MessageNode.suggestions`,AiMessage 对带 suggestions 的 assistant 消息渲染追问(
|
|
775
|
+
- 追问建议(V58+):`suggestions` 事件(流式收尾 0..1 次,最后一个 delta 后、message_end 前,载荷 `{items: string[]}`)经可选 `onSuggestions` 上抛,`useChat` 回写 `MessageNode.suggestions`,AiMessage 对带 suggestions 的 assistant 消息渲染追问(默认纵向列表样式——顶部灰色分隔线 + 加粗「追问」标题、条目 100% 宽下划线分隔字号随正文,`followupStyle='chips'` 切回横向气泡;**正文打字效果完成后才渲染**,流式事件到达不显示,历史消息同样渲染,不再限链尾);开关关闭/模型未产出/中断/失败无此事件;历史恢复用导出的 `parseSuggestions(raw)` 安全解析 `FvCommonMessage.suggestions`(JSON 数组原文透传,脏数据按无建议)
|
|
774
776
|
- 消息评价(V58+):`FvCommonMessage.feedback`(LIKE/DISLIKE,未评价/旧数据恒 null)、`feedbackComment`(附言 ≤500 字)、`feedbackTime`(评价落库时间)三字段同款容错;历史恢复由消费方映射为 `MessageNode.feedback` 灌入展示;评价提交走独立端点(POST /message/feedback),不经本适配器——接 `AiChat` 的 `feedbackHandler` 钩子即可
|
|
775
|
-
- 附件快照(1.4.1+):user 行 `FvCommonMessage.attachments`(id/originalName/type/suffix/sizeBytes/downloadUrl,旧数据/无附件恒 null),历史回放映射 `MessageNode.files` 渲染(图片缩略图 + 文档 FilesCard
|
|
777
|
+
- 附件快照(1.4.1+):user 行 `FvCommonMessage.attachments`(id/originalName/type/suffix/sizeBytes/downloadUrl,旧数据/无附件恒 null),历史回放映射 `MessageNode.files` 渲染(图片缩略图 + 文档 FilesCard 卡片,卡片右上 28px 下载按钮 hover 浮现可下载;downloadUrl 需鉴权取流时配 `resolveFileUrl` 钩子,下载/预览均走解析后地址)
|
|
776
778
|
- 配套 DTO 类型:`FvCommonSessionItem` / `FvCommonMessage` / `FvCommonSessionDetail` / `FvCommonMessagePage`(消费方直接调会话管理端点时用)
|
|
777
779
|
|
|
778
780
|
### useMessages(initial?)
|
|
@@ -859,14 +861,14 @@ const myAdapter: ChatAdapter = {
|
|
|
859
861
|
|
|
860
862
|
## 国际化(i18n)
|
|
861
863
|
|
|
862
|
-
|
|
864
|
+
内置五份语言包:`zh-CN`(默认,零配置)、`en`、`ko`、`vi`、`zh-HK`;所有组件文案(按钮 aria/tooltip、状态文案、MessageBox、错误提示、发给模型的续写 prompt)均从语言包读取。
|
|
863
865
|
|
|
864
866
|
### 全局设置(推荐)
|
|
865
867
|
|
|
866
868
|
```ts
|
|
867
869
|
import { configureLocale } from '@fv-ui/ai-chat'
|
|
868
870
|
|
|
869
|
-
configureLocale('en
|
|
871
|
+
configureLocale('en') // 整库切英文;configureLocale('zh-CN') 切回,可选 'ko'/'vi'/'zh-HK'
|
|
870
872
|
```
|
|
871
873
|
|
|
872
874
|
### 组件级 prop
|
|
@@ -875,7 +877,7 @@ configureLocale('en-US') // 整库切英文;configureLocale('zh-CN') 切回
|
|
|
875
877
|
|
|
876
878
|
```vue
|
|
877
879
|
<!-- 整包切换(优先级最高) -->
|
|
878
|
-
<FvAiChat locale="en
|
|
880
|
+
<FvAiChat locale="en" ... />
|
|
879
881
|
|
|
880
882
|
<!-- 部分覆盖:在当前生效语言上深合并,只改指定文案 -->
|
|
881
883
|
<FvAiChat :locale="{ aiMessage: { regenerate: '重答' }, sender: { send: 'GO' } }" ... />
|
|
@@ -901,10 +903,12 @@ configureLocale(jaJP)
|
|
|
901
903
|
|
|
902
904
|
### 语言包 key 一览
|
|
903
905
|
|
|
904
|
-
|
|
906
|
+
下表列出 zh-CN 与 en 两列对照;`ko`/`vi`/`zh-HK` 词条与之一一同构,详见语言包源文件 `src/locale/{ko,vi,zh-HK}.ts`。
|
|
907
|
+
|
|
908
|
+
| 分组 | key | zh-CN | en |
|
|
905
909
|
| --- | --- | --- | --- |
|
|
906
910
|
| common | copy / delete / confirm / cancel / retry / close / preview / clear / stop / send / download / fullscreen / collapse / expand | 复制 / 删除 / 确定 / 取消 / 重传 / 关闭 / 预览 / 清空 / 停止 / 发送 / 下载 / 全屏 / 收起 / 展开 | Copy / Delete / OK / Cancel / Retry / Close / Preview / Clear / Stop / Send / Download / Fullscreen / Collapse / Expand |
|
|
907
|
-
| thinking | start / thinking / end / error / endWithTools / thinkingItem / thoughtDoneItem | 开始思考 / 思考中... / 思考完成 / 思考遇到问题 / 思考完成,使用 {n} 个工具 / 正在思考 / 思考完成 | Thinking / Thinking... / Thought complete / Something went wrong / Thought complete, used {n} tools / Thinking / Thought complete |
|
|
911
|
+
| thinking | start / thinking / end / interrupted / error / endWithTools / interruptedWithTools / thinkingItem / thoughtDoneItem | 开始思考 / 思考中... / 思考完成 / 思考中断 / 思考遇到问题 / 思考完成,使用 {n} 个工具 / 思考中断,使用 {n} 个工具 / 正在思考 / 思考完成 | Thinking / Thinking... / Thought complete / Thought interrupted / Something went wrong / Thought complete, used {n} tools / Thought interrupted, used {n} tools / Thinking / Thought complete |
|
|
908
912
|
| welcome | greetingPrefix / greetingName / description | 你好,我是 ␣ / Gizmo / 我可以帮你查询数据、分析问题、生成报表、以及执行系统操作,让生产管理更高效。 | Hello, I am ␣ / Gizmo / I can help you query data, analyze problems, generate reports, and perform system operations... |
|
|
909
913
|
| sender | clear / stop / send / speech / recordCancel / recordConfirm / micUnavailable / inputPlaceholder | 清空 / 停止 / 发送 / 语音输入 / 取消录音 / 确认录音 / 无法访问麦克风 / 输入你的问题,查询数据、分析问题或生成报表… | Clear / Stop / Send / Voice input / Cancel recording / Confirm recording / Microphone unavailable / Ask a question — query data, analyze problems, or generate reports… |
|
|
910
914
|
| editorSender | clear / stop / send / inputPlaceholder / selectTagTitle / loading / tagTip | 清空 / 停止 / 发送 / 请输入 / 选择标签 / 加载中… / 填写内容后回车确认 | Clear / Stop / Send / Type something... / Select a tag / Loading... / Type and press Enter to confirm |
|
|
@@ -1002,7 +1006,7 @@ A:FvMarkdown 依赖浏览器 `window`(DOMPurify 消毒),不支持服务端首渲
|
|
|
1002
1006
|
|
|
1003
1007
|
## 类型与导出
|
|
1004
1008
|
|
|
1005
|
-
包入口导出全部组件、`useChat`/`useMessages`/`useXStream`/`useSend`/`XRequest`/`useRecord`、`OpenAIAdapter`、`FvCommonAdapter`(+ `FvCommonError` 及配套 DTO 类型)、`parseSuggestions`(追问建议 JSON 安全解析)、`createMessageTree`、`createLocalStorageAdapter`/`createMemoryAdapter`、`createSSEParser`、`configureLocale`/`zhCN`/`
|
|
1009
|
+
包入口导出全部组件、`useChat`/`useMessages`/`useXStream`/`useSend`/`XRequest`/`useRecord`、`OpenAIAdapter`、`FvCommonAdapter`(+ `FvCommonError` 及配套 DTO 类型)、`parseSuggestions`(追问建议 JSON 安全解析)、`createMessageTree`、`createLocalStorageAdapter`/`createMemoryAdapter`、`createSSEParser`、`configureLocale`/`zhCN`/`en`/`ko`/`vi`/`zhHK`(国际化)及全部公共类型(`MessageNode`、`ChatAdapter`、`ChatFile`、`MessageFeedback`、`FeedbackHandler`、`MessageUsage`、`SSEEvent`、`LocaleMessages`、`LocaleCode`、`LocaleInput`、`DeepPartialLocale` 等),消费方:
|
|
1006
1010
|
|
|
1007
1011
|
```ts
|
|
1008
1012
|
import { FvAiChat, OpenAIAdapter, useChat } from '@fv-ui/ai-chat'
|