g-ai-robot3 0.1.94 → 0.1.96

package/README.md

@@ -10,6 +10,7 @@
 - 可配置对话框主题、气泡、数字人画布与样式
 - 内置工作流关键词触发
 - 统一 API 前缀便于本地代理
+
 ## 安装
 
 ```bash
@@ -18,17 +19,13 @@ npm install g-ai-robot3 --save
 
 ## 快速开始
 
-在入口文件中注册组件并引入样式：
-
-```ts
-// main.ts
-import GAiRobot3 from "g-ai-robot3";
-import "g-ai-robot3/dist/index.css";
-```
-
 在页面中使用组件（最小必填配置）：
 
 ```vue
+<script setup lang="ts">
+import GAiRobot3 from "g-ai-robot3";
+import "g-ai-robot3/dist/index.css";
+</script>
 <template>
   <GAiRobot3
     :cozeInfo="{ bot_id: '7429224296222097443' }"
@@ -102,7 +99,7 @@ const aiEventFun = computed(() => {
 </template>
 ```
 
-## 代理与跨域示例（Vite）
+## 前端代理与跨域示例（Vite）
 
 ```ts
 // vite.config.ts
@@ -110,7 +107,7 @@ export default defineConfig({
   server: {
     proxy: {
       "/api21215": {
-        target: "http://your-backend-host",
+        target: "http://your-backend-host", // 默认https://model.keepsoft.net:39002
         changeOrigin: true,
         rewrite: (path) => path.replace(/^\/api21215/, ""),
       },
@@ -125,7 +122,8 @@ export default defineConfig({
 | ----------- | ------------ | ------ | ------------------- | --------------------------------------- |
 | `cozeInfo`  | 智能体配置   | object | `{ bot_id: '...' }` | `bot_id`必须替换为实际的智能体 id       |
 | `apiPrefix` | API 基础路径 | string | `-`                 | 必须配置为你的代理前缀（如`/api21215`） |
-| `apiPrefix` | API 基础路径 | string | `'/api21215'`       | 可通过本地代理或环境变量覆盖      |
+| `apiPrefix` | API 基础路径 | string | `'/api21215'`       | 可通过本地代理或环境变量覆盖            |
+
 说明：其他参数均有默认值，按需覆盖即可（建议保持数字人宽高与样式一致以避免拉伸）。
 | `canvasHeight` | 画布高度 | number | `180` | 必须与 `videoStyle`、`digitalStyle.height` 一致 |
 | `videoStyle` | 视频样式 | CSSProperties | `{ width: '180px', visibility: 'hidden' }` | `width` 与 `canvasWidth` 一致 |
@@ -142,7 +140,7 @@ export default defineConfig({
 | `showMsgBubble`    | 是否显示消息气泡                     | boolean | `true`                                 |
 | `isExhibitionPro`  | 是否为数字展厅项目                   | boolean | `false`                                |
 | `isShowDialogIcon` | 是否显示对话框图标                   | boolean | `false`                                |
-| `stream`           | 是否启用流式传输                     | string  | `'True'`                               |
+| `stream`           | 是否启用流式传输（已废弃）                     | string  | `'True'`                               |
 | `title`            | 对话框标题                           | string  | `'GR水利大模型'`                       |
 | `greet`            | 欢迎语（文本对话框）                 | string  | `'您好,我是GR水利大模型智能小助手...'` |
 | `welcomeMessage`   | 欢迎消息（气泡对话框）               | string  | `'您好,我是GR水利大模型智能小助手...'` |
@@ -191,8 +189,9 @@ export default defineConfig({
 | `bubbleTheme`     | 气泡主题             | string        | `'dark'`                            |
 | `useCustomDialog` | 是否使用自定义对话框 | boolean       | `false`                             |
 | `BubbleWidth`     | 气泡容器样式         | CSSProperties | `{ width: '220px', bottom: '85%' }` |
-| `BubbleWidth`     | 气泡宽度             | number  | `220`    |
-| `BubbleBottom`    | 气泡底部距离         | number  | `85`     |
+| `BubbleWidth`     | 气泡宽度             | number        | `220`                               |
+| `BubbleBottom`    | 气泡底部距离         | number        | `85`                                |
+
 - 组件会将后端返回的关联问题（如 `questions` 列表）整合为可点击项，点击后自动填充并发送。
 
 用途：引导用户进行更深入或相关的追问，提升对话效率。
@@ -222,7 +221,18 @@ eventFun: [
 
 - 画布或视频尺寸不一致：请确保 `canvasWidth/canvasHeight` 与 `videoStyle/digitalStyle/canvasStyle` 一致。
 - 音频或 WS 连接失败：检查 `audioWs/voiceprintWs` 地址可达性。
-- 问答接口超时：确认 `apiPrefix` 代理转发配置正确。
+
+## 语音唤醒词与结束/暂停
+
+- 支持的唤醒词（对应五位数字人）：
+  - 小贵小贵
+  - 小慧小慧
+  - 小智小智
+  - 小 G 同学
+  - 小 R 同学
+- 使用方式：在空闲状态直接说出唤醒词，系统会回复“我在，请问有什么可以帮您。”并进入对话。
+- 结束词：再见、拜拜、小贵拜拜、小贵再见（任意其一即可识别，结束对话，需重新唤醒）
+- 暂停词：暂停、停止、小贵暂停、小贵停止（任意其一即可识别，暂停说话，继续监听，无需重新唤醒）
 
 ## 许可证