Revamp documentation structure in mkdocs.yml by reorganizing navigation for improved accessibility. Remove outdated content from previous sections and introduce new topics including detailed guides on assistant management, configuration options, and tool integrations. Enhance API reference documentation with comprehensive error codes and WebSocket protocol details. Add new sections for automated testing, data analysis, and knowledge base management, ensuring a cohesive and user-friendly documentation experience.
This commit is contained in:
@@ -1,6 +1,4 @@
|
||||
# AI Video Assistant 使用说明
|
||||
|
||||
## 产品概述
|
||||
# AI Video Assistant
|
||||
|
||||
AI Video Assistant 是一款基于大语言模型的智能对话与工作流管理平台,支持多模型集成、语音合成、自动化测试等功能,帮助企业快速构建智能客服系统。
|
||||
|
||||
@@ -10,190 +8,51 @@ AI Video Assistant 是一款基于大语言模型的智能对话与工作流管
|
||||
|
||||
| 功能模块 | 描述 |
|
||||
|---------|------|
|
||||
| **仪表盘** | 实时数据统计与可视化分析 |
|
||||
| **助手管理** | 创建、配置、测试 AI 助手 |
|
||||
| **工作流** | 可视化流程编排 |
|
||||
| **模型库** | LLM/ASR/语音模型配置 |
|
||||
| **知识库** | RAG 文档知识管理 |
|
||||
| **历史记录** | 对话日志查询与分析 |
|
||||
| **自动化测试** | 批量测试与质量评估 |
|
||||
| **仪表盘** | 实时数据统计与可视化分析 |
|
||||
|
||||
## 快速开始
|
||||
## 快速导航
|
||||
|
||||
### 环境要求
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- Node.js 18+
|
||||
- 现代浏览器(Chrome/Firefox/Edge)
|
||||
- :rocket: **[快速开始](quickstart/index.md)**
|
||||
|
||||
### 启动服务
|
||||
5 分钟创建你的第一个 AI 助手
|
||||
|
||||
```bash
|
||||
cd web
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
- :wrench: **[安装部署](getting-started/index.md)**
|
||||
|
||||
访问 `http://localhost:3000`
|
||||
环境准备与安装配置
|
||||
|
||||
## 详细使用指南
|
||||
- :robot: **[助手管理](assistants/index.md)**
|
||||
|
||||
### 1. 仪表盘
|
||||
创建和配置智能对话助手
|
||||
|
||||

|
||||
- :gear: **[功能定制](customization/knowledge-base.md)**
|
||||
|
||||
仪表盘展示系统核心指标:
|
||||
- **总对话数** - 累计对话请求数量
|
||||
- **回答率** - 成功回答的对话占比
|
||||
- **平均时长** - 单次对话平均持续时间
|
||||
- **人工转接率** - 需要人工介入的对话比例
|
||||
知识库、工具、语音、工作流
|
||||
|
||||
### 2. 助手管理
|
||||
- :bar_chart: **[数据分析](analysis/dashboard.md)**
|
||||
|
||||

|
||||
仪表盘、历史记录、测试评估
|
||||
|
||||
#### 创建助手
|
||||
- :book: **[API 参考](api-reference/index.md)**
|
||||
|
||||
1. 点击 **创建助手**
|
||||
2. 配置助手基本信息(名称、提示词)
|
||||
3. 选择对话语言与音色
|
||||
4. 绑定知识库和工具
|
||||
WebSocket 协议与接口文档
|
||||
|
||||
#### 配置选项
|
||||
- :cloud: **[部署指南](deployment/index.md)**
|
||||
|
||||
| 标签页 | 配置项 |
|
||||
|-------|--------|
|
||||
| 全局 | 名称、提示词、温度参数 |
|
||||
| 语音 | TTS 引擎、音色、语言 |
|
||||
| 工具 | 可用工具列表 |
|
||||
| 知识 | RAG 知识库关联 |
|
||||
| 链接 | 外部服务配置 |
|
||||
Docker、Nginx 生产部署
|
||||
|
||||
### 3. 工作流
|
||||
- :question: **[常见问题](resources/faq.md)**
|
||||
|
||||

|
||||
使用问题与故障排查
|
||||
|
||||
#### 工作流节点类型
|
||||
|
||||
| 节点 | 功能 |
|
||||
|------|------|
|
||||
| 对话节点 | AI 自动回复 |
|
||||
| 工具节点 | 调用外部工具 |
|
||||
| 人工节点 | 转接人工客服 |
|
||||
| 结束节点 | 结束对话流程 |
|
||||
|
||||
### 4. 模型配置
|
||||
|
||||

|
||||
|
||||
#### 支持的 LLM 模型
|
||||
|
||||
- **OpenAI** - GPT-4/GPT-3.5
|
||||
- **DeepSeek** - DeepSeek Chat
|
||||
- **SiliconFlow** - 多种开源模型
|
||||
- **Google Gemini** - Gemini Pro
|
||||
|
||||
#### ASR 语音识别
|
||||
|
||||
- **Whisper** - OpenAI 语音识别
|
||||
- **SenseVoice** - 高精度中文识别
|
||||
|
||||
### 5. 知识库
|
||||
|
||||

|
||||
|
||||
#### 创建知识库
|
||||
|
||||
1. 进入 **知识库** 页面
|
||||
2. 点击 **新建知识库**
|
||||
3. 上传文档(支持 Markdown/PDF/TXT)
|
||||
4. 配置检索参数
|
||||
|
||||
### 6. 历史记录
|
||||
|
||||

|
||||
|
||||
查询条件:
|
||||
- 按时间范围筛选
|
||||
- 按助手名称搜索
|
||||
- 查看对话详情与统计
|
||||
|
||||
### 7. 自动化测试
|
||||
|
||||

|
||||
|
||||
#### 测试类型
|
||||
|
||||
| 类型 | 说明 |
|
||||
|------|------|
|
||||
| 固定测试 | 预设问答对测试 |
|
||||
| 智能测试 | AI 生成测试用例 |
|
||||
|
||||
#### 评估指标
|
||||
|
||||
- 回复准确率
|
||||
- 回答完整度
|
||||
- 响应时间
|
||||
|
||||
### 8. 语音合成
|
||||
|
||||

|
||||
|
||||
#### 支持的 TTS 引擎
|
||||
|
||||
- **阿里云** - 多音色可选
|
||||
- **火山引擎** - 高自然度
|
||||
- **Minimax** - 低延迟
|
||||
|
||||
### 9. 个人中心
|
||||
|
||||

|
||||
|
||||
管理账户信息与系统设置。
|
||||
|
||||
## 部署指南
|
||||
|
||||
### 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)
|
||||
- 确认语言设置匹配
|
||||
</div>
|
||||
|
||||
## 技术支持
|
||||
|
||||
|
||||
Reference in New Issue
Block a user