🤖 给 AI 的参考
这是 Hearo(听见)的《快速开始》文档,可作为开发参考。文档链接:https://hearo.apps.aisp24.com/docs/quickstart.md
快速开始
5 分钟跑通:建 API Key → 建客户端 → 签 token → 浏览器对话 → 邀请 AI
① 创建 API Key + 客户端
到 API Key 创建一把工作空间 Key(hk_xxx,只显示一次)。用它创建一个客户端(设备/网页)。模型详解见 客户端与接入模型。
② 配置厂商(让 AI 真实回话)
平台管理员在「设置」里把 ASR / LLM / TTS 选成真实厂商并填好 key(否则走 mock,不会真实回话)。
③ 签发一个客户端 Token
用 API Key 为客户端签发身份 Token(终端用它连接;房间由 client→room 映射决定)。网页/App 临时场景可用 /api/v1/clients/ephemeral 一步拿到「临时客户端 + 房间 + token」:
bash
curl -X POST https://hearo.apps.aisp24.com/api/v1/clients/ephemeral \
-H "Authorization: Bearer $HEARO_API_KEY" -H "Content-Type: application/json" \
-d '{"room":"demo","kind":"web","ttlSeconds":3600}'
# -> { "token": "...", "clientId": "eph_...", "room": "demo" }④ 浏览器连线对话
打开 演示 页(Playground),点连接即可说话;它默认演示 WSS + PCM,也提供 WebRTC(实验)参考。最小 WebSocket 客户端:
javascript
const ws = new WebSocket(
"wss://hearo-gw.apps.aisp24.com/v1/connect?token=" + encodeURIComponent(token) +
"&encoding=pcm_s16le&sample_rate=16000&channels=1&frame_duration_ms=20&downlink_codec=pcm_s16le"
);
ws.binaryType = "arraybuffer";
ws.onmessage = (e) => {
if (typeof e.data === "string") console.log("event", JSON.parse(e.data));
else playPcm(e.data); // 16k PCM
};
// 把麦克风重采样到 16k 单声道 s16le,按 20ms 帧 ws.send(pcmFrame)⑤ 邀请 AI 加入
连上后,在演示页点「邀请 AI 加入」,选对话模式与 VAD 即可开始对话、随时打断。原理见 AI 智能体。也可以给房间配「默认智能体」,进房自动就位——见 房间与分组。
💡 下一步:默认接入看 WebSocket,浏览器实验路径看 WebRTC(实验);调对话体验看 交互模式与 VAD。