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
53
docs/content/customization/knowledge-base.md
Normal file
53
docs/content/customization/knowledge-base.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# 知识库
|
||||
|
||||
知识库基于 RAG（检索增强生成）技术，让 AI 能够回答私有领域问题。
|
||||
|
||||
## 概述
|
||||
|
||||
|
||||
|
||||
## 创建知识库
|
||||
|
||||
### 步骤
|
||||
|
||||
1. 进入 **知识库** 页面
|
||||
2. 点击 **新建知识库**
|
||||
3. 填写知识库名称
|
||||
4. 上传文档
|
||||
|
||||
### 支持格式
|
||||
|
||||
| 格式 | 说明 |
|
||||
|------|------|
|
||||
| Markdown | 最佳选择，格式清晰 |
|
||||
| PDF | 自动提取文本 |
|
||||
| TXT | 纯文本支持 |
|
||||
| Word | 需转换为其他格式 |
|
||||
|
||||
### 文档上传
|
||||
|
||||
- 拖拽上传或点击选择
|
||||
- 单文件大小限制 10MB
|
||||
- 建议单文档不超过 50000 字
|
||||
|
||||
## 配置检索参数
|
||||
|
||||
| 参数 | 说明 | 默认值 |
|
||||
|------|------|--------|
|
||||
| 相似度阈值 | 低于此分数的结果不返回 | 0.7 |
|
||||
| 返回数量 | 单次检索返回的结果数 | 3 |
|
||||
| 分块大小 | 文档分块的最大长度 | 500 |
|
||||
|
||||
## 管理知识库
|
||||
|
||||
- **查看文档** - 浏览已上传的文件
|
||||
- **删除文档** - 移除不需要的内容
|
||||
- **更新文档** - 重新上传覆盖
|
||||
- **测试检索** - 验证知识库效果
|
||||
|
||||
## 关联助手
|
||||
|
||||
在助手配置的 **知识** 标签页中：
|
||||
1. 选择要关联的知识库
|
||||
2. 设置检索策略
|
||||
3. 保存配置
|
||||
44
docs/content/customization/models.md
Normal file
44
docs/content/customization/models.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# 模型配置
|
||||
|
||||
## LLM 模型库
|
||||
|
||||
|
||||
|
||||
### 支持的模型
|
||||
|
||||
| 供应商 | 模型 | 特点 |
|
||||
|--------|------|------|
|
||||
| **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. 测试识别效果
|
||||
229
docs/content/customization/tools.md
Normal file
229
docs/content/customization/tools.md
Normal file
@@ -0,0 +1,229 @@
|
||||
# 工具集成
|
||||
|
||||
工具（Tools）让助手能够执行外部操作，如查询天气、搜索信息、调用 API 等。
|
||||
|
||||
## 概述
|
||||
|
||||
工具是助手能力的扩展。当用户的请求需要外部数据或操作时，助手会调用相应的工具。
|
||||
|
||||
## 内置工具
|
||||
|
||||
| 工具 | 说明 | 参数 |
|
||||
|------|------|------|
|
||||
| `search` | 网络搜索 | query: 搜索关键词 |
|
||||
| `weather` | 天气查询 | city: 城市名称 |
|
||||
| `calculator` | 数学计算 | expression: 计算表达式 |
|
||||
| `knowledge` | 知识库检索 | query: 查询内容 |
|
||||
|
||||
### 启用内置工具
|
||||
|
||||
在助手配置的 **工具** 标签页：
|
||||
|
||||
1. 勾选需要启用的工具
|
||||
2. 配置工具参数（如有）
|
||||
3. 保存配置
|
||||
|
||||
## 自定义工具
|
||||
|
||||
支持通过 HTTP 回调实现自定义工具。
|
||||
|
||||
### 定义工具
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "query_order",
|
||||
"description": "查询用户订单信息",
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"order_id": {
|
||||
"type": "string",
|
||||
"description": "订单编号"
|
||||
}
|
||||
},
|
||||
"required": ["order_id"]
|
||||
},
|
||||
"endpoint": {
|
||||
"url": "https://api.example.com/orders",
|
||||
"method": "GET",
|
||||
"headers": {
|
||||
"Authorization": "Bearer {{api_key}}"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 工具字段说明
|
||||
|
||||
| 字段 | 说明 |
|
||||
|------|------|
|
||||
| name | 工具名称（英文标识符） |
|
||||
| description | 工具描述（LLM 用于理解工具用途） |
|
||||
| parameters | 参数定义（JSON Schema 格式） |
|
||||
| endpoint | HTTP 调用配置 |
|
||||
|
||||
### 参数映射
|
||||
|
||||
工具参数自动映射到 HTTP 请求：
|
||||
|
||||
- **GET 请求**：参数作为 query string
|
||||
- **POST 请求**：参数作为 JSON body
|
||||
|
||||
## 客户端工具
|
||||
|
||||
某些工具需要在客户端执行（如获取地理位置）。
|
||||
|
||||
### 工作流程
|
||||
|
||||
1. 助手返回 `assistant.tool_call` 事件
|
||||
2. 客户端执行工具并获取结果
|
||||
3. 客户端发送 `tool_call.results` 消息
|
||||
4. 助手继续生成回复
|
||||
|
||||
### 服务端事件
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "assistant.tool_call",
|
||||
"data": {
|
||||
"tool_call_id": "call_abc123",
|
||||
"tool_name": "get_location",
|
||||
"arguments": {}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 客户端响应
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "tool_call.results",
|
||||
"results": [
|
||||
{
|
||||
"tool_call_id": "call_abc123",
|
||||
"name": "get_location",
|
||||
"output": {
|
||||
"latitude": 39.9042,
|
||||
"longitude": 116.4074,
|
||||
"city": "北京"
|
||||
},
|
||||
"status": {
|
||||
"code": 200,
|
||||
"message": "ok"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## 工具调用示例
|
||||
|
||||
### 天气查询
|
||||
|
||||
用户："北京今天天气怎么样？"
|
||||
|
||||
助手调用工具：
|
||||
```json
|
||||
{
|
||||
"tool_name": "weather",
|
||||
"arguments": {
|
||||
"city": "北京"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
工具返回：
|
||||
```json
|
||||
{
|
||||
"temperature": 25,
|
||||
"condition": "晴",
|
||||
"humidity": 40
|
||||
}
|
||||
```
|
||||
|
||||
助手回复："北京今天天气晴朗，气温 25 度，湿度 40%。"
|
||||
|
||||
### 订单查询
|
||||
|
||||
用户："帮我查一下订单 12345"
|
||||
|
||||
助手调用工具：
|
||||
```json
|
||||
{
|
||||
"tool_name": "query_order",
|
||||
"arguments": {
|
||||
"order_id": "12345"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
工具返回：
|
||||
```json
|
||||
{
|
||||
"order_id": "12345",
|
||||
"status": "已发货",
|
||||
"tracking": "SF1234567890"
|
||||
}
|
||||
```
|
||||
|
||||
助手回复："您的订单 12345 已发货，快递单号是 SF1234567890。"
|
||||
|
||||
## 工具配置最佳实践
|
||||
|
||||
### 1. 清晰的描述
|
||||
|
||||
工具描述应该让 LLM 准确理解何时使用：
|
||||
|
||||
```
|
||||
好的描述：
|
||||
"查询指定城市的实时天气信息，包括温度、天气状况和湿度"
|
||||
|
||||
不好的描述：
|
||||
"天气工具"
|
||||
```
|
||||
|
||||
### 2. 完整的参数定义
|
||||
|
||||
```json
|
||||
{
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"city": {
|
||||
"type": "string",
|
||||
"description": "城市名称，如 '北京'、'上海'"
|
||||
},
|
||||
"date": {
|
||||
"type": "string",
|
||||
"description": "日期，格式 YYYY-MM-DD，可选，默认今天"
|
||||
}
|
||||
},
|
||||
"required": ["city"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. 错误处理
|
||||
|
||||
工具应返回清晰的错误信息：
|
||||
|
||||
```json
|
||||
{
|
||||
"status": {
|
||||
"code": 404,
|
||||
"message": "未找到该城市的天气数据"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 安全注意事项
|
||||
|
||||
1. **验证输入** - 不要直接信任用户输入
|
||||
2. **限制权限** - 工具只应有必要的权限
|
||||
3. **审计日志** - 记录所有工具调用
|
||||
4. **速率限制** - 防止滥用
|
||||
|
||||
## 下一步
|
||||
|
||||
- [知识库配置](knowledge-base.md) - 让助手具备专业知识
|
||||
- [工作流编排](workflows.md) - 复杂对话流程
|
||||
58
docs/content/customization/voices.md
Normal file
58
docs/content/customization/voices.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# 语音合成
|
||||
|
||||
语音合成（TTS）模块提供自然流畅的语音输出能力。
|
||||
|
||||
## 概述
|
||||
|
||||
|
||||
|
||||
## 支持的引擎
|
||||
|
||||
| 供应商 | 特点 | 适用场景 |
|
||||
|--------|------|---------|
|
||||
| **阿里云** | 多音色、高自然度 | 通用场景 |
|
||||
| **火山引擎** | 低延迟、实时性好 | 实时对话 |
|
||||
| **Minimax** | 高性价比 | 批量合成 |
|
||||
|
||||
## 配置方法
|
||||
|
||||
### 添加语音配置
|
||||
|
||||
1. 进入 **语音库** 页面
|
||||
2. 点击 **添加语音**
|
||||
3. 选择供应商
|
||||
4. 填写 API 凭证
|
||||
5. 保存配置
|
||||
|
||||
### 测试语音
|
||||
|
||||
- 在线预览发音效果
|
||||
- 调整语速和音量
|
||||
- 切换不同音色
|
||||
|
||||
## 音色选择
|
||||
|
||||
### 中文音色
|
||||
|
||||
| 音色 | 风格 |
|
||||
|------|------|
|
||||
| 晓晓 | 标准女声 |
|
||||
| 晓北 | 知性女声 |
|
||||
| 逍遥 | 青年男声 |
|
||||
| 丫丫 | 活泼童声 |
|
||||
|
||||
### 英文音色
|
||||
|
||||
| 音色 | 风格 |
|
||||
|------|------|
|
||||
| Joanna | 专业女声 |
|
||||
| Matthew | 沉稳男声 |
|
||||
| Amy | 亲切女声 |
|
||||
|
||||
## 参数调优
|
||||
|
||||
| 参数 | 范围 | 说明 |
|
||||
|------|------|------|
|
||||
| 语速 | 0.5-2.0 | 1.0 为正常速度 |
|
||||
| 音量 | 0-100 | 输出音量百分比 |
|
||||
| 音调 | 0.5-2.0 | 语音音调高低 |
|
||||
53
docs/content/customization/workflows.md
Normal file
53
docs/content/customization/workflows.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# 工作流管理
|
||||
|
||||
工作流提供可视化的对话流程编排能力，支持复杂的业务场景。
|
||||
|
||||
## 概述
|
||||
|
||||
|
||||
|
||||
## 节点类型
|
||||
|
||||
| 节点 | 图标 | 功能说明 |
|
||||
|------|------|---------|
|
||||
| **对话节点** | 💬 | AI 自动回复，可设置回复策略 |
|
||||
| **工具节点** | 🔧 | 调用外部 API 或自定义工具 |
|
||||
| **人工节点** | 👤 | 转接人工客服 |
|
||||
| **结束节点** | 🏁 | 结束对话流程 |
|
||||
|
||||
## 创建工作流
|
||||
|
||||
### 步骤
|
||||
|
||||
1. 进入 **工作流** 页面
|
||||
2. 点击 **新建工作流**
|
||||
3. 从左侧拖拽节点到画布
|
||||
4. 连接节点建立流程
|
||||
5. 配置各节点参数
|
||||
6. 保存并发布
|
||||
|
||||
### 节点配置
|
||||
|
||||
#### 对话节点配置
|
||||
|
||||
- 回复模板
|
||||
- 条件分支
|
||||
- 知识库检索
|
||||
|
||||
#### 工具节点配置
|
||||
|
||||
- 选择工具类型
|
||||
- 配置输入参数
|
||||
- 设置输出处理
|
||||
|
||||
#### 人工节点配置
|
||||
|
||||
- 转接规则
|
||||
- 排队策略
|
||||
- 通知设置
|
||||
|
||||
## 流程测试
|
||||
|
||||
- 支持单步调试
|
||||
- 可查看执行日志
|
||||
- 实时验证流程逻辑
|
||||
Reference in New Issue
Block a user