Files

Xin Wang b300b469dc 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.

2026-03-09 05:38:43 +08:00

2.9 KiB

Raw Blame History

环境与部署

本页属于“快速开始”中的环境与部署路径，只负责把服务跑起来、说明配置入口和部署方式。首次创建助手请转到创建第一个助手。

先理解部署对象

Realtime Agent Studio（RAS）通常由三个核心服务组成：

flowchart LR
    subgraph Services["服务组件"]
        Web[Web 前端<br/>React + TypeScript]
        API[API 服务<br/>FastAPI]
        Engine[Engine 服务<br/>WebSocket]
    end

    subgraph Storage["数据存储"]
        DB[(SQLite/PostgreSQL)]
    end

    Web -->|REST| API
    Web -->|WebSocket| Engine
    API <--> DB
    Engine <--> API

组件	默认端口	负责什么
Web 前端	3000	管理控制台与调试界面
API 服务	8080	资源管理、配置持久化、历史数据
Engine 服务	8000	实时会话、事件流和音频流

选择你的安装方式

方式一：Docker Compose

适合希望尽快跑通一套完整环境的团队。

# 仓库目录示例沿用当前代码仓库 slug
# 你本地实际目录名可以不同
git clone https://github.com/your-org/AI-VideoAssistant.git
cd AI-VideoAssistant

docker-compose up -d

方式二：本地开发

适合需要分别调试前端、API 和 Engine 的开发者。

启动 API 服务

cd api
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -r requirements.txt
uvicorn main:app --host 0.0.0.0 --port 8080 --reload

启动 Engine 服务

cd engine
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python main.py

启动 Web 前端

cd web
npm install
npm run dev

基础验证

完成安装后，至少确认以下入口可访问：

服务	地址	用途
Web	`http://localhost:3000`	打开控制台
API	`http://localhost:8080/docs`	查看管理接口
Engine	`http://localhost:8000/health`	检查实时引擎健康状态

如果你需要更完整的环境变量、配置文件和部署说明，请继续阅读本章节其他页面：

目录结构（阅读导向）

repo/
├── web/      # 管理控制台
├── api/      # 控制面与管理接口
├── engine/   # 实时交互引擎
├── docker/   # 部署编排与镜像配置
└── docs/     # 当前文档站点

遇到问题时去哪里

需要“快速判断往哪看”：先看常见问题
需要“按步骤排查”：直接看故障排查
已经跑通环境，准备创建助手：回到快速开始

2.9 KiB Raw Blame History Unescape Escape