liumaolin commited on
Commit
5258538
·
1 Parent(s): d12af4f

更新API文档

Browse files
Files changed (1) hide show
  1. src/voice_dialogue/api/core/config.py +19 -13
src/voice_dialogue/api/core/config.py CHANGED
@@ -64,13 +64,12 @@ class AppConfig:
64
  * **动态语言切换**: 运行时创建和切换不同语言的ASR实例
65
 
66
  ### 🤖 智能对话
67
- * **大语言模型集成**: 基于Qwen2.5等先进模型
68
  * **上下文理解**: 支持多轮对话和上下文记忆
69
- * **自定义系统提示**: 可配置AI助手的行为和角色
70
 
71
  ### 🎭 高质量语音合成 (TTS)
72
- * **中文角色**: 基于GPT-SoVITs技术,支持罗翔、马保国、沈逸、杨幂、周杰伦、马云等特色角色
73
- * **英文角色**: 基于Kokoro TTS技术,支持Heart、Bella、Nicole等自然语音
74
  * **智能引擎选择**: 根据内容语言自动选择最适合的TTS引擎
75
  * **动态角色管理**: 运行时加载、切换和管理语音角色
76
 
@@ -79,40 +78,47 @@ class AppConfig:
79
  * **状态监控**: 实时监控系统和模型状态
80
  * **会话管理**: 智能的会话ID管理和消息路由
81
 
82
- ### 🔧 系统管理
83
  * **服务生命周期**: 完整的系统启动、停止、重启控制
84
  * **音频捕获**: 高质量的音频输入处理和回声消除
85
  * **状态监控**: 详细的服务状态和性能指标
 
86
 
87
  ## 📋 主要API端点
88
 
89
- ### TTS模型管理
 
 
 
 
 
 
90
  * `GET /api/v1/tts/models` - 获取所有可用的TTS模型列表
91
  * `POST /api/v1/tts/models/load` - 加载指定的TTS模型
92
  * `GET /api/v1/tts/models/{model_id}/status` - 查看模型下载和加载状态
93
  * `DELETE /api/v1/tts/models/{model_id}` - 删除已下载的模型
94
 
95
- ### 语音识别管理
96
  * `GET /api/v1/asr/languages` - 获取支持的识别语言列表
97
  * `POST /api/v1/asr/instance/create` - 创建指定语言的ASR实例
98
 
99
- ### 系统控制
100
  * `GET /api/v1/system/status` - 获取系统整体状态
101
  * `POST /api/v1/system/start` - 启动语音对话系统
102
  * `POST /api/v1/system/stop` - 停止语音对话系统
103
  * `POST /api/v1/system/restart` - 重启语音对话系统
104
 
105
- ### 实时通信
106
  * `WebSocket /api/v1/ws` - WebSocket连接,接收实时系统消息
107
 
108
  ## 🛠️ 技术特性
109
 
110
  * **异步处理**: 基于FastAPI的高性能异步架构
111
  * **后台任务**: 模型下载和加载在后台执行,不阻塞API响应
112
- * **错误处理**: 完善的异常处理和错误信息反馈
113
- * **状态管理**: 实时的模型和系统状态跟踪
114
- * **CORS支持**: 跨域资源共享配置,便于前端集成
115
- * **API文档**: 自动生成的交互式API文档
116
 
117
  ## 💡 使用场景
118
 
 
64
  * **动态语言切换**: 运行时创建和切换不同语言的ASR实例
65
 
66
  ### 🤖 智能对话
67
+ * **大语言模型集成**: 基于Qwen等先进模型
68
  * **上下文理解**: 支持多轮对话和上下文记忆
69
+ * **自定义系统提示**: 可配置AI助手的行为和角色,支持用户自定义
70
 
71
  ### 🎭 高质量语音合成 (TTS)
72
+ * **多角色支持**: 集成多种高质量TTS引擎,支持丰富的中英文角色
 
73
  * **智能引擎选择**: 根据内容语言自动选择最适合的TTS引擎
74
  * **动态角色管理**: 运行时加载、切换和管理语音角色
75
 
 
78
  * **状态监控**: 实时监控系统和模型状态
79
  * **会话管理**: 智能的会话ID管理和消息路由
80
 
81
+ ### 🔧 系统管理与设置
82
  * **服务生命周期**: 完整的系统启动、停止、重启控制
83
  * **音频捕获**: 高质量的音频输入处理和回声消除
84
  * **状态监控**: 详细的服务状态和性能指标
85
+ * **用户配置**: 支持用户通过API自定义和持久化应用设置
86
 
87
  ## 📋 主要API端点
88
 
89
+ ### 设置管理 (Settings)
90
+ * `GET /api/v1/settings/prompts` - 获取当前生效的系统Prompt
91
+ * `POST /api/v1/settings/prompts` - 更新并保存用户自定义的Prompt
92
+ * `DELETE /api/v1/settings/prompts` - 重置Prompt为系统默认值
93
+ * `GET /api/v1/settings/prompts/default` - 获取系统默认的Prompt
94
+
95
+ ### TTS模型管理 (TTS)
96
  * `GET /api/v1/tts/models` - 获取所有可用的TTS模型列表
97
  * `POST /api/v1/tts/models/load` - 加载指定的TTS模型
98
  * `GET /api/v1/tts/models/{model_id}/status` - 查看模型下载和加载状态
99
  * `DELETE /api/v1/tts/models/{model_id}` - 删除已下载的模型
100
 
101
+ ### 语音识别管理 (ASR)
102
  * `GET /api/v1/asr/languages` - 获取支持的识别语言列表
103
  * `POST /api/v1/asr/instance/create` - 创建指定语言的ASR实例
104
 
105
+ ### 系统控制 (System)
106
  * `GET /api/v1/system/status` - 获取系统整体状态
107
  * `POST /api/v1/system/start` - 启动语音对话系统
108
  * `POST /api/v1/system/stop` - 停止语音对话系统
109
  * `POST /api/v1/system/restart` - 重启语音对话系统
110
 
111
+ ### 实时通信 (WebSocket)
112
  * `WebSocket /api/v1/ws` - WebSocket连接,接收实时系统消息
113
 
114
  ## 🛠️ 技术特性
115
 
116
  * **异步处理**: 基于FastAPI的高性能异步架构
117
  * **后台任务**: 模型下载和加载在后台执行,不阻塞API响应
118
+ * **可配置性**: 支持用户通过API和配置文件自定义核心行为
119
+ * **持久化存储**: 用户设置可被持久化,重启应用后依然生效
120
+ * **内存缓存**: 缓存常用配置,减少磁盘I/O,提升性能
121
+ * **API文档**: 自动生成的交互式API文档(Swagger & ReDoc)
122
 
123
  ## 💡 使用场景
124