VoiceAgentRealtimeResponseBase interface

Proprietà condivise tramite risposte in tempo reale restituite dal servizio voice-agent.

Proprietà

conversation_id

A quale conversazione viene aggiunta la risposta, determinata dal campo dell'evento conversationresponse.create . Se auto, la risposta sarà aggiunta alla conversazione predefinita e il valore di conversation_id sarà un id come conv_1234. Se none, la risposta non sarà aggiunta a nessuna conversazione e il valore di conversation_id sarà null. Se le risposte vengono attivate automaticamente dal VAD, la risposta verrà aggiunta alla conversazione predefinita

id

L'ID unico della risposta sarà simile resp_1234a .

max_output_tokens

Numero massimo di token di output per una singola risposta di assistente, inclusi i call degli strumenti, utilizzati in questa risposta.

metadata

Coppie chiave-valore personalizzate di stringhe associate alla risposta.

object

Il tipo di oggetto, deve essere realtime.response.

output_modalities

L'insieme delle modalità usate dal modello per rispondere, attualmente gli unici valori possibili sono [\"audio\"], [\"text\"]. L'uscita audio include sempre una trascrizione testuale. Impostando l'uscita in modalità text disabilitato l'uscita audio dal modello.

status

Lo stato finale della risposta (completed, cancelled, failed, o incomplete, in_progress).

status_details

Dettagli aggiuntivi sullo stato.

usage

Statistiche di utilizzo per la Risposta, questo corrisponderà alla fatturazione. Una sessione API in tempo reale manterrà un contesto di conversazione e aggiungerà nuovi Elementi alla Conversazione, quindi l'output dei turni precedenti (token testuali e audio) diventerà l'input per i turni successivi.

Dettagli proprietà

conversation_id

A quale conversazione viene aggiunta la risposta, determinata dal campo dell'evento conversationresponse.create . Se auto, la risposta sarà aggiunta alla conversazione predefinita e il valore di conversation_id sarà un id come conv_1234. Se none, la risposta non sarà aggiunta a nessuna conversazione e il valore di conversation_id sarà null. Se le risposte vengono attivate automaticamente dal VAD, la risposta verrà aggiunta alla conversazione predefinita

conversation_id?: string

Valore della proprietà

string

id

L'ID unico della risposta sarà simile resp_1234a .

id?: string

Valore della proprietà

string

max_output_tokens

Numero massimo di token di output per una singola risposta di assistente, inclusi i call degli strumenti, utilizzati in questa risposta.

max_output_tokens?: number | "inf"

Valore della proprietà

number | "inf"

metadata

Coppie chiave-valore personalizzate di stringhe associate alla risposta.

metadata?: Metadata

Valore della proprietà

object

Il tipo di oggetto, deve essere realtime.response.

object?: "realtime.response"

Valore della proprietà

"realtime.response"

output_modalities

L'insieme delle modalità usate dal modello per rispondere, attualmente gli unici valori possibili sono [\"audio\"], [\"text\"]. L'uscita audio include sempre una trascrizione testuale. Impostando l'uscita in modalità text disabilitato l'uscita audio dal modello.

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

Valore della proprietà

("text" | "audio")[]

status

Lo stato finale della risposta (completed, cancelled, failed, o incomplete, in_progress).

status?: "failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

Valore della proprietà

"failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

status_details

Dettagli aggiuntivi sullo stato.

status_details?: RealtimeResponseStatusDetails

Valore della proprietà

usage

Statistiche di utilizzo per la Risposta, questo corrisponderà alla fatturazione. Una sessione API in tempo reale manterrà un contesto di conversazione e aggiungerà nuovi Elementi alla Conversazione, quindi l'output dei turni precedenti (token testuali e audio) diventerà l'input per i turni successivi.

usage?: RealtimeResponseUsage

Valore della proprietà