Add mkdocs documentations

This commit is contained in:
Xin Wang
2026-02-08 09:33:32 +08:00
parent 803f7185c0
commit 4da6d98fc7
22 changed files with 787 additions and 1 deletions

View File

@@ -0,0 +1,65 @@
# 助手管理
助手是 AI Video Assistant 的核心模块,用于创建和配置智能对话机器人。
## 创建助手
![助手管理](../images/assistants.png)
### 基本配置
1. 进入 **助手管理** 页面
2. 点击 **新建助手** 按钮
3. 填写基本信息:
| 配置项 | 说明 |
|-------|------|
| 助手名称 | 唯一标识,用于区分不同助手 |
| 提示词 | 定义助手的角色和行为 |
| 温度参数 | 控制回复的随机性0-1 |
### 配置标签页
#### 全局设置
- 设置助手的核心对话能力
- 配置上下文长度
- 设置对话开场白
#### 语音配置
| 配置 | 说明 |
|------|------|
| TTS 引擎 | 选择语音合成服务(阿里/火山/Minimax |
| 音色 | 选择语音风格和性别 |
| 语速 | 语音播放速度 |
| 音量 | 语音输出音量 |
#### 工具绑定
- 配置助手可调用的外部工具
- 启用/禁用特定功能模块
#### 知识关联
- 关联 RAG 知识库
- 配置检索参数(相似度阈值、返回数量)
#### 外部链接
- 配置第三方服务集成
- 设置 Webhook 回调
## 调试助手
在助手详情页可进行实时调试:
- 文本对话测试
- 语音输入测试
- 工具调用验证
## 发布助手
配置完成后:
1. 点击 **保存**
2. 点击 **发布**
3. 获取 API 调用地址

View File

@@ -0,0 +1,59 @@
# 自动化测试
自动化测试帮助评估助手质量,确保对话效果符合预期。
## 概述
![自动化测试](../images/autotest.png)
## 测试类型
### 固定测试
预设问答对进行批量测试:
- 预先准备测试用例
- 支持期望答案对比
- 显示通过/失败状态
### 智能测试
AI 自动生成测试用例:
- 基于知识库内容生成问题
- 多角度覆盖测试
- 发现潜在问题
## 创建测试
### 步骤
1. 进入 **自动化测试** 页面
2. 点击 **新建测试**
3. 选择测试类型
4. 选择要测试的助手
5. 配置测试参数
6. 启动测试
### 测试配置
| 参数 | 说明 |
|------|------|
| 并发数 | 同时进行的测试数量 |
| 超时时间 | 单次对话超时限制 |
| 评分阈值 | 判断通过的分数字 |
## 测试结果
### 评估指标
| 指标 | 说明 |
|------|------|
| 准确率 | 回答正确的比例 |
| 完整度 | 回答信息是否完整 |
| 相关度 | 回复与问题的相关性 |
| 响应时间 | 平均回复耗时 |
### 查看详情
- 单条测试详情
- 错误分析
- 改进建议

View File

@@ -0,0 +1,27 @@
# 仪表盘
仪表盘提供系统运行状态的实时概览,帮助管理员快速掌握核心指标。
## 数据指标
![仪表盘](../images/dashboard.png)
### 核心指标卡
| 指标 | 说明 |
|------|------|
| **总对话数** | 系统累计处理的对话请求总数 |
| **回答率** | AI 成功回答的对话占比(不含转人工) |
| **平均时长** | 单次对话从开始到结束的平均秒数 |
| **人工转接率** | 需要人工介入处理的对话比例 |
### 实时数据
- 数据每 5 秒自动刷新
- 支持切换时间范围查看历史趋势
## 使用建议
1. 每日查看回答率变化,及时发现异常
2. 关注人工转接率,优化知识库覆盖
3. 分析平均时长,调整回复策略

View File

@@ -0,0 +1,46 @@
# 历史记录
历史记录保存所有对话日志,支持查询、统计和分析。
## 查看历史
![历史记录](../images/history.png)
### 筛选条件
| 条件 | 说明 |
|------|------|
| 时间范围 | 按开始/结束时间筛选 |
| 助手 | 选择特定助手 |
| 关键词 | 搜索对话内容 |
| 状态 | 全部/成功/人工 |
### 列表字段
| 字段 | 说明 |
|------|------|
| 对话 ID | 唯一标识符 |
| 助手名称 | 处理的 AI 助手 |
| 开始时间 | 对话起始时间 |
| 持续时长 | 对话持续时间 |
| 状态 | 正常/人工/异常 |
## 对话详情
点击任意记录可查看:
- 完整对话内容
- 用户/助手消息时间线
- 音频/视频附件(如有)
- 系统日志
## 导出数据
支持导出为:
- CSV 格式(表格数据)
- JSON 格式(完整日志)
## 数据统计
- 按日/周/月统计对话量
- 分析高峰时段
- 导出报表

View File

@@ -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. 保存配置

View File

@@ -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. 测试识别效果

View File

@@ -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 | 语音音调高低 |

View File

@@ -0,0 +1,53 @@
# 工作流管理
工作流提供可视化的对话流程编排能力,支持复杂的业务场景。
## 概述
![工作流](../images/workflows.png)
## 节点类型
| 节点 | 图标 | 功能说明 |
|------|------|---------|
| **对话节点** | 💬 | AI 自动回复,可设置回复策略 |
| **工具节点** | 🔧 | 调用外部 API 或自定义工具 |
| **人工节点** | 👤 | 转接人工客服 |
| **结束节点** | 🏁 | 结束对话流程 |
## 创建工作流
### 步骤
1. 进入 **工作流** 页面
2. 点击 **新建工作流**
3. 从左侧拖拽节点到画布
4. 连接节点建立流程
5. 配置各节点参数
6. 保存并发布
### 节点配置
#### 对话节点配置
- 回复模板
- 条件分支
- 知识库检索
#### 工具节点配置
- 选择工具类型
- 配置输入参数
- 设置输出处理
#### 人工节点配置
- 转接规则
- 排队策略
- 通知设置
## 流程测试
- 支持单步调试
- 可查看执行日志
- 实时验证流程逻辑