g-ai-robot3 1.1.1 → 1.1.3

package/LICENSE

@@ -1,21 +1,21 @@
- MIT License
-
-   Copyright (c) 2024 yuchen
-
-   Permission is hereby granted, free of charge, to any person obtaining a copy
-   of this software and associated documentation files (the "Software"), to deal
-   in the Software without restriction, including without limitation the rights
-   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-   copies of the Software, and to permit persons to whom the Software is
-   furnished to do so, subject to the following conditions:
-
-   The above copyright notice and this permission notice shall be included in all
-   copies or substantial portions of the Software.
-
-   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ MIT License
+
+   Copyright (c) 2024 yuchen
+
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+   of this software and associated documentation files (the "Software"), to deal
+   in the Software without restriction, including without limitation the rights
+   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+   copies of the Software, and to permit persons to whom the Software is
+   furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included in all
+   copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.

package/README.md

@@ -77,95 +77,90 @@ export default defineConfig({
 });
 ```
 
-## 默认内部配置
-
-以下默认值会随 npm 包一起发布，且都可以通过 props 覆盖：
-
-| 项目 | 默认值 |
-| --- | --- |
-| `apiPrefix` | `"/api21216"` |
-| `cozeInfo.bot_id` | `"7473691358872584226"` |
-| `createConversationUrl` | `${apiPrefix}/chatGlm/createConversation` |
-| `qaServer` | `${apiPrefix}/chatGlm/searchTextNew` |
-| `interrupt` | `${apiPrefix}/chatGlm/cancelChat` |
-| `wakeupAudio` | `${apiPrefix}/asr/saveWakeUpAudio` |
-| `offer` | `${apiPrefix}/metahuman/offer` |
-| `humanaudio` | `${apiPrefix}/metahuman/humanaudio` |
-| `stop_audio` | `${apiPrefix}/metahuman/stop_audio` |
-| `textDriven` | `${apiPrefix}/intelligentVoice/tts` |
-| `audioWs` | `wss://model.keepsoft.net:39002/funasrWs` |
-| `voiceprintWs` | `wss://model.keepsoft.net:39002/speakerWs` |
-| `instructWs` | `wss://model.keepsoft.net:39002/commandWs` |
-
 ## 常用 Props
 
-### 核心配置
-
-| 参数 | 类型 | 默认值 | 说明 |
-| --- | --- | --- | --- |
-| `cozeInfo` | `{ bot_id: string }` | 内置默认值 | 智能体配置，建议显式传入 |
-| `apiPrefix` | `string` | `"/api21216"` | API 基础前缀 |
-| `modelType` | `"local" \| "online"` | `"online"` | 模型类型 |
-| `showModelTypeToggle` | `boolean` | `false` | 是否显示本地/联网切换 |
-| `isDebug` | `boolean` | `false` | 是否打印调试信息 |
-| `mode` | `"audio" \| "text" \| "video"` | `"video"` | 交互模式 |
-| `driverMode` | `"workflow" \| "agent"` | `"workflow"` | AI 响应驱动模式，`workflow` 保持关键词工作流，`agent` 直接透传 AI JSON |
-| `data` | `Record<string, any>` | `{}` | `agent` 模式下随消息透传给后端的动态上下文 |
-
-### 对话框与数字人
-
-| 参数 | 类型 | 默认值 | 说明 |
-| --- | --- | --- | --- |
-| `placementBottom` | `number` | `100` | 对话框底部偏移 |
-| `placementLeft` | `number` | `450` | 对话框左侧偏移 |
-| `canvasWidth` | `number` | `180` | 画布宽度 |
-| `canvasHeight` | `number` | `180` | 画布高度 |
-| `videoStyle` | `CSSProperties` | `{ width: "180px", opacity: "0", pointerEvents: "none" }` | 视频样式 |
-| `digitalStyle` | `CSSProperties` | `{ width: "180px", height: "180px" }` | 数字人样式 |
-| `canvasStyle` | `CSSProperties` | `{ width: "180px", height: "180px" }` | Canvas 样式 |
-| `bubbleStyle` | `CSSProperties` | `{ width: "30%", height: "30%" }` | 状态图标样式 |
-
-### 气泡与展示型对话
-
-| 参数 | 类型 | 默认值 | 说明 |
-| --- | --- | --- | --- |
-| `showMsgBubble` | `boolean` | `true` | 是否显示悬浮气泡 |
-| `showMsgNumber` | `number` | `5` | 悬浮气泡展示条数 |
-| `bubbleTheme` | `"dark" \| "light" \| "custom"` | `"dark"` | 气泡主题 |
-| `useCustomDialog` | `boolean` | `false` | 是否使用自定义气泡样式 |
-| `BubbleWidth` | `CSSProperties` | `{ width: "220px", bottom: "85%" }` | 气泡容器样式 |
-| `BubbleBottom` | `number` | 无 | 额外气泡底部偏移 |
-| `suspensionStyle` | `CSSProperties` | `{ maxHeight: "33vh" }` | 悬浮区容器样式 |
-| `initialQuestion` | `string` | 无 | 外部传入的首条问题，仅展示不请求接口 |
-| `streamChunks` | `StreamChunk[]` | `[]` | 外部传入的单条流式消息块 |
-| `conversations` | `ConversationInput[]` | `[]` | 外部传入的多轮对话展示数据 |
-
-### 接口覆盖
-
-| 参数 | 类型 | 默认值说明 |
-| --- | --- | --- |
-| `createConversationUrl` | `string` | 默认由 `apiPrefix` 拼接 |
-| `qaServer` | `string` | 默认由 `apiPrefix` 拼接 |
-| `interrupt` | `string` | 默认由 `apiPrefix` 拼接 |
-| `wakeupAudio` | `string` | 默认由 `apiPrefix` 拼接 |
-| `audioWs` | `string` | 默认内部 WS |
-| `voiceprintWs` | `string` | 默认内部 WS |
-| `offer` | `string` | 默认由 `apiPrefix` 拼接 |
-| `human` | `string` | 默认由 `apiPrefix` 拼接 |
-| `humanaudio` | `string` | 默认由 `apiPrefix` 拼接 |
-| `stop_audio` | `string` | 默认由 `apiPrefix` 拼接 |
-| `textDriven` | `string` | 默认由 `apiPrefix` 拼接 |
+### 必填参数（Required）
+
+| 参数        | 说明         | 类型     | 默认值              | 注意事项                                                               |
+| ----------- | ------------ | -------- | ------------------- | ---------------------------------------------------------------------- |
+| `cozeInfo`  | 智能体配置   | `object` | `{ bot_id: "..." }` | `bot_id` 必须替换为实际的智能体 id                                     |
+| `apiPrefix` | API 基础路径 | `string` | `"/api21216"`       | 必须配置为你的代理前缀（如 `/api21216`），可通过本地代理或环境变量覆盖 |
+
+### 基础配置
+
+| 参数                  | 说明                                       | 类型                  | 默认值                                 |
+| --------------------- | ------------------------------------------ | --------------------- | -------------------------------------- |
+| `isDebug`             | 是否开启调试模式（打印语音输出）           | `boolean`             | `false`                                |
+| `dialogBoxTheme`      | 对话框主题                                 | `string`              | `"light"`                              |
+| `suspensionStyle`     | 对话框高度                                 | `CSSProperties`       | `{ maxHeight: "33vh" }`                |
+| `showMsgBubble`       | 是否显示消息气泡                           | `boolean`             | `true`                                 |
+| `isExhibitionPro`     | 是否为数字展厅项目                         | `boolean`             | `false`                                |
+| `isShowDialogIcon`    | 是否显示对话框图标                         | `boolean`             | `false`                                |
+| `stream`              | 是否启用流式传输（已废弃）                 | `string`              | `"True"`                               |
+| `title`               | 对话框标题                                 | `string`              | `"GR水利大模型"`                       |
+| `greet`               | 欢迎语（文本对话框）                       | `string`              | `"您好,我是GR水利大模型智能小助手..."` |
+| `welcomeMessage`      | 欢迎消息（气泡对话框）                     | `string`              | `"您好,我是GR水利大模型智能小助手..."` |
+| `waitTxt`             | 等待提示文本                               | `string`              | `"贵仁科技AI正在生成回答"`             |
+| `systemName`          | 系统标识                                   | `string`              | `"g-ai-robot3"`                        |
+| `placementBottom`     | 对话框底部距离                             | `number`              | `100`                                  |
+| `placementLeft`       | 对话框左侧距离                             | `number`              | `450`                                  |
+| `useAudio`            | 是否启用音频功能                           | `boolean`             | `true`                                 |
+| `space`               | 监听间隔（ms）（已废弃）                   | `number`              | `3000`                                 |
+| `mode`                | 交互模式（默认 `video`，其他已废弃）       | `string`              | `"video"`                              |
+| `modelType`           | 模型类型（`local` 或 `online`）            | `string`              | `"online"`                             |
+| `showModelTypeToggle` | 显示模型类型切换开关                       | `boolean`             | `false`                                |
+| `driverMode`          | AI 结果驱动模式                            | `string`              | `"workflow"`                           |
+| `data`                | `agent` 模式下随消息透传给后端的动态上下文 | `Record<string, any>` | `{}`                                   |
+
+### API 配置
+
+| 参数                    | 说明                          | 类型     | 默认值                                     |
+| ----------------------- | ----------------------------- | -------- | ------------------------------------------ |
+| `apiPrefix`             | API 基础路径（可自定义跨域）  | `string` | `"/api21216"`                              |
+| `createConversationUrl` | 创建会话接口                  | `string` | `${apiPrefix}/chatGlm/createConversation`  |
+| `wakeupAudio`           | 音频打标接口                  | `string` | `${apiPrefix}/asr/saveWakeUpAudio`         |
+| `interrupt`             | 中断请求接口                  | `string` | `${apiPrefix}/chatGlm/cancelChat`          |
+| `qaServer`              | 问答服务接口                  | `string` | `${apiPrefix}/chatGlm/searchTextNew`       |
+| `offer`                 | 数字人形象接口                | `string` | `${apiPrefix}/metahuman/offer`             |
+| `humanaudio`            | 数字人音频接口                | `string` | `${apiPrefix}/metahuman/humanaudio`        |
+| `stop_audio`            | 停止音频接口                  | `string` | `${apiPrefix}/metahuman/stop_audio`        |
+| `textDriven`            | 文本驱动接口                  | `string` | `${apiPrefix}/intelligentVoice/tts`        |
+| `audioWs`               | 语音 WebSocket 服务           | `string` | `wss://model.keepsoft.net:39002/funasrWs`  |
+| `voiceprintWs`          | 声纹识别 WebSocket 服务       | `string` | `wss://model.keepsoft.net:39002/speakerWs` |
+| `instructWs`            | 指令 WebSocket 服务（已废弃） | `string` | `wss://model.keepsoft.net:39002/commandWs` |
+
+### 数字人配置
+
+| 参数                  | 说明         | 类型            | 默认值                                                    | 注意事项                                             |
+| --------------------- | ------------ | --------------- | --------------------------------------------------------- | ---------------------------------------------------- |
+| `videoStyle`          | 视频样式     | `CSSProperties` | `{ width: "180px", opacity: "0", pointerEvents: "none" }` | 建议 `width` 与 `canvasWidth` 一致                   |
+| `digitalStyle`        | 数字人样式   | `CSSProperties` | `{ width: "180px", height: "180px" }`                     | 与 `canvasWidth` / `canvasHeight` 保持一致           |
+| `canvasStyle`         | 画布样式     | `CSSProperties` | `{ width: "180px", height: "180px" }`                     | 与 `canvasWidth` / `canvasHeight` 保持一致           |
+| `bubbleStyle`         | 气泡样式     | `CSSProperties` | `{ width: "30%", height: "30%" }`                         | -                                                    |
+| `canvasWidth`         | 画布宽度     | `number`        | `180`                                                     | 建议与 `videoStyle.width`、`digitalStyle.width` 一致 |
+| `canvasHeight`        | 画布高度     | `number`        | `180`                                                     | 建议与 `digitalStyle.height` 一致                    |
+| `canvasCartoonWidth`  | 卡通形象宽度 | `number`        | `200`                                                     | -                                                    |
+| `canvasCartoonHeight` | 卡通形象高度 | `number`        | `320`                                                     | -                                                    |
+
+### 消息气泡配置
+
+| 参数              | 说明                                   | 类型                  | 默认值                              |
+| ----------------- | -------------------------------------- | --------------------- | ----------------------------------- |
+| `showMsgNumber`   | 显示消息数量                           | `number`              | `5`                                 |
+| `bubbleTheme`     | 气泡主题                               | `string`              | `"dark"`                            |
+| `useCustomDialog` | 是否使用自定义对话框                   | `boolean`             | `false`                             |
+| `BubbleWidth`     | 气泡容器样式                           | `CSSProperties`       | `{ width: "220px", bottom: "85%" }` |
+| `BubbleBottom`    | 气泡底部距离                           | `number`              | `85`                                |
+| `initialQuestion` | 外部传入的首条问题（仅展示不请求接口） | `string`              | `-`                                 |
+| `streamChunks`    | 外部传入的单条流式消息块               | `StreamChunk[]`       | `[]`                                |
+| `conversations`   | 外部传入的多轮对话展示数据             | `ConversationInput[]` | `[]`                                |
 
 ## 类型导出
 
 本包会导出常用类型，内部项目可以直接引用：
 
 ```ts
-import type {
-  ConversationInput,
-  IndexProps,
-  StreamChunk,
-} from "g-ai-robot3";
+import type { ConversationInput, IndexProps, StreamChunk } from "g-ai-robot3";
 ```
 
 ## 工作流事件示例
@@ -193,49 +188,49 @@ const eventFun = [
 
 `driverMode` 默认为 `workflow`，老项目不需要改动。切换到 `agent` 后：
 
-- 忽略 `eventFun`
-- 不做关键词匹配
-- 每次 AI 返回 `data` 时直接触发 `agent-response`
-- 由业务层自行决定如何处理返回 JSON
-- 发送请求时 `searchText` 会升级为 `JSON.stringify({ msg, data })` 后的字符串；`msg` 为用户输入或补问组装文本，`data` 为外部传入的最新 `data` prop
-
-```vue
-<script setup lang="ts">
-import { ref } from "vue";
-
-const agentContext = ref({
-  anything: "from parent",
-});
-
-const handleAgentResponse = (params: any) => {
-  console.log("agent response", params);
-};
+- 忽略 `eventFun`
+- 不做关键词匹配
+- 每次 AI 返回 `data` 时直接触发 `agent-response`
+- 由业务层自行决定如何处理返回 JSON
+- 发送请求时 `searchText` 会升级为 `JSON.stringify({ msg, data })` 后的字符串；`msg` 为用户输入或补问组装文本，`data` 为外部传入的最新 `data` prop
+
+```vue
+<script setup lang="ts">
+import { ref } from "vue";
+
+const agentContext = ref({
+  anything: "from parent",
+});
+
+const handleAgentResponse = (params: any) => {
+  console.log("agent response", params);
+};
 </script>
 
 <template>
-  <GAiRobot3
-    mode="video"
-    driverMode="agent"
-    :data="agentContext"
-    @agent-response="handleAgentResponse"
-  />
-</template>
+  <GAiRobot3
+    mode="video"
+    driverMode="agent"
+    :data="agentContext"
+    @agent-response="handleAgentResponse"
+  />
+</template>
 ```
 
 业务侧可以直接拿到类似下面的结构：
 
 ```ts
-function handleAgentResponse(params: any) {
-  // {
-  //   reply,
-  //   targetState,
-  //   commands
-  // }
-  applyAgentResponse(params);
-}
-```
-
-`workflow` 模式继续保持旧请求结构，不启用 `{ msg, data }` 和补问组装，老项目不需要调整后端接口。
+function handleAgentResponse(params: any) {
+  // {
+  //   reply,
+  //   targetState,
+  //   commands
+  // }
+  applyAgentResponse(params);
+}
+```
+
+`workflow` 模式继续保持旧请求结构，不启用 `{ msg, data }` 和补问组装，老项目不需要调整后端接口。
 
 ## 注意事项