Voice 事件
語音 Provider 會在即時語音互動期間發出事件。你可以使用 voice.on() 方法監聽這些事件;在建立互動式語音應用程式時,這些事件尤其重要。
常見事件「常見事件」的直接連結
即時語音 Provider 通常會實作下列事件:
error:
Error
語音處理期間發生錯誤,或音訊資料格式不受支援時發出
session.created:
object
使用 OpenAI 服務建立新工作階段時發出
session.updated:
object
工作階段設定更新時發出
response.created:
object
AI 助理建立新回應時發出
response.done:
object
AI 助理完成回應時發出
speaker:
StreamWithId
發出新的音訊串流,可透過管線傳送至音訊輸出
writing:
object
正在轉錄文字(使用者)或產生文字(助理)時發出
speaking:
object
語音 Provider 有可用的音訊資料時發出
speaking.done:
object
語音 Provider 完成語音輸出時發出
tool-call-start:
object
AI 助理開始執行 Tool 時發出
tool-call-result:
object
Tool 執行完成並產生結果時發出
注意事項「注意事項」的直接連結
- 並非所有語音 Provider 都支援所有事件
- 確切的 payload 結構可能因 Provider 而異
- 非即時 Provider 不會發出其中大多數事件
- 這些事件適合用來建立會根據對話狀態做出回應的互動式 UI
- 不再需要事件監聽器時,請考慮使用 voice.off() 方法將其移除