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:
Xin Wang
2026-03-01 22:38:50 +08:00
parent 6a46ec69f4
commit 2418df80e5
33 changed files with 3664 additions and 693 deletions

View File

@@ -0,0 +1,110 @@
# 常见问题
## API Key 配置
### Q: 如何配置 API Key
进入 **LLM 库****语音库** 页面,点击对应模型的配置按钮填写 API Key。
**步骤:**
1. 在左侧导航栏选择 **模型配置**
2. 选择 **LLM 库****语音库**
3. 点击已添加模型的 **编辑** 按钮
4. 在 API Key 字段填写你的密钥
5. 点击 **保存**
## 助手问题
### Q: 助手无法回复?
可能的原因和解决方案:
1. **检查模型配置是否正确**
- 确认 API Key 已正确填写
- 测试模型连接是否正常
2. **确认知识库已正确关联**
- 进入助手配置的 **知识** 标签页
- 检查是否已选择知识库
3. **查看系统日志排查错误**
- 打开浏览器开发者工具F12
- 检查 Console 和 Network 标签页
### Q: 助手回复内容不相关?
- 检查系统提示词是否清晰明确
- 调整 Temperature 参数(降低可提高准确性)
- 确认知识库内容与问题相关
- 增加知识库相似度阈值
## 语音识别
### Q: 语音识别不准确?
1. **确认 ASR 模型选择正确**
- 中文场景推荐使用 SenseVoice
- 英文场景推荐使用 Whisper
2. **检查音频采样率**
- 推荐采样率16kHz
- 推荐格式PCM 16-bit
3. **确认语言设置匹配**
- 在 ASR 配置中选择正确的语言
### Q: 语音延迟较高?
- 检查网络连接稳定性
- 尝试切换 ASR 服务提供商
- 降低音频质量以减少传输数据量
## 语音合成
### Q: TTS 声音不自然?
- 尝试不同的音色选项
- 调整语速参数(推荐 0.8-1.2
- 选择与内容风格匹配的声音
### Q: TTS 无法播放?
1. 检查浏览器是否允许自动播放音频
2. 确认 TTS API Key 配置正确
3. 检查网络连接
## 知识库
### Q: 知识库检索无结果?
- 确认文档已成功上传
- 降低相似度阈值(默认 0.7
- 增加返回结果数量
- 检查文档内容是否与查询相关
### Q: 文档上传失败?
- 检查文件大小是否超过 10MB
- 确认文件格式支持MD/PDF/TXT
- 尝试减小文档内容
## 部署问题
### Q: 页面空白或加载失败?
1. 检查浏览器控制台错误信息
2. 确认后端服务已启动
3. 检查 VITE_API_URL 环境变量配置
### Q: API 请求失败?
- 确认 VITE_API_URL 配置正确
- 检查后端服务是否运行
- 查看网络请求响应状态码
### Q: 静态资源 404
- 检查 Nginx `try_files` 配置
- 确认构建产物路径正确
- 检查文件权限设置