gimc-ai-agent 1.0.27 → 1.0.29

package/README.md

@@ -2,6 +2,8 @@
 
 AI 智能客服 Vue3 组件，基于 RAG 知识库的智能问答系统。
 
+当前版本：1.0.27
+
 ## 安装
 
 ### 1. 安装组件
@@ -55,7 +57,47 @@ app.use(ElementPlus)
 app.mount('#app')
 ```
 
-### 4. 在组件中使用
+### 4. 配置环境（可选）
+
+组件默认使用生产环境配置。有两种方式配置环境：
+
+**方式1：通过 prop 传递（推荐）**
+
+```vue
+<template>
+  <gimc-ai-agent
+    :rag-knowledge-id="1"
+    :token="token"
+    :environment="env"
+  />
+</template>
+
+<script setup>
+import { computed } from 'vue'
+
+// 根据环境变量自动切换
+const env = computed(() => import.meta.env.MODE)
+</script>
+```
+
+**方式2：全局配置**
+
+```typescript
+// main.ts
+import { envConfigManager } from 'gimc-ai-agent'
+
+// 设置为开发环境
+envConfigManager.setEnvironment('development')
+
+// 或根据环境变量自动切换
+if (import.meta.env.DEV) {
+  envConfigManager.setEnvironment('development')
+}
+```
+
+> **注意**：如果同时使用两种方式，prop 方式的优先级更高，会覆盖全局配置。
+
+### 5. 在组件中使用
 
 ```vue
 <template>
@@ -64,18 +106,19 @@ app.mount('#app')
     v-if="isLoggedIn"
     :rag-knowledge-id="1"
     :token="token"
+    :environment="environment"
   />
 </template>
 
 <script setup lang="ts">
 import { ref, computed } from 'vue'
-import { GimcAiAgent } from 'gimc-ai-agent'
+import { GimcAiAgent, type FeedbackData } from 'gimc-ai-agent'
 
 const agentRef = ref()
 
 // 登录状态判断（根据实际业务修改）
 const token = computed(() => localStorage.getItem('token') || '')
-const isLoggedIn = computed(() => !!userToken.value)
+const isLoggedIn = computed(() => !!token.value)
 
 // 事件监听
 const onSend = (msg: string) => {
@@ -104,10 +147,17 @@ const clearMessages = () => agentRef.value?.clearMessages()
 |------|------|--------|------|------|
 | `ragKnowledgeId` | `number` | - | ✅ | RAG 知识库 ID |
 | `token` | `string` | - | ✅ | 外部系统传入的认证 token（优先级高于 localStorage） |
+| `environment` | `'development' \| 'production'` | `'production'` | ✅ | 环境标识（推荐通过 prop 传递，也可通过 envConfigManager 全局设置） |
 | `title` | `string` | `'灵犀AI小助手'` | - | 标题 |
-| `welcomeText` | `string` | `'有任何问题，随时问我～'` | - | 欢迎语 |
+| `avatar` | `string` | - | - | 头像 URL |
+| `floatIcon` | `string` | - | - | 悬浮按钮图标 URL |
+| `position` | `{ right?: number; bottom?: number }` | - | - | 位置配置 |
+| `width` | `number` | `560` | - | 弹窗宽度（px） |
+| `welcomeText` | `string` | `'灵犀AI小助手已全新上线...'` | - | 欢迎语 |
 | `idleTimeout` | `number` | `180000` | - | 空闲超时时间（ms） |
-| `typingSpeed` | `number` | `10` | - | 打字机速度（ms） |
+| `typingSpeed` | `number` | `5` | - | 打字机速度（ms） |
+| `showSatisfaction` | `boolean` | `true` | - | 是否显示满意度评价 |
+| `showFeedback` | `boolean` | `true` | - | 是否显示反馈功能 |
 
 ## Events
 
@@ -208,15 +258,89 @@ localStorage.setItem('gimc-ai-agent-token', 'your-token-here')
 - 如果同时存在 `token` prop 和 localStorage 中的 token，优先使用 `token` prop
 - 这样可以确保外部系统集成时的灵活性
 
+## 环境配置 API
+
+组件提供了环境配置管理器 `envConfigManager`，用于切换开发/生产环境：
+
+```typescript
+import { envConfigManager } from 'gimc-ai-agent'
+
+// 设置环境
+envConfigManager.setEnvironment('development') // 或 'production'
+
+// 获取当前环境
+const env = envConfigManager.getEnvironment()
+
+// 获取完整配置
+const config = envConfigManager.getConfig()
+
+// 获取具体配置项
+const apiUrl = envConfigManager.getApiUrl()
+const projectName = envConfigManager.getProjectName()
+const tokenName = envConfigManager.getTokenName()
+```
+
+### 环境配置说明
+
+| 环境 | API URL | 项目名称 | Token 名称 |
+|------|---------|----------|-----------|
+| development | `http://dev-api.gw.gimccloud.com:32619/lxai-web-api` | 省广智能客服 | gimc-ai-agent |
+| production | `https://api.gimccloud.com/lxai-web-api/` | 灵犀AI后台管理 | gimc-lxai-admin-front |
+
 ## RAG 知识库配置
 
 本组件需要配合 RAG 知识库后端使用。确保：
 
 1. 后端已部署 RAG 知识库服务
 2. 创建知识库并获取 `ragKnowledgeId`
-3. 配置好后端 API 地址（通过环境变量）
+3. 配置好环境（通过 `envConfigManager` 设置）
 4. 确保用户已通过认证（提供有效的 token）
 
+## 导出内容
+
+组件提供以下导出内容：
+
+### 组件
+```typescript
+import { GimcAiAgent, AiAgent } from 'gimc-ai-agent'
+// GimcAiAgent 和 AiAgent 是同一个组件的两个导出名称
+```
+
+### 类型定义
+```typescript
+import type {
+  Message,           // 消息类型
+  Article,           // 文章类型
+  QuickAction,       // 快捷操作类型
+  AiResponse,        // AI 响应类型
+  FeedbackData,      // 反馈数据类型
+  Position,          // 位置配置
+  SatisfactionOption,// 满意度选项
+  FeedbackTypeOption,// 反馈类型选项
+  Environment,       // 环境类型
+  ApiConfig          // API 配置接口
+} from 'gimc-ai-agent'
+```
+
+### 工具和配置
+```typescript
+import {
+  envConfigManager,    // 环境配置管理器
+  defaultFloatIcon,    // 默认悬浮按钮图标
+  defaultAvatarIcon    // 默认头像图标
+} from 'gimc-ai-agent'
+```
+
+### Vue 插件方式使用
+```typescript
+// main.ts
+import { createApp } from 'vue'
+import GimcAiAgentPlugin from 'gimc-ai-agent'
+
+const app = createApp(App)
+app.use(GimcAiAgentPlugin) // 全局注册为 GimcAiAgent
+```
+
 ## 自定义插槽示例
 
 ```vue
@@ -236,6 +360,22 @@ localStorage.setItem('gimc-ai-agent-token', 'your-token-here')
 </gimc-ai-agent>
 ```
 
+## 依赖说明
+
+### 核心依赖
+- `axios`: ^1.13.2 - HTTP 请求库
+- `dompurify`: 3.3.1 - HTML 内容安全过滤
+- `highlight.js`: ^11.11.1 - 代码高亮
+- `marked`: ^5.1.2 - Markdown 解析
+
+### 对等依赖（需要项目安装）
+- `vue`: ^3.3.0
+- `element-plus`: ^2.0.0
+- `@element-plus/icons-vue`: ^2.0.0
+
+### Node 版本要求
+- Node.js >= 16.0.0
+
 ## License
 
 MIT