Update documentation for Realtime Agent Studio with enhanced content and structure
- Revised site name and description for clarity and detail. - Updated navigation structure to better reflect the organization of content. - Improved changelog entries for better readability and consistency. - Migrated assistant configuration and prompt guidelines to new documentation paths. - Enhanced core concepts section to clarify the roles and capabilities of assistants and engines. - Streamlined workflow documentation to provide clearer guidance on configuration and usage.
This commit is contained in:
Xin Wang
@@ -1,110 +1,59 @@
|
||||
# 常见问题
|
||||
# 常见问题
|
||||
|
||||
## API Key 配置
|
||||
本页只提供简短回答和跳转建议；如果你需要逐步排查，请直接进入 [故障排查](troubleshooting.md)。
|
||||
|
||||
### Q: 如何配置 API Key？
|
||||
## Q: 我应该先看哪一部分文档？
|
||||
|
||||
进入 **LLM 库** 或 **语音库** 页面，点击对应模型的配置按钮填写 API Key。
|
||||
- 想了解产品是什么：看 [产品概览](../overview/index.md)
|
||||
- 想先把服务跑起来：看 [环境与部署](../getting-started/index.md)
|
||||
- 想最快创建第一个助手：看 [快速开始](../quickstart/index.md)
|
||||
- 想系统完成助手配置：从 [助手概览](../concepts/assistants.md) 开始
|
||||
|
||||
**步骤：**
|
||||
## Q: 如何配置模型或 API Key？
|
||||
|
||||
1. 在左侧导航栏选择 **模型配置**
|
||||
2. 选择 **LLM 库** 或 **语音库**
|
||||
3. 点击已添加模型的 **编辑** 按钮
|
||||
4. 在 API Key 字段填写你的密钥
|
||||
5. 点击 **保存**
|
||||
进入对应资源页完成配置：
|
||||
|
||||
## 助手问题
|
||||
- LLM：见 [LLM 模型](../customization/models.md)
|
||||
- ASR：见 [语音识别](../customization/asr.md)
|
||||
- TTS：见 [声音资源](../customization/voices.md)
|
||||
|
||||
### Q: 助手无法回复？
|
||||
## Q: 助手为什么不回复？
|
||||
|
||||
可能的原因和解决方案：
|
||||
通常先检查三件事：
|
||||
|
||||
1. **检查模型配置是否正确**
|
||||
- 确认 API Key 已正确填写
|
||||
- 测试模型连接是否正常
|
||||
- 助手是否已绑定可用的模型资源
|
||||
- 提示词、知识库或工具是否配置完整
|
||||
- WebSocket 会话是否已经正常建立
|
||||
|
||||
2. **确认知识库已正确关联**
|
||||
- 进入助手配置的 **知识** 标签页
|
||||
- 检查是否已选择知识库
|
||||
下一步：
|
||||
|
||||
3. **查看系统日志排查错误**
|
||||
- 打开浏览器开发者工具（F12）
|
||||
- 检查 Console 和 Network 标签页
|
||||
- 助手行为验证：看 [测试调试](../concepts/assistants/testing.md)
|
||||
- 逐步排查：看 [故障排查](troubleshooting.md)
|
||||
|
||||
### Q: 助手回复内容不相关？
|
||||
## Q: 回复为什么不准确或不稳定？
|
||||
|
||||
- 检查系统提示词是否清晰明确
|
||||
- 调整 Temperature 参数（降低可提高准确性）
|
||||
- 确认知识库内容与问题相关
|
||||
- 增加知识库相似度阈值
|
||||
优先检查：
|
||||
|
||||
## 语音识别
|
||||
- 提示词是否明确了角色、任务和限制
|
||||
- 是否应该补充知识库，而不是继续堆叠提示词
|
||||
- 是否需要把复杂业务改成工作流，而不是单轮问答
|
||||
|
||||
### Q: 语音识别不准确？
|
||||
相关文档：
|
||||
|
||||
1. **确认 ASR 模型选择正确**
|
||||
- 中文场景推荐使用 SenseVoice
|
||||
- 英文场景推荐使用 Whisper
|
||||
- [提示词指南](../concepts/assistants/prompts.md)
|
||||
- [知识库](../customization/knowledge-base.md)
|
||||
- [工作流](../customization/workflows.md)
|
||||
|
||||
2. **检查音频采样率**
|
||||
- 推荐采样率：16kHz
|
||||
- 推荐格式：PCM 16-bit
|
||||
## Q: 语音识别或语音播放效果不好怎么办？
|
||||
|
||||
3. **确认语言设置匹配**
|
||||
- 在 ASR 配置中选择正确的语言
|
||||
- 输入侧问题先看 [语音识别](../customization/asr.md)
|
||||
- 输出侧问题先看 [声音资源](../customization/voices.md) 和 [TTS 参数](../customization/tts.md)
|
||||
- 需要逐步定位链路问题时，再看 [故障排查](troubleshooting.md)
|
||||
|
||||
### Q: 语音延迟较高？
|
||||
## Q: 页面空白、接口报错或连接不上怎么办？
|
||||
|
||||
- 检查网络连接稳定性
|
||||
- 尝试切换 ASR 服务提供商
|
||||
- 降低音频质量以减少传输数据量
|
||||
这是典型的环境或链路问题：
|
||||
|
||||
## 语音合成
|
||||
- 先确认 [环境与部署](../getting-started/index.md) 中的三个服务都已启动
|
||||
- 再进入 [故障排查](troubleshooting.md) 按连接、API、页面加载或性能问题分类处理
|
||||
|
||||
### 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` 配置
|
||||
- 确认构建产物路径正确
|
||||
- 检查文件权限设置
|
||||
|
||||
Reference in New Issue
Block a user