86639692ba
- Added support for public Realtime API, including new routes for managing API keys and handling WebRTC connections. - Introduced RealtimeApiKey model and associated CRUD operations for admin management of API keys. - Implemented authentication mechanisms for API keys and client secrets. - Enhanced environment configuration with new secrets for Realtime API. - Created OpenAIRealtime session management and event processing for real-time interactions. - Updated schemas and settings to accommodate new features and ensure compatibility with existing systems.
50 lines
1.4 KiB
Plaintext
50 lines
1.4 KiB
Plaintext
---
|
||
title: 快速开始
|
||
description: 用 Docker 启动本地开发环境，并创建第一个可语音预览的助手。
|
||
icon: rocket
|
||
---
|
||
|
||
# 快速开始
|
||
|
||
## 1. 启动服务
|
||
|
||
在项目根目录执行：
|
||
|
||
```bash
|
||
docker compose up -d
|
||
make db-seed
|
||
```
|
||
|
||
首次启动会构建后端镜像。启动后访问：
|
||
|
||
- 前端：`http://localhost:3030`
|
||
- 后端健康检查：`http://localhost:8000/health`
|
||
- 后端接口文档：`http://localhost:8000/docs`
|
||
|
||
## 2. 配置模型资源
|
||
|
||
进入「组件库 / 模型资源」，选择协议类型并填写连接信息。OpenAI 兼容服务通常需要：
|
||
|
||
- `values.modelId`：模型标识
|
||
- `values.apiUrl`：服务地址
|
||
- `secrets.apiKey`：访问密钥
|
||
|
||
保存前可使用“测试连接”确认可用性。
|
||
|
||
## 3. 创建助手
|
||
|
||
进入「创建助手」，绑定需要的模型资源：
|
||
|
||
- **pipeline**：绑定 LLM、ASR、TTS，适合常规语音对话。
|
||
- **realtime**：绑定 Realtime 模型，适合端到端语音交互。
|
||
|
||
保存后，从助手详情页打开语音预览即可测试。
|
||
|
||
## 4. 对接 Realtime 协议
|
||
|
||
- [Realtime 兼容协议设计](/realtime-protocol)：了解后端提供的 OpenAI Realtime 兼容 WebRTC、WebSocket、鉴权与 Interactive Media 扩展协议。
|
||
|
||
<Note>
|
||
浏览器麦克风仅在 localhost 或 HTTPS 下可用。局域网、远程环境请按仓库中的 `deploy/README.md` 配置 HTTPS 与 TURN。
|
||
</Note>
|