@legendzd/ai-agent-vue 1.0.1 → 1.0.6

package/README.md

@@ -42,15 +42,18 @@ app.use(AgentPlugin, {
 app.mount('#app')
 ```
 
-在模板中直接使用（插件注册后组件全局可用）：
+在模板中直接使用（插件注册后组件全局可用，自动继承全局配置）：
 
 ```vue
 <template>
-  <!-- 按钮弹窗布局（默认） -->
+  <!-- 按钮弹窗布局（默认），自动继承全局注册的 apiUrl/userId -->
   <AgentChat />
 
   <!-- 等价于 -->
   <AgentChatPopup />
+
+  <!-- 如需覆盖某项配置，只需传递对应字段即可 -->
+  <AgentChat :config="{ headerTitle: 'AI 助手' }" />
 </template>
 ```
 
@@ -80,6 +83,15 @@ import '@legendzd/ai-agent-vue/dist/style.css'
 右下角浮动按钮 + 弹出式聊天窗口，适合嵌入任意页面。
 
 ```vue
+<!-- 已全局注册过配置时，直接使用即可 -->
+<AgentChatPopup />
+
+<!-- 或覆盖特定配置 -->
+<AgentChatPopup :config="{
+  userId: 'user456',
+}" />
+
+<!-- 未全局注册时，需通过 config 传入必要配置 -->
 <AgentChatPopup :config="{
   apiUrl: 'http://your-server/api/v2',
   userId: 'user123',
@@ -96,6 +108,14 @@ import '@legendzd/ai-agent-vue/dist/style.css'
 左侧历史侧栏 + 右侧聊天窗口，适合作为独立聊天页面使用。
 
 ```vue
+<!-- 已全局注册过配置时 -->
+<AgentChatFull
+  :show-sidebar="true"
+  sidebar-width="280px"
+  sidebar-position="left"
+/>
+
+<!-- 未全局注册时 -->
 <AgentChatFull
   :config="{ apiUrl: 'http://your-server/api/v2', userId: 'user123' }"
   :show-sidebar="true"
@@ -122,6 +142,13 @@ import '@legendzd/ai-agent-vue/dist/style.css'
 全屏聊天 + 底部抽屉式历史面板，适配移动端安全区域。
 
 ```vue
+<!-- 已全局注册过配置时 -->
+<AgentChatMobile
+  safe-area-top="env(safe-area-inset-top, 0px)"
+  safe-area-bottom="env(safe-area-inset-bottom, 0px)"
+/>
+
+<!-- 未全局注册时 -->
 <AgentChatMobile
   :config="{ apiUrl: 'http://your-server/api/v2', userId: 'user123' }"
   safe-area-top="env(safe-area-inset-top, 0px)"
@@ -368,7 +395,7 @@ API 层优先使用 `getUserId()`，若未提供则 fallback 到 `userId` 静态
 
 ### config prop 合并规则
 
-组件同时支持顶层 props 和 `config` prop，`config` 优先：
+配置按优先级从高到低合并：**组件 config prop > 组件顶层 props > 全局插件注册 > 默认值**
 
 ```vue
 <!-- 两种写法等价 -->
@@ -380,6 +407,11 @@ API 层优先使用 `getUserId()`，若未提供则 fallback 到 `userId` 静态
   user-id="fallback"
   :config="{ userId: 'priority' }"
 />
+
+<!-- 全局注册的配置自动继承，组件只需覆盖差异项 -->
+<!-- 假设 app.use(AgentPlugin, { apiUrl: 'http://...', userId: 'user123' }) -->
+<AgentChat :config="{ headerTitle: 'AI 助手' }" />
+<!-- 等价于 { apiUrl: 'http://...', userId: 'user123', headerTitle: 'AI 助手' } -->
 ```
 
 ## 组件实例 API
@@ -541,9 +573,9 @@ const chatRef = ref()
 
 | 功能 | 方法 | 完整路径 |
 |---|---|---|
-| 创建会话 | POST | `${apiUrl}/agent/chat/session` |
-| 流式对话 | POST | `${apiUrl}/agent/chat/chat/stream` |
-| 获取历史 | GET | `${apiUrl}/agent/chat/sessions?userId=xxx` |
+| 创建会话 | POST | `${apiUrl}/external/chat/session` |
+| 流式对话 | POST | `${apiUrl}/external/query-data/stream` |
+| 获取历史 | GET | `${apiUrl}/external/chat/sessions?userId=xxx` |
 
 ### SSE 事件类型