Struct RealtimeResponse 

pub struct RealtimeResponse {
    pub audio: Option<ResponseAudio>,
    pub conversation_id: Option<String>,
    pub id: String,
    pub max_output_tokens: MaxOutputTokens,
    pub metadata: Option<HashMap<String, String>>,
    pub object: String,
    pub output: Vec<RealtimeConversationItem>,
    pub output_modalities: Vec<String>,
    pub status: RealtimeResponseStatus,
    pub status_details: Option<RealtimeResponseStatusDetail>,
    pub usage: Option<RealtimeResponseUsage>,
}

Available on crate feature realtime only.

Fields

audio: Option<ResponseAudio>

Configuration for audio output.

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 automatically by VAD the response will be added to the default conversation.

id: String

The unique ID of the response, will look like resp_1234.

max_output_tokens: MaxOutputTokens

Maximum number of output tokens for a single assistant response, inclusive of tool calls, that was used in this response.

metadata: Option<HashMap<String, String>>

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

object: String

The object type, must be “realtime.response”.

output: Vec<RealtimeConversationItem>

The list of output items generated by the response.

output_modalities: Vec<String>

The set of modalities the model used to respond, currently the only possible values are ["audio"], ["text"]. Audio output always include a text transcript. Setting the output to mode text will disable audio output from the model.

status: RealtimeResponseStatus

The final status of the response (completed, cancelled, failed, or incomplete, in_progress).

status_details: Option<RealtimeResponseStatusDetail>

Additional details about the status.

usage: Option<RealtimeResponseUsage>

Usage statistics for the Response, this will correspond to billing. A Realtime API session will maintain a conversation context and append new Items to the Conversation, thus output from previous turns (text and audio tokens) will become the input for later turns.

Trait Implementations

impl Clone for RealtimeResponse

fn clone(&self) -> RealtimeResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RealtimeResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RealtimeResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RealtimeResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.