gimc-ai-agent 1.0.0 → 1.0.2

package/README.md

@@ -39,28 +39,22 @@ app.mount('#app')
 
 ```vue
 <template>
-  <!-- 建议配合登录状态控制显示 -->
-  <GimcAiAgent
+  <!-- 需要配合登录状态控制显示 -->
+  <gimc-ai-agent
     v-if="isLoggedIn"
-    ref="agentRef"
     :rag-knowledge-id="1"
-    :token="userToken"
-    title="智能客服"
-    @send="onSend"
-    @feedback="onFeedback"
-    @satisfaction="onSatisfaction"
+    :token="token"
   />
 </template>
 
 <script setup lang="ts">
 import { ref, computed } from 'vue'
 import { GimcAiAgent } from 'gimc-ai-agent'
-import type { FeedbackData } from 'gimc-ai-agent'
 
 const agentRef = ref()
 
 // 登录状态判断（根据实际业务修改）
-const userToken = computed(() => localStorage.getItem('token') || '')
+const token = computed(() => localStorage.getItem('token') || '')
 const isLoggedIn = computed(() => !!userToken.value)
 
 // 事件监听
@@ -84,37 +78,16 @@ const clearMessages = () => agentRef.value?.clearMessages()
 </script>
 ```
 
-## 完整安装步骤总结
-
-```bash
-# 1. 安装组件和依赖
-npm install gimc-ai-agent element-plus @element-plus/icons-vue
-
-# 2. 在 main.ts 中配置
-#    - 引入 ElementPlus 并 use
-#    - 引入 'element-plus/dist/index.css'
-#    - 引入 'gimc-ai-agent/dist/style.css'
-
-# 3. 在需要的页面中引入组件使用
-#    import { GimcAiAgent } from 'gimc-ai-agent'
-```
-
 ## Props
 
 | 属性 | 类型 | 默认值 | 必填 | 说明 |
 |------|------|--------|------|------|
 | `ragKnowledgeId` | `number` | - | ✅ | RAG 知识库 ID |
-| `token` | `string` | - | - | 外部系统传入的认证 token（优先级高于 localStorage） |
+| `token` | `string` | - | ✅ | 外部系统传入的认证 token（优先级高于 localStorage） |
 | `title` | `string` | `'灵犀AI小助手'` | - | 标题 |
-| `avatar` | `string` | 内置图标 | - | 头像 URL |
-| `floatIcon` | `string` | 内置图标 | - | 悬浮按钮图标 URL |
-| `position` | `{ right?: number; bottom?: number }` | `{ right: 8, bottom: 24 }` | - | 位置配置（单位：px） |
-| `width` | `number` | `560` | - | 弹窗宽度（单位：px） |
 | `welcomeText` | `string` | `'有任何问题，随时问我～'` | - | 欢迎语 |
 | `idleTimeout` | `number` | `180000` | - | 空闲超时时间（ms） |
 | `typingSpeed` | `number` | `30` | - | 打字机速度（ms） |
-| `showSatisfaction` | `boolean` | `true` | - | 是否显示满意度评价 |
-| `showFeedback` | `boolean` | `true` | - | 是否显示反馈功能 |
 
 ## Events
 
@@ -146,44 +119,6 @@ npm install gimc-ai-agent element-plus @element-plus/icons-vue
 | `clearMessages()` | 清空消息记录 |
 | `sendMessage(content: string)` | 主动发送消息 |
 
-## 类型定义
-
-```typescript
-interface Message {
-  role: 'user' | 'assistant'
-  content: string
-  timestamp?: string
-  showFeedback?: boolean
-  feedback?: 'resolved' | 'unresolved' | null
-  suggestions?: string[]
-  isTyping?: boolean
-}
-
-interface Article {
-  title: string
-  url: string
-}
-
-interface QuickAction {
-  label: string
-  icon?: string
-  onClick?: () => void
-  url?: string
-}
-
-interface FeedbackData {
-  messageId: string
-  type: string
-  resolved: boolean
-  detail?: string
-}
-
-interface Position {
-  right?: number
-  bottom?: number
-}
-```
-
 ## 登录状态控制
 
 组件本身不包含登录校验逻辑，建议在业务系统中通过 `v-if` 控制显示：
@@ -191,14 +126,14 @@ interface Position {
 ```vue
 <template>
   <!-- 方式1：使用 Pinia store -->
-  <GimcAiAgent
+  <gimc-ai-agent
     v-if="userStore.isLoggedIn"
     :rag-knowledge-id="1"
     :token="userStore.token"
   />
 
   <!-- 方式2：使用 computed token 判断 -->
-  <GimcAiAgent
+  <gimc-ai-agent
     v-if="!!token"
     :rag-knowledge-id="1"
     :token="token"
@@ -224,9 +159,10 @@ const token = computed(() => localStorage.getItem('token'))
 
 ```vue
 <template>
-  <GimcAiAgent
+  <gimc-ai-agent
+    v-if="token"
     :rag-knowledge-id="1"
-    :token="externalToken"
+    :token="token"
   />
 </template>
 
@@ -264,7 +200,7 @@ localStorage.setItem('gimc-ai-agent-token', 'your-token-here')
 ## 自定义插槽示例
 
 ```vue
-<GimcAiAgent :rag-knowledge-id="1" :token="token">
+<gimc-ai-agent v-if="token" :rag-knowledge-id="1" :token="token">
   <template #float-button>
     <div class="custom-button">
       <img src="/custom-icon.png" />
@@ -277,23 +213,9 @@ localStorage.setItem('gimc-ai-agent-token', 'your-token-here')
       <p>我可以帮你解答各种问题</p>
     </div>
   </template>
-</GimcAiAgent>
+</gimc-ai-agent>
 ```
 
-## 后端接口要求
-
-组件会调用以下后端接口（基于配置的 API 地址）：
-
-- `POST /api/rag-knowledge/answer/stream` - 流式问答接口
-- `GET /api/rag-knowledge/session/list` - 获取会话列表
-- `GET /api/rag-knowledge/session/messages` - 获取历史消息
-- `GET /api/rag-knowledge/questions/suggested` - 获取推荐问题
-- `GET /api/rag-knowledge/questions/recommended` - 获取相关问题
-- `POST /api/rag-knowledge/feedback` - 提交反馈
-- `PUT /api/rag-knowledge/feedback` - 更新反馈
-- `DELETE /api/rag-knowledge/feedback/{id}` - 删除反馈
-- `POST /api/rag-knowledge/stop` - 停止生成
-
 ## License
 
 MIT

package/dist/components/AiAgent.vue.d.ts

@@ -61,10 +61,6 @@ declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {
     "onSession-end"?: (() => any) | undefined;
 }>, {
     title: string;
-    position: {
-        right?: number;
-        bottom?: number;
-    };
     width: number;
     welcomeText: string;
     idleTimeout: number;