Update documentation and configuration for Realtime Agent Studio

- Revised mkdocs.yml to reflect the new site name and description, enhancing clarity for users.
- Added a changelog.md to document important changes and updates for the project.
- Introduced a roadmap.md to outline development plans and progress for future releases.
- Expanded index.md with a comprehensive overview of the platform, including core features and installation instructions.
- Enhanced concepts documentation with detailed explanations of assistants, engines, and their configurations.
- Updated configuration documentation to provide clear guidance on environment setup and service configurations.
- Added extra JavaScript for improved user experience in the documentation site.
This commit is contained in:
Xin Wang
2026-03-02 23:35:22 +08:00
parent 80fff09b76
commit 4c05131536
15 changed files with 2529 additions and 236 deletions

81
docs/content/changelog.md Normal file
View File

@@ -0,0 +1,81 @@
# 更新日志
本文档记录 Realtime Agent Studio 的所有重要变更。
格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)
版本号遵循 [语义化版本](https://semver.org/lang/zh-CN/)。
---
## [未发布]
### 开发中
- 工作流可视化编辑器
- 知识库 RAG 集成
- JavaScript/Python SDK
- Step Audio 多模态模型支持
---
## [0.1.0] - 2025-01-15
### 新增
#### 实时交互引擎
- **管线式全双工引擎** - ASR → LLM → TTS 流水线架构
- **智能打断** - 支持 VAD 和 EOU 检测
- **OpenAI 兼容接口** - 支持 OpenAI Compatible 的 ASR/TTS 服务
- **DashScope TTS** - 阿里云语音合成服务适配
#### 智能体配置
- **系统提示词** - 支持角色定义和动态变量 `{{variable}}`
- **模型管理** - LLM/ASR/TTS 模型统一管理界面
- **工具调用** - Webhook 工具和客户端工具配置
#### 交互测试
- **实时调试控制台** - 内置 WebSocket 调试工具
#### 开放接口
- **WebSocket 协议** - `/ws` 端点,支持二进制音频流
- **RESTful API** - 完整的助手/模型/会话 CRUD 接口
#### 历史监控
- **会话回放** - 音频 + 转写 + LLM 响应完整记录
- **会话筛选** - 按时间、助手、状态多维度检索
#### 部署
- **Docker 支持** - 提供 docker-compose 一键部署
### 技术栈
- 前端React 18, TypeScript, Tailwind CSS, Zustand
- 后端FastAPI (Python 3.10+)
- 数据库SQLite开发/ PostgreSQL生产
---
## 版本规划
| 版本 | 计划发布 | 主要特性 |
|------|---------|---------|
| 0.2.0 | 2025 Q1 | 工作流编辑器、知识库集成 |
| 0.3.0 | 2025 Q2 | SDK 发布、多模态模型 |
| 1.0.0 | 2025 H2 | 生产就绪、企业特性 |
---
## 贡献者
感谢所有为 RAS 做出贡献的开发者!
---
[未发布]: https://github.com/your-org/AI-VideoAssistant/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/your-org/AI-VideoAssistant/releases/tag/v0.1.0