跳至主要內容

Voice 事件

Voice provider 會在實時語音互動期間發出事件。你可以使用 voice.on() 方法監聽這些事件,而這些事件對建立互動式語音應用程式尤其重要。

常見事件
常見事件 的直接連結

實時 voice provider 一般都會實作以下事件:

error:

Error
在語音處理期間發生錯誤,或音訊資料格式不受支援時發出

session.created:

object
使用 OpenAI 服務建立新工作階段時發出

session.updated:

object
更新工作階段設定時發出

response.created:

object
AI 助理建立新回應時發出

response.done:

object
AI 助理完成回應時發出

speaker:

StreamWithId
在有可輸送至音訊輸出的新音訊串流時發出

writing:

object
正在轉錄(使用者)或產生(助理)文字時發出

speaking:

object
voice provider 有音訊資料可用時發出

speaking.done:

object
voice provider 完成發聲時發出

tool-call-start:

object
AI 助理開始執行 Tool 時發出

tool-call-result:

object
Tool 執行完成並產生結果時發出

注意事項
注意事項 的直接連結

  • 並非所有 voice provider 都支援全部事件
  • 確切的 payload 結構可能因 provider 而異
  • 對於非實時 provider,大部分這些事件都不會發出
  • 事件有助建立可回應對話狀態的互動式 UI
  • 不再需要事件監聽器時,可考慮使用 voice.off() 方法將其移除