Update documentation to enhance clarity and resource configuration for RAS
- Revised the introduction in index.md to emphasize the need for resource configuration before creating an AI assistant. - Added a new section detailing the configuration process for ASR, LLM, and TTS resources. - Updated the quickstart guide to reflect the new resource management steps and included troubleshooting tips for common issues. - Removed the outdated API guide as it has been integrated into the new resource configuration workflow.
This commit is contained in:
Xin Wang
@@ -1,149 +1,233 @@
|
||||
# 通过控制台创建助手
|
||||
# 资源库配置详解
|
||||
|
||||
本指南详细介绍如何通过 Web 控制台创建和配置 AI 助手。
|
||||
本页面详细介绍资源库中各类资源的配置方法和最佳实践。
|
||||
|
||||
## 步骤 1：登录控制台
|
||||
## 语音识别 (ASR) 配置
|
||||
|
||||
1. 打开浏览器访问控制台地址（如 `http://localhost:3000`）
|
||||
2. 使用账号密码登录
|
||||
### 支持的接口类型
|
||||
|
||||
## 步骤 2：创建助手
|
||||
| 接口类型 | 说明 |
|
||||
|---------|------|
|
||||
| OpenAI Compatible | 兼容 OpenAI 语音识别 API 格式的服务 |
|
||||
|
||||
|
||||
### 配置字段说明
|
||||
|
||||
1. 在左侧导航栏点击 **助手管理**
|
||||
2. 点击右上角 **新建助手** 按钮
|
||||
3. 在弹出的对话框中输入：
|
||||
- **助手名称**：为你的助手起一个名字，如 "产品咨询助手"
|
||||
- **描述**：简单描述助手的用途（可选）
|
||||
| 字段 | 必填 | 说明 |
|
||||
|-----|-----|------|
|
||||
| 模型名称 | 是 | 自定义显示名称，便于识别 |
|
||||
| 接口类型 | 是 | 当前支持 OpenAI Compatible |
|
||||
| 语言 | 是 | 识别语言：中文/英文/多语言 |
|
||||
| Model Name | 否 | API 请求中的 model 参数 |
|
||||
| Base URL | 是 | API 服务地址 |
|
||||
| API Key | 是 | 服务认证密钥 |
|
||||
| 热词 | 否 | 逗号分隔的专有名词列表 |
|
||||
| 标点增强 | 否 | 是否自动添加标点 |
|
||||
| 文本归一化 | 否 | 规范化数字、日期等格式 |
|
||||
| 启用 | 否 | 是否在选择列表中显示 |
|
||||
|
||||
4. 点击 **创建**
|
||||
### 推荐配置示例
|
||||
|
||||
## 步骤 3：配置基本设置
|
||||
|
||||
创建完成后，你将进入助手配置页面。
|
||||
|
||||
### 全局设置
|
||||
|
||||
| 配置项 | 建议值 | 说明 |
|
||||
|-------|--------|------|
|
||||
| 系统提示词 | 见下方示例 | 定义助手的角色和行为 |
|
||||
| 开场白 | "你好，我是产品咨询助手，请问有什么可以帮您？" | 对话开始时的问候 |
|
||||
| 温度 | 0.7 | 平衡创意和准确性 |
|
||||
|
||||
### 系统提示词示例
|
||||
**硅基流动 SenseVoice**
|
||||
|
||||
```
|
||||
你是一个专业的产品咨询助手。你的主要任务是：
|
||||
|
||||
1. 解答用户关于产品功能的问题
|
||||
2. 提供使用建议和最佳实践
|
||||
3. 帮助用户解决常见问题
|
||||
|
||||
请注意：
|
||||
- 保持友好和专业的语气
|
||||
- 回答简洁明了，避免冗长
|
||||
- 如果不确定答案，请如实告知并建议联系人工客服
|
||||
- 不要编造不存在的功能或信息
|
||||
模型名称：SenseVoice 中文
|
||||
Model Name：FunAudioLLM/SenseVoiceSmall
|
||||
Base URL：https://api.siliconflow.cn/v1
|
||||
语言：中文
|
||||
```
|
||||
|
||||
## 步骤 4：配置语音
|
||||
### 测试识别效果
|
||||
|
||||
切换到 **语音配置** 标签页：
|
||||
1. 在 ASR 列表中找到目标模型
|
||||
2. 点击 **试听识别** 按钮
|
||||
3. 选择以下测试方式之一：
|
||||
- **上传文件**：拖拽或选择音频文件
|
||||
- **麦克风录音**：点击录音按钮开始录制
|
||||
4. 点击 **开始识别** 查看结果
|
||||
5. 检查识别文本、延迟和置信度
|
||||
|
||||
### TTS 设置
|
||||
---
|
||||
|
||||
1. **选择 TTS 引擎**
|
||||
- 阿里云：多音色、高自然度
|
||||
- 火山引擎：低延迟
|
||||
- Minimax：高性价比
|
||||
## 大语言模型 (LLM) 配置
|
||||
|
||||
2. **选择音色**
|
||||
- 根据助手定位选择合适的声音
|
||||
- 建议先试听再确定
|
||||
### 支持的模型类型
|
||||
|
||||
3. **调整参数**
|
||||
- 语速：1.0（正常速度）
|
||||
- 音量：80%
|
||||
- 音调：1.0
|
||||
| 类型 | 用途 |
|
||||
|-----|------|
|
||||
| 文本 (text) | 对话生成，用于助手核心交互 |
|
||||
| 嵌入 (embedding) | 向量化，用于知识库检索 |
|
||||
| 重排 (rerank) | 结果重排序，优化检索结果 |
|
||||
|
||||
### ASR 设置
|
||||
### 配置字段说明
|
||||
|
||||
1. **选择 ASR 引擎**
|
||||
- Whisper：通用识别
|
||||
- SenseVoice：中文识别更准
|
||||
| 字段 | 必填 | 说明 |
|
||||
|-----|-----|------|
|
||||
| 厂商 | 是 | 当前支持 OpenAI Compatible |
|
||||
| 模型类型 | 是 | 文本/嵌入/重排 |
|
||||
| 模型名称 | 是 | 自定义显示名称 |
|
||||
| 模型标识 | 否 | API 请求中的 model 参数 |
|
||||
| Base URL | 是 | API 服务地址 |
|
||||
| API Key | 是 | 服务认证密钥 |
|
||||
| 温度 | 否 | 输出随机性 (0-2)，仅文本模型 |
|
||||
| 上下文长度 | 否 | 最大 token 数 |
|
||||
| 启用 | 否 | 是否在选择列表中显示 |
|
||||
|
||||
2. **设置语言**
|
||||
- 选择 "中文" 或 "自动检测"
|
||||
### 推荐配置示例
|
||||
|
||||
## 步骤 5：关联知识库（可选）
|
||||
**OpenAI GPT-4o Mini**
|
||||
|
||||
如果你已创建知识库，可以在 **知识** 标签页进行关联：
|
||||
|
||||
1. 点击 **添加知识库**
|
||||
2. 选择要关联的知识库
|
||||
3. 设置检索参数：
|
||||
- 相似度阈值：0.7
|
||||
- 返回数量：3
|
||||
|
||||
## 步骤 6：测试助手
|
||||
|
||||
1. 点击页面右上角的 **保存** 按钮
|
||||
2. 点击 **测试** 按钮打开测试面板
|
||||
3. 进行对话测试：
|
||||
|
||||
**测试用例建议：**
|
||||
|
||||
| 测试类型 | 示例问题 |
|
||||
|---------|---------|
|
||||
| 基础问候 | "你好" |
|
||||
| 功能询问 | "你能做什么？" |
|
||||
| 业务问题 | "产品有哪些功能？" |
|
||||
| 边界测试 | "帮我写一首诗" |
|
||||
|
||||
4. 检查回复是否符合预期
|
||||
5. 如有问题，返回修改配置
|
||||
|
||||
## 步骤 7：发布助手
|
||||
|
||||
测试通过后：
|
||||
|
||||
1. 点击 **发布** 按钮
|
||||
2. 确认发布
|
||||
3. 复制生成的信息：
|
||||
- `assistant_id`：用于 API 调用
|
||||
- WebSocket 地址：用于实时对话
|
||||
|
||||
## 嵌入到网页
|
||||
|
||||
发布后，你可以将助手嵌入到你的网站：
|
||||
|
||||
```html
|
||||
<!-- 添加到你的网页 -->
|
||||
<script>
|
||||
const ws = new WebSocket('ws://your-server/ws?assistant_id=YOUR_ASSISTANT_ID');
|
||||
// ... 实现对话逻辑
|
||||
</script>
|
||||
```
|
||||
模型名称：GPT-4o Mini
|
||||
模型类型：文本
|
||||
模型标识：gpt-4o-mini
|
||||
Base URL：https://api.openai.com/v1
|
||||
温度：0.7
|
||||
上下文长度：8192
|
||||
```
|
||||
|
||||
详细集成指南请参考 [API 参考](../api-reference/websocket.md)。
|
||||
**硅基流动 Qwen**
|
||||
|
||||
## 常见问题
|
||||
```
|
||||
模型名称：Qwen2.5-7B
|
||||
模型类型：文本
|
||||
模型标识：Qwen/Qwen2.5-7B-Instruct
|
||||
Base URL：https://api.siliconflow.cn/v1
|
||||
温度：0.7
|
||||
```
|
||||
|
||||
### 助手不回复？
|
||||
### 测试模型效果
|
||||
|
||||
1. 检查 LLM 模型是否配置正确
|
||||
2. 查看浏览器控制台是否有错误
|
||||
3. 确认后端服务正常运行
|
||||
1. 在 LLM 列表中找到目标模型
|
||||
2. 点击 **预览** 按钮
|
||||
3. 配置测试参数：
|
||||
- **System Prompt**：系统提示词
|
||||
- **User Message**：测试消息
|
||||
- **Temperature**：温度参数
|
||||
- **Max Tokens**：最大输出长度
|
||||
4. 点击 **开始预览** 查看模型回复
|
||||
5. 检查回复内容、延迟和 token 用量
|
||||
|
||||
### 语音无法播放？
|
||||
---
|
||||
|
||||
1. 检查浏览器是否允许自动播放
|
||||
2. 确认 TTS 配置正确
|
||||
3. 检查音量设置
|
||||
## 声音资源 (TTS) 配置
|
||||
|
||||
### 支持的接口类型
|
||||
|
||||
| 接口类型 | 说明 |
|
||||
|---------|------|
|
||||
| OpenAI Compatible | 兼容 OpenAI TTS API 格式的服务 |
|
||||
| DashScope | 阿里云 DashScope 语音合成服务 |
|
||||
|
||||
### 配置字段说明
|
||||
|
||||
| 字段 | 必填 | 说明 |
|
||||
|-----|-----|------|
|
||||
| 厂商 | 是 | OpenAI Compatible 或 DashScope |
|
||||
| 声音名称 | 是 | 自定义显示名称 |
|
||||
| 模型 | 是 | TTS 模型标识 |
|
||||
| 声音 ID | 是 | 音色标识符 |
|
||||
| Base URL | 否 | API 服务地址 |
|
||||
| API Key | 是 | 服务认证密钥 |
|
||||
| 语速 | 否 | 说话速度 (0.5-2.0)，默认 1.0 |
|
||||
| 增益 | 否 | 音量调节 (-10 to 10 dB) |
|
||||
| 音调 | 否 | 声音高低 (-12 to 12) |
|
||||
| 性别 | 否 | 声音性别标签 |
|
||||
| 语言 | 否 | 声音语言标签 |
|
||||
| 备注 | 否 | 声音特点描述 |
|
||||
|
||||
### 推荐配置示例
|
||||
|
||||
**硅基流动 CosyVoice**
|
||||
|
||||
```
|
||||
厂商：OpenAI Compatible
|
||||
声音名称：Anna 中文女声
|
||||
模型：FunAudioLLM/CosyVoice2-0.5B
|
||||
声音 ID：FunAudioLLM/CosyVoice2-0.5B:anna
|
||||
Base URL：https://api.siliconflow.cn/v1
|
||||
语速：1.0
|
||||
性别：女
|
||||
语言：中文
|
||||
```
|
||||
|
||||
**DashScope TTS**
|
||||
|
||||
```
|
||||
厂商：DashScope
|
||||
声音名称：Cherry
|
||||
模型：qwen3-tts-flash-realtime
|
||||
声音 ID：Cherry
|
||||
Base URL：wss://dashscope.aliyuncs.com/api-ws/v1/realtime
|
||||
语速：1.0
|
||||
```
|
||||
|
||||
### CosyVoice 可用音色
|
||||
|
||||
| 音色 ID | 性别 | 风格 |
|
||||
|--------|-----|------|
|
||||
| alex | 男 | 成熟稳重 |
|
||||
| anna | 女 | 温柔亲切 |
|
||||
| bella | 女 | 活泼甜美 |
|
||||
| benjamin | 男 | 年轻活力 |
|
||||
| charles | 男 | 专业商务 |
|
||||
| claire | 女 | 清新自然 |
|
||||
| david | 男 | 沉稳大气 |
|
||||
| diana | 女 | 优雅知性 |
|
||||
|
||||
### 试听声音效果
|
||||
|
||||
1. 在声音列表中找到目标声音
|
||||
2. 点击 **播放** 按钮
|
||||
3. 系统会自动合成一段试听语音
|
||||
4. 检查声音效果是否符合预期
|
||||
|
||||
### 克隆声音
|
||||
|
||||
如需使用自定义声音：
|
||||
|
||||
1. 点击 **克隆声音** 按钮
|
||||
2. 上传参考音频文件（WAV/MP3）
|
||||
3. 填写声音名称和描述
|
||||
4. 点击 **开始克隆**
|
||||
|
||||
!!! note "声音克隆说明"
|
||||
声音克隆功能需要 TTS 服务支持。上传的参考音频建议为 10-30 秒的清晰人声录音。
|
||||
|
||||
---
|
||||
|
||||
## 配置最佳实践
|
||||
|
||||
### 资源命名规范
|
||||
|
||||
建议使用清晰的命名规范，便于后续管理：
|
||||
|
||||
```
|
||||
[厂商/模型]-[用途/语言]-[特点]
|
||||
```
|
||||
|
||||
示例：
|
||||
- `SF-SenseVoice-中文`
|
||||
- `OpenAI-GPT4o-对话`
|
||||
- `SF-CosyVoice-Anna女声`
|
||||
|
||||
### 多环境管理
|
||||
|
||||
如果有测试和生产环境，建议：
|
||||
|
||||
1. 为不同环境创建独立的资源配置
|
||||
2. 在名称中标注环境，如 `GPT4o-Prod`、`GPT4o-Test`
|
||||
3. 通过"启用"开关控制可见性
|
||||
|
||||
### 成本优化
|
||||
|
||||
| 场景 | 推荐配置 |
|
||||
|-----|---------|
|
||||
| 开发测试 | 使用低成本模型，如 GPT-4o-mini |
|
||||
| 生产环境 | 根据质量要求选择合适模型 |
|
||||
| 高并发 | 考虑使用本地部署的开源模型 |
|
||||
|
||||
---
|
||||
|
||||
## 下一步
|
||||
|
||||
- [通过 API 创建助手](api.md)
|
||||
- [配置知识库](../customization/knowledge-base.md)
|
||||
- [添加工具](../customization/tools.md)
|
||||
资源配置完成后，请返回 [快速开始](index.md) 继续创建助手。
|
||||
|
||||
Reference in New Issue
Block a user