Struct RealtimeResponse 

pub struct RealtimeResponse {

    pub id: String,
    pub object: String,
    pub status: String,
    pub status_details: Option<RealtimeResponseStatusDetails>,
    pub output: Vec<RealtimeConversationItem>,
    pub metadata: Option<Metadata>,
    pub usage: Option<RealtimeResponseUsage>,
    pub conversation_id: Option<String>,
    pub voice: Option<VoiceIdsShared>,
    pub modalities: Option<Vec<String>>,
    pub output_audio_format: Option<String>,
    pub temperature: Option<f64>,
    pub max_response_output_tokens: Option<Value>,
}

Represents the response resource from the Realtime API.

Used By

• RealtimeServerEventResponseCreated
• RealtimeServerEventResponseDone

Fields

id: String

The unique ID of the response.

object: String

The object type, must be realtime.response.

status: String

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

status_details: Option<RealtimeResponseStatusDetails>

Additional details about the status.

output: Vec<RealtimeConversationItem>

The list of output items generated by the response.

metadata: Option<Metadata>

Metadata associated with the response.

usage: Option<RealtimeResponseUsage>

Usage statistics for the Response.

conversation_id: Option<String>

Which conversation the response is added to (auto, none, or conv_123).

voice: Option<VoiceIdsShared>

The voice the model used to respond.

modalities: Option<Vec<String>>

The set of modalities the model used to respond.

output_audio_format: Option<String>

The format of output audio.

temperature: Option<f64>

Sampling temperature used for this response.

max_response_output_tokens: Option<Value>

Maximum number of output tokens used in this response.

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 PartialEq for RealtimeResponse

fn eq(&self, other: &RealtimeResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for RealtimeResponse