diff --git a/docs/README.md b/docs/README.md index 7d8b3af..037132f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1,7 @@ -# Documentation \ No newline at end of file +# Documentation + +部署 MkDocs: +pip install mkdocs +mkdocs serve + +访问 http://localhost:8000 查看文档网站。 \ No newline at end of file diff --git a/docs/content/deployment.md b/docs/content/deployment.md new file mode 100644 index 0000000..82ec939 --- /dev/null +++ b/docs/content/deployment.md @@ -0,0 +1,95 @@ +# 部署指南 + +## 方式一:Docker 部署(推荐) + +### 1. 构建镜像 + +```bash +docker build -t ai-video-assistant-web ./web +``` + +### 2. 运行容器 + +```bash +docker run -d \ + --name ai-assistant-web \ + -p 3000:80 \ + ai-video-assistant-web +``` + +### 3. 使用 Docker Compose + +```yaml +version: '3.8' + +services: + web: + build: ./web + ports: + - "3000:80" + environment: + - VITE_API_URL=http://api:8080 +``` + +运行: +```bash +docker-compose up -d +``` + +## 方式二:Nginx 部署 + +### 1. 构建前端 + +```bash +cd web +npm run build +``` + +### 2. 配置 Nginx + +```nginx +server { + listen 80; + server_name your-domain.com; + root /var/www/ai-assistant/dist; + index index.html; + + location / { + try_files $uri $uri/ /index.html; + } + + location /api { + proxy_pass http://localhost:8080; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + } +} +``` + +### 3. 启动 Nginx + +```bash +sudo nginx -t +sudo systemctl reload nginx +``` + +## 环境变量配置 + +| 变量 | 说明 | 默认值 | +|------|------|--------| +| VITE_API_URL | 后端 API 地址 | http://localhost:8080 | +| VITE_GEMINI_API_KEY | Gemini API Key | - | + +## 验证部署 + +1. 访问 http://your-domain.com +2. 检查页面是否正常加载 +3. 验证各功能模块是否可用 + +## 故障排查 + +| 问题 | 解决方案 | +|------|---------| +| 页面空白 | 检查浏览器控制台错误 | +| API 请求失败 | 确认 VITE_API_URL 配置正确 | +| 静态资源 404 | 检查 nginx try_files 配置 | diff --git a/docs/content/features/assistants.md b/docs/content/features/assistants.md new file mode 100644 index 0000000..13cfdef --- /dev/null +++ b/docs/content/features/assistants.md @@ -0,0 +1,65 @@ +# 助手管理 + +助手是 AI Video Assistant 的核心模块,用于创建和配置智能对话机器人。 + +## 创建助手 + +![助手管理](../images/assistants.png) + +### 基本配置 + +1. 进入 **助手管理** 页面 +2. 点击 **新建助手** 按钮 +3. 填写基本信息: + +| 配置项 | 说明 | +|-------|------| +| 助手名称 | 唯一标识,用于区分不同助手 | +| 提示词 | 定义助手的角色和行为 | +| 温度参数 | 控制回复的随机性(0-1) | + +### 配置标签页 + +#### 全局设置 + +- 设置助手的核心对话能力 +- 配置上下文长度 +- 设置对话开场白 + +#### 语音配置 + +| 配置 | 说明 | +|------|------| +| TTS 引擎 | 选择语音合成服务(阿里/火山/Minimax) | +| 音色 | 选择语音风格和性别 | +| 语速 | 语音播放速度 | +| 音量 | 语音输出音量 | + +#### 工具绑定 + +- 配置助手可调用的外部工具 +- 启用/禁用特定功能模块 + +#### 知识关联 + +- 关联 RAG 知识库 +- 配置检索参数(相似度阈值、返回数量) + +#### 外部链接 + +- 配置第三方服务集成 +- 设置 Webhook 回调 + +## 调试助手 + +在助手详情页可进行实时调试: +- 文本对话测试 +- 语音输入测试 +- 工具调用验证 + +## 发布助手 + +配置完成后: +1. 点击 **保存** +2. 点击 **发布** +3. 获取 API 调用地址 diff --git a/docs/content/features/autotest.md b/docs/content/features/autotest.md new file mode 100644 index 0000000..87fd601 --- /dev/null +++ b/docs/content/features/autotest.md @@ -0,0 +1,59 @@ +# 自动化测试 + +自动化测试帮助评估助手质量,确保对话效果符合预期。 + +## 概述 + +![自动化测试](../images/autotest.png) + +## 测试类型 + +### 固定测试 + +预设问答对进行批量测试: +- 预先准备测试用例 +- 支持期望答案对比 +- 显示通过/失败状态 + +### 智能测试 + +AI 自动生成测试用例: +- 基于知识库内容生成问题 +- 多角度覆盖测试 +- 发现潜在问题 + +## 创建测试 + +### 步骤 + +1. 进入 **自动化测试** 页面 +2. 点击 **新建测试** +3. 选择测试类型 +4. 选择要测试的助手 +5. 配置测试参数 +6. 启动测试 + +### 测试配置 + +| 参数 | 说明 | +|------|------| +| 并发数 | 同时进行的测试数量 | +| 超时时间 | 单次对话超时限制 | +| 评分阈值 | 判断通过的分数字 | + +## 测试结果 + +### 评估指标 + +| 指标 | 说明 | +|------|------| +| 准确率 | 回答正确的比例 | +| 完整度 | 回答信息是否完整 | +| 相关度 | 回复与问题的相关性 | +| 响应时间 | 平均回复耗时 | + +### 查看详情 + +- 单条测试详情 +- 错误分析 +- 改进建议 diff --git a/docs/content/features/dashboard.md b/docs/content/features/dashboard.md new file mode 100644 index 0000000..66c5739 --- /dev/null +++ b/docs/content/features/dashboard.md @@ -0,0 +1,27 @@ +# 仪表盘 + +仪表盘提供系统运行状态的实时概览,帮助管理员快速掌握核心指标。 + +## 数据指标 + +![仪表盘](../images/dashboard.png) + +### 核心指标卡 + +| 指标 | 说明 | +|------|------| +| **总对话数** | 系统累计处理的对话请求总数 | +| **回答率** | AI 成功回答的对话占比(不含转人工) | +| **平均时长** | 单次对话从开始到结束的平均秒数 | +| **人工转接率** | 需要人工介入处理的对话比例 | + +### 实时数据 + +- 数据每 5 秒自动刷新 +- 支持切换时间范围查看历史趋势 + +## 使用建议 + +1. 每日查看回答率变化,及时发现异常 +2. 关注人工转接率,优化知识库覆盖 +3. 分析平均时长,调整回复策略 diff --git a/docs/content/features/history.md b/docs/content/features/history.md new file mode 100644 index 0000000..c617284 --- /dev/null +++ b/docs/content/features/history.md @@ -0,0 +1,46 @@ +# 历史记录 + +历史记录保存所有对话日志,支持查询、统计和分析。 + +## 查看历史 + +![历史记录](../images/history.png) + +### 筛选条件 + +| 条件 | 说明 | +|------|------| +| 时间范围 | 按开始/结束时间筛选 | +| 助手 | 选择特定助手 | +| 关键词 | 搜索对话内容 | +| 状态 | 全部/成功/人工 | + +### 列表字段 + +| 字段 | 说明 | +|------|------| +| 对话 ID | 唯一标识符 | +| 助手名称 | 处理的 AI 助手 | +| 开始时间 | 对话起始时间 | +| 持续时长 | 对话持续时间 | +| 状态 | 正常/人工/异常 | + +## 对话详情 + +点击任意记录可查看: +- 完整对话内容 +- 用户/助手消息时间线 +- 音频/视频附件(如有) +- 系统日志 + +## 导出数据 + +支持导出为: +- CSV 格式(表格数据) +- JSON 格式(完整日志) + +## 数据统计 + +- 按日/周/月统计对话量 +- 分析高峰时段 +- 导出报表 diff --git a/docs/content/features/knowledge.md b/docs/content/features/knowledge.md new file mode 100644 index 0000000..8678f6a --- /dev/null +++ b/docs/content/features/knowledge.md @@ -0,0 +1,53 @@ +# 知识库 + +知识库基于 RAG(检索增强生成)技术,让 AI 能够回答私有领域问题。 + +## 概述 + +![知识库](../images/knowledge.png) + +## 创建知识库 + +### 步骤 + +1. 进入 **知识库** 页面 +2. 点击 **新建知识库** +3. 填写知识库名称 +4. 上传文档 + +### 支持格式 + +| 格式 | 说明 | +|------|------| +| Markdown | 最佳选择,格式清晰 | +| PDF | 自动提取文本 | +| TXT | 纯文本支持 | +| Word | 需转换为其他格式 | + +### 文档上传 + +- 拖拽上传或点击选择 +- 单文件大小限制 10MB +- 建议单文档不超过 50000 字 + +## 配置检索参数 + +| 参数 | 说明 | 默认值 | +|------|------|--------| +| 相似度阈值 | 低于此分数的结果不返回 | 0.7 | +| 返回数量 | 单次检索返回的结果数 | 3 | +| 分块大小 | 文档分块的最大长度 | 500 | + +## 管理知识库 + +- **查看文档** - 浏览已上传的文件 +- **删除文档** - 移除不需要的内容 +- **更新文档** - 重新上传覆盖 +- **测试检索** - 验证知识库效果 + +## 关联助手 + +在助手配置的 **知识** 标签页中: +1. 选择要关联的知识库 +2. 设置检索策略 +3. 保存配置 diff --git a/docs/content/features/models.md b/docs/content/features/models.md new file mode 100644 index 0000000..f149c81 --- /dev/null +++ b/docs/content/features/models.md @@ -0,0 +1,44 @@ +# 模型配置 + +## LLM 模型库 + +![LLM模型库](../images/llms.png) + +### 支持的模型 + +| 供应商 | 模型 | 特点 | +|--------|------|------| +| **OpenAI** | GPT-4 / GPT-3.5 | 通用能力强 | +| **DeepSeek** | DeepSeek Chat | 高性价比 | +| **SiliconFlow** | 多种开源模型 | 本地部署友好 | +| **Google** | Gemini Pro | 多模态支持 | + +### 配置步骤 + +1. 进入 **LLM 库** 页面 +2. 点击 **添加模型** +3. 选择供应商 +4. 填写 API Key 和 Endpoint +5. 设置默认参数 + +### 参数说明 + +| 参数 | 说明 | 建议值 | +|------|------|--------| +| Temperature | 随机性 | 0.7 | +| Max Tokens | 最大输出长度 | 2048 | +| Top P | 核采样 | 0.9 | + +## ASR 语音识别 + +### 支持引擎 + +- **Whisper** - OpenAI 通用语音识别 +- **SenseVoice** - 高精度中文语音识别 + +### 配置方法 + +1. 进入 **ASR 库** 页面 +2. 选择识别引擎 +3. 配置音频参数(采样率、编码) +4. 测试识别效果 diff --git a/docs/content/features/voices.md b/docs/content/features/voices.md new file mode 100644 index 0000000..866b682 --- /dev/null +++ b/docs/content/features/voices.md @@ -0,0 +1,58 @@ +# 语音合成 + +语音合成(TTS)模块提供自然流畅的语音输出能力。 + +## 概述 + +![语音合成](../images/voices.png) + +## 支持的引擎 + +| 供应商 | 特点 | 适用场景 | +|--------|------|---------| +| **阿里云** | 多音色、高自然度 | 通用场景 | +| **火山引擎** | 低延迟、实时性好 | 实时对话 | +| **Minimax** | 高性价比 | 批量合成 | + +## 配置方法 + +### 添加语音配置 + +1. 进入 **语音库** 页面 +2. 点击 **添加语音** +3. 选择供应商 +4. 填写 API 凭证 +5. 保存配置 + +### 测试语音 + +- 在线预览发音效果 +- 调整语速和音量 +- 切换不同音色 + +## 音色选择 + +### 中文音色 + +| 音色 | 风格 | +|------|------| +| 晓晓 | 标准女声 | +| 晓北 | 知性女声 | +| 逍遥 | 青年男声 | +| 丫丫 | 活泼童声 | + +### 英文音色 + +| 音色 | 风格 | +|------|------| +| Joanna | 专业女声 | +| Matthew | 沉稳男声 | +| Amy | 亲切女声 | + +## 参数调优 + +| 参数 | 范围 | 说明 | +|------|------|------| +| 语速 | 0.5-2.0 | 1.0 为正常速度 | +| 音量 | 0-100 | 输出音量百分比 | +| 音调 | 0.5-2.0 | 语音音调高低 | diff --git a/docs/content/features/workflows.md b/docs/content/features/workflows.md new file mode 100644 index 0000000..d0803a7 --- /dev/null +++ b/docs/content/features/workflows.md @@ -0,0 +1,53 @@ +# 工作流管理 + +工作流提供可视化的对话流程编排能力,支持复杂的业务场景。 + +## 概述 + +![工作流](../images/workflows.png) + +## 节点类型 + +| 节点 | 图标 | 功能说明 | +|------|------|---------| +| **对话节点** | 💬 | AI 自动回复,可设置回复策略 | +| **工具节点** | 🔧 | 调用外部 API 或自定义工具 | +| **人工节点** | 👤 | 转接人工客服 | +| **结束节点** | 🏁 | 结束对话流程 | + +## 创建工作流 + +### 步骤 + +1. 进入 **工作流** 页面 +2. 点击 **新建工作流** +3. 从左侧拖拽节点到画布 +4. 连接节点建立流程 +5. 配置各节点参数 +6. 保存并发布 + +### 节点配置 + +#### 对话节点配置 + +- 回复模板 +- 条件分支 +- 知识库检索 + +#### 工具节点配置 + +- 选择工具类型 +- 配置输入参数 +- 设置输出处理 + +#### 人工节点配置 + +- 转接规则 +- 排队策略 +- 通知设置 + +## 流程测试 + +- 支持单步调试 +- 可查看执行日志 +- 实时验证流程逻辑 diff --git a/docs/content/getting-started.md b/docs/content/getting-started.md new file mode 100644 index 0000000..107ee81 --- /dev/null +++ b/docs/content/getting-started.md @@ -0,0 +1,59 @@ +# 快速开始 + +## 环境准备 + +### 前置条件 + +| 软件 | 版本要求 | +|------|---------| +| Node.js | 18.0 或更高 | +| npm/yarn/pnpm | 最新版本 | +| 现代浏览器 | Chrome 90+ / Firefox 90+ / Edge 90+ | + +### 检查环境 + +```bash +node --version +npm --version +``` + +## 安装步骤 + +### 1. 克隆项目 + +```bash +git clone https://github.com/your-repo/AI-VideoAssistant.git +cd AI-VideoAssistant +``` + +### 2. 安装依赖 + +```bash +cd web +npm install +``` + +### 3. 配置环境变量 + +创建 `.env` 文件: + +```env +VITE_API_URL=http://localhost:8080 +VITE_GEMINI_API_KEY=your_api_key_here +``` + +### 4. 启动开发服务器 + +```bash +npm run dev +``` + +访问 http://localhost:3000 + +## 构建生产版本 + +```bash +npm run build +``` + +构建产物在 `dist` 目录。 diff --git a/docs/content/images/assistants.png b/docs/content/images/assistants.png new file mode 100644 index 0000000..2b94106 Binary files /dev/null and b/docs/content/images/assistants.png differ diff --git a/docs/content/images/autotest.png b/docs/content/images/autotest.png new file mode 100644 index 0000000..898bc84 Binary files /dev/null and b/docs/content/images/autotest.png differ diff --git a/docs/content/images/dashboard.png b/docs/content/images/dashboard.png new file mode 100644 index 0000000..735c813 Binary files /dev/null and b/docs/content/images/dashboard.png differ diff --git a/docs/content/images/history.png b/docs/content/images/history.png new file mode 100644 index 0000000..808b708 Binary files /dev/null and b/docs/content/images/history.png differ diff --git a/docs/content/images/knowledge.png b/docs/content/images/knowledge.png new file mode 100644 index 0000000..808b708 Binary files /dev/null and b/docs/content/images/knowledge.png differ diff --git a/docs/content/images/llms.png b/docs/content/images/llms.png new file mode 100644 index 0000000..808b708 Binary files /dev/null and b/docs/content/images/llms.png differ diff --git a/docs/content/images/profile.png b/docs/content/images/profile.png new file mode 100644 index 0000000..898bc84 Binary files /dev/null and b/docs/content/images/profile.png differ diff --git a/docs/content/images/voices.png b/docs/content/images/voices.png new file mode 100644 index 0000000..898bc84 Binary files /dev/null and b/docs/content/images/voices.png differ diff --git a/docs/content/images/workflows.png b/docs/content/images/workflows.png new file mode 100644 index 0000000..25ea199 Binary files /dev/null and b/docs/content/images/workflows.png differ diff --git a/docs/content/index.md b/docs/content/index.md new file mode 100644 index 0000000..09e86c8 --- /dev/null +++ b/docs/content/index.md @@ -0,0 +1,200 @@ +# AI Video Assistant 使用说明 + +## 产品概述 + +AI Video Assistant 是一款基于大语言模型的智能对话与工作流管理平台,支持多模型集成、语音合成、自动化测试等功能,帮助企业快速构建智能客服系统。 + +![仪表盘](images/dashboard.png) + +## 核心功能 + +| 功能模块 | 描述 | +|---------|------| +| **仪表盘** | 实时数据统计与可视化分析 | +| **助手管理** | 创建、配置、测试 AI 助手 | +| **工作流** | 可视化流程编排 | +| **模型库** | LLM/ASR/语音模型配置 | +| **知识库** | RAG 文档知识管理 | +| **历史记录** | 对话日志查询与分析 | +| **自动化测试** | 批量测试与质量评估 | + +## 快速开始 + +### 环境要求 + +- Node.js 18+ +- 现代浏览器(Chrome/Firefox/Edge) + +### 启动服务 + +```bash +cd web +npm install +npm run dev +``` + +访问 `http://localhost:3000` + +## 详细使用指南 + +### 1. 仪表盘 + +![仪表盘](images/dashboard.png) + +仪表盘展示系统核心指标: +- **总对话数** - 累计对话请求数量 +- **回答率** - 成功回答的对话占比 +- **平均时长** - 单次对话平均持续时间 +- **人工转接率** - 需要人工介入的对话比例 + +### 2. 助手管理 + +![助手管理](images/assistants.png) + +#### 创建助手 + +1. 点击 **创建助手** +2. 配置助手基本信息(名称、提示词) +3. 选择对话语言与音色 +4. 绑定知识库和工具 + +#### 配置选项 + +| 标签页 | 配置项 | +|-------|--------| +| 全局 | 名称、提示词、温度参数 | +| 语音 | TTS 引擎、音色、语言 | +| 工具 | 可用工具列表 | +| 知识 | RAG 知识库关联 | +| 链接 | 外部服务配置 | + +### 3. 工作流 + +![工作流管理](images/workflows.png) + +#### 工作流节点类型 + +| 节点 | 功能 | +|------|------| +| 对话节点 | AI 自动回复 | +| 工具节点 | 调用外部工具 | +| 人工节点 | 转接人工客服 | +| 结束节点 | 结束对话流程 | + +### 4. 模型配置 + +![模型库](images/llms.png) + +#### 支持的 LLM 模型 + +- **OpenAI** - GPT-4/GPT-3.5 +- **DeepSeek** - DeepSeek Chat +- **SiliconFlow** - 多种开源模型 +- **Google Gemini** - Gemini Pro + +#### ASR 语音识别 + +- **Whisper** - OpenAI 语音识别 +- **SenseVoice** - 高精度中文识别 + +### 5. 知识库 + +![知识库](images/knowledge.png) + +#### 创建知识库 + +1. 进入 **知识库** 页面 +2. 点击 **新建知识库** +3. 上传文档(支持 Markdown/PDF/TXT) +4. 配置检索参数 + +### 6. 历史记录 + +![历史记录](images/history.png) + +查询条件: +- 按时间范围筛选 +- 按助手名称搜索 +- 查看对话详情与统计 + +### 7. 自动化测试 + +![自动化测试](images/autotest.png) + +#### 测试类型 + +| 类型 | 说明 | +|------|------| +| 固定测试 | 预设问答对测试 | +| 智能测试 | AI 生成测试用例 | + +#### 评估指标 + +- 回复准确率 +- 回答完整度 +- 响应时间 + +### 8. 语音合成 + +![语音合成](images/voices.png) + +#### 支持的 TTS 引擎 + +- **阿里云** - 多音色可选 +- **火山引擎** - 高自然度 +- **Minimax** - 低延迟 + +### 9. 个人中心 + +![个人中心](images/profile.png) + +管理账户信息与系统设置。 + +## 部署指南 + +### Docker 部署(推荐) + +```bash +# 构建镜像 +docker build -t ai-video-assistant . + +# 运行容器 +docker run -d -p 3000:3000 --name ai-assistant ai-video-assistant +``` + +### Nginx 反向代理 + +```nginx +server { + listen 80; + server_name your-domain.com; + + location / { + proxy_pass http://localhost:3000; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + } +} +``` + +## 常见问题 + +### Q: 如何配置 API Key? + +进入 **LLM 库** 或 **语音库** 页面,点击对应模型的配置按钮填写 API Key。 + +### Q: 助手无法回复? + +1. 检查模型配置是否正确 +2. 确认知识库已正确关联 +3. 查看系统日志排查错误 + +### Q: 语音识别不准确? + +- 确认 ASR 模型选择正确 +- 检查音频采样率(推荐 16kHz) +- 确认语言设置匹配 + +## 技术支持 + +如有问题,请提交 Issue 或联系技术支持团队。 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..00115aa --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,21 @@ +site_name: "AI Video Assistant" +site_description: "AI 视频助手 - 智能对话与工作流管理平台" +copyright: "2025" +site_author: "AI Video Assistant Team" + +docs_dir: "content" +site_dir: "site" + +nav: + - 首页: "index.md" + - 快速开始: "getting-started.md" + - 功能介绍: + - 仪表盘: "features/dashboard.md" + - 助手管理: "features/assistants.md" + - 工作流: "features/workflows.md" + - 模型配置: "features/models.md" + - 知识库: "features/knowledge.md" + - 历史记录: "features/history.md" + - 自动化测试: "features/autotest.md" + - 语音合成: "features/voices.md" + - 部署指南: "deployment.md"