メインコンテンツへ移動

Voice イベント

Voice Provider は、リアルタイム Voice 対話中にイベントを送出します。これらのイベントは voice.on() メソッドでリッスンでき、対話型 Voice アプリケーションの構築で特に重要です。

共通イベント
共通イベントへの直接リンク

次のイベントは、リアルタイム Voice Provider で一般的に実装されています。

error:

Error
Voice 処理中にエラーが発生した場合、または音声データ形式がサポートされていない場合に送出されます

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 がすべてのイベントをサポートするわけではありません
  • 正確なペイロード構造は Provider によって異なる場合があります
  • 非リアルタイム Provider では、これらのイベントのほとんどは送出されません
  • イベントは、会話状態に応答する対話型 UI の構築に役立ちます
  • 不要になったイベントリスナーを削除するには、voice.off() メソッドの使用を検討してください