VoiceResponse interface
会話中の一つのモデル推論を表現する持続的な音声応答。 リスト結果では output 投影を省略することができます。出力項目に対して完全なレスポンス(GET .../responses/{response_id})またはページ化されたレスポンスアイテムルート(GET .../responses/{response_id}/items)を取得します。
created_at
/
completed_at ファウンドリーの耐久的注文拡張です。
- Extends
プロパティ
| audio | 応答に用いられる音声構成、出力に使われる音声および音声フォーマットが含まれます。 |
| completed_at | 応答が完了したUnixのタイムスタンプ(秒単位)です。 |
| conversation_id | この回答が属する会話のID。 |
| created_at | 応答が作成された時間を示すUnixのタイムスタンプ(秒単位)。 |
| id | 応答のユニークなID。 |
| metadata | レスポンスに付随するキー・バリューペアのセットです。 |
| output | 応答によって生成される出力項目。 リスト結果で省略されることがあります。完全なレスポンス(GET .../responses/{response_id})を取得するか、ページ化されたレスポンス-アイテムルート(GET .../responses/{response_id}/items)を出力項目として使用してください。 各項目の項目 |
| temperature | 応答に使われるサンプリング温度です。 |
継承されたプロパティ
| max_output_tokens | この応答で使用されたツール呼び出しを含む単一のアシスタント応答に対する最大出力トークン数。 |
| object | オブジェクトタイプは |
| output_modalities | モデルが応答するために用いたモダリティの集合、現在可能な値は |
| status | 応答の最終状態( |
| status_details | 状況に関する追加情報。 |
| usage | 応答の利用統計は請求に対応します。 リアルタイムAPIセッションは会話コンテキストを維持し、新しいアイテムを会話に追加するため、前のターンからの出力(テキストおよび音声トークン)が後のターンの入力となります。 |
プロパティの詳細
audio
completed_at
応答が完了したUnixのタイムスタンプ(秒単位)です。
completed_at?: Dateプロパティ値
Date
conversation_id
この回答が属する会話のID。
conversation_id: stringプロパティ値
string
created_at
応答が作成された時間を示すUnixのタイムスタンプ(秒単位)。
created_at?: Dateプロパティ値
Date
id
応答のユニークなID。
id: stringプロパティ値
string
metadata
レスポンスに付随するキー・バリューペアのセットです。
metadata?: Record<string, string>プロパティ値
Record<string, string>
output
応答によって生成される出力項目。 リスト結果で省略されることがあります。完全なレスポンス(GET .../responses/{response_id})を取得するか、ページ化されたレスポンス-アイテムルート(GET .../responses/{response_id}/items)を出力項目として使用してください。 各項目の項目 response_id も会話レベルの項目リスト内のこの応答にリンクします。
output?: RealtimeConversationItemUnion[]プロパティ値
temperature
応答に使われるサンプリング温度です。
temperature?: numberプロパティ値
number
継承されたプロパティの詳細
max_output_tokens
この応答で使用されたツール呼び出しを含む単一のアシスタント応答に対する最大出力トークン数。
max_output_tokens?: number | "inf"プロパティ値
number | "inf"
Inherited FromOutput_tokens VoiceResponseBase.max
object
オブジェクトタイプは realtime.responseでなければなりません。
object?: "realtime.response"プロパティ値
"realtime.response"
output_modalities
モデルが応答するために用いたモダリティの集合、現在可能な値は [\"audio\"]、 [\"text\"]のみです。 音声出力には必ずテキストの書き起こしが含まれています。 出力をモード text に設定すると、モデルからの音声出力が無効になります。
output_modalities?: ("text" | "audio")[]プロパティ値
("text" | "audio")[]
status
応答の最終状態(completed、 cancelled、 failed、または incomplete、 in_progress)。
status?: "failed" | "in_progress" | "cancelled" | "completed" | "incomplete"プロパティ値
"failed" | "in_progress" | "cancelled" | "completed" | "incomplete"
VoiceResponseBase.statusから引き継ぎました
status_details
状況に関する追加情報。
status_details?: RealtimeResponseStatusDetailsプロパティ値
usage
応答の利用統計は請求に対応します。 リアルタイムAPIセッションは会話コンテキストを維持し、新しいアイテムを会話に追加するため、前のターンからの出力(テキストおよび音声トークン)が後のターンの入力となります。
usage?: RealtimeResponseUsage