VoiceAgentRealtimeResponseBase interface

語音代理服務回傳的即時回應所共享的屬性。

屬性

conversation_id

回應會被加入哪個對話,取決於事件中的conversation欄位response.create。 若 auto,回應將加入預設對話,且 的 conversation_id 值將為類似 conv_1234的 id。 若 none,則回應不會加入任何對話中,且 的 conversation_id 值為 null。 如果回應是由VAD自動觸發,回應會被加入預設對話中

id

回應的唯一 ID 會看起來像 resp_1234。

max_output_tokens

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

metadata

與回應相關聯的自訂字串鍵值對。

object

物件類型必須是 realtime.response。

output_modalities

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

status

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

status_details

關於狀態的更多細節。

usage

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

屬性詳細資料

conversation_id

回應會被加入哪個對話,取決於事件中的conversation欄位response.create。 若 auto,回應將加入預設對話,且 的 conversation_id 值將為類似 conv_1234的 id。 若 none,則回應不會加入任何對話中,且 的 conversation_id 值為 null。 如果回應是由VAD自動觸發,回應會被加入預設對話中

conversation_id?: string

屬性值

string

id

回應的唯一 ID 會看起來像 resp_1234。

id?: string

屬性值

string

max_output_tokens

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

max_output_tokens?: number | "inf"

屬性值

number | "inf"

metadata

與回應相關聯的自訂字串鍵值對。

metadata?: Metadata

屬性值

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"

status_details

關於狀態的更多細節。

status_details?: RealtimeResponseStatusDetails

屬性值

usage

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

usage?: RealtimeResponseUsage

屬性值