VoiceResponse interface

一個持續的語音回應代表一個模型推論回合,在對話中進行。 在列表結果 output 中,投影可以省略;取回完整回應()GET .../responses/{response_id}或其輸出項目的分頁回應項目路徑(GET .../responses/{response_id}/items)。 created_at / completed_at 是 Foundry 耐用排序延伸。

Extends

屬性

audio

用於回應的音訊配置,包括用於輸出的語音與音訊格式。

completed_at

Unix 的時間戳記(以秒計)表示回應完成的時間。

conversation_id

這個回應所屬的對話本我。

created_at

Unix 的時間戳(以秒計)表示回應產生的時間。

id

回應的唯一ID。

metadata

一組附加於回應的鍵值對。

output

回應所產生的輸出項目。 可在列表結果中省略;可取得完整回應(GET .../responses/{response_id})或使用分頁回應項目路徑(GET .../responses/{response_id}/items)作為輸出項目。 每個項目 response_id 也會連結回對話層級項目列表中的這個回應。

temperature

響應時使用的取樣溫度。

繼承的屬性

max_output_tokens

單一助理回應(包含工具呼叫)的最大輸出標記數。

object

物件類型必須是 realtime.response。

output_modalities

模型用來回應的模態集合,目前唯一可能的值為 [\"audio\"]。 [\"text\"] 音訊輸出必包含文字逐字稿。 將輸出設定為模式 text 會關閉模型的音訊輸出。

status

回應的最終狀態(completed, cancelled, failed, 或 incomplete, in_progress)。

status_details

關於狀態的更多細節。

usage

回應的使用統計數據,將對應於帳單。 即時 API 會維持對話上下文,並附加新的項目到對話中,因此前幾回合的輸出(文字和音訊標記)將成為後續回合的輸入。

屬性詳細資料

audio

用於回應的音訊配置,包括用於輸出的語音與音訊格式。

audio?: VoiceResponseAudio

屬性值

completed_at

Unix 的時間戳記(以秒計)表示回應完成的時間。

completed_at?: Date

屬性值

Date

conversation_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"

繼承自VoiceResponseBase.max_output_tokens

object

物件類型必須是 realtime.response。

object?: "realtime.response"

屬性值

"realtime.response"

繼承自VoiceResponseBase.object

output_modalities

模型用來回應的模態集合,目前唯一可能的值為 [\"audio\"]。 [\"text\"] 音訊輸出必包含文字逐字稿。 將輸出設定為模式 text 會關閉模型的音訊輸出。

output_modalities?: ("text" | "audio")[]

屬性值

("text" | "audio")[]

繼承自VoiceResponseBase.output_modalities

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

屬性值

繼承自VoiceResponseBase.status_details

usage

回應的使用統計數據,將對應於帳單。 即時 API 會維持對話上下文,並附加新的項目到對話中,因此前幾回合的輸出(文字和音訊標記)將成為後續回合的輸入。

usage?: RealtimeResponseUsage

屬性值

承襲自VoiceResponseBase.usage