pub struct RealtimeResponse {Show 13 fields
pub conversation_id: Option<String>,
pub id: Option<String>,
pub max_output_tokens: Option<Value>,
pub metadata: Option<Metadata>,
pub modalities: Option<Vec<String>>,
pub object: Option<String>,
pub output: Option<Vec<RealtimeConversationItem>>,
pub output_audio_format: Option<String>,
pub status: Option<String>,
pub status_details: Option<RealtimeResponseStatusDetails>,
pub temperature: Option<f32>,
pub usage: Option<RealtimeResponseUsage>,
pub voice: Option<VoiceIdsShared>,
}
Fields§
§conversation_id: Option<String>
Which conversation the response is added to, determined by the conversation
field in the response.create
event. If auto
, the response will be added to the default conversation and the value of conversation_id
will be an id like conv_1234
. If none
, the response will not be added to any conversation and the value of conversation_id
will be null
. If responses are being triggered by server VAD, the response will be added to the default conversation, thus the conversation_id
will be an id like conv_1234
.
id: Option<String>
The unique ID of the response.
max_output_tokens: Option<Value>
Maximum number of output tokens for a single assistant response, inclusive of tool calls, that was used in this response.
metadata: Option<Metadata>
§modalities: Option<Vec<String>>
The set of modalities the model used to respond. If there are multiple modalities, the model will pick one, for example if modalities
is [\"text\", \"audio\"]
, the model could be responding in either text or audio.
object: Option<String>
The object type, must be realtime.response
.
output: Option<Vec<RealtimeConversationItem>>
The list of output items generated by the response.
output_audio_format: Option<String>
The format of output audio. Options are pcm16
, g711_ulaw
, or g711_alaw
.
status: Option<String>
The final status of the response (completed
, cancelled
, failed
, or incomplete
).
status_details: Option<RealtimeResponseStatusDetails>
§temperature: Option<f32>
Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.
usage: Option<RealtimeResponseUsage>
§voice: Option<VoiceIdsShared>
The voice the model used to respond. Current voice options are alloy
, ash
, ballad
, coral
, echo
, fable
, onyx
, nova
, sage
, shimmer
, and verse
.