Struct RealtimeResponseStatusDetails

pub struct RealtimeResponseStatusDetails {
    pub type: Option<RealtimeResponseStatusDetailsType>,
    pub reason: Option<RealtimeResponseStatusDetailsReason>,
    pub error: Option<RealtimeResponseStatusDetailsError>,
}

Additional details about the status.

Fields

type: Option<RealtimeResponseStatusDetailsType>

The type of error that caused the response to fail, corresponding with the status field (completed, cancelled, incomplete, failed).

reason: Option<RealtimeResponseStatusDetailsReason>

The reason the Response did not complete. For a cancelled Response, one of turn_detected (the server VAD detected a new start of speech) or client_cancelled (the client sent a cancel event). For an incomplete Response, one of max_output_tokens or content_filter (the server-side safety filter activated and cut off the response).

error: Option<RealtimeResponseStatusDetailsError>

A description of the error that caused the response to fail, populated when the status is failed.

Implementations

impl RealtimeResponseStatusDetails

pub fn builder() -> RealtimeResponseStatusDetailsBuilder<((), (), ())>

Create a builder for building RealtimeResponseStatusDetails. On the builder, call .r#type(...)(optional), .reason(...)(optional), .error(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RealtimeResponseStatusDetails.

Trait Implementations

impl Clone for RealtimeResponseStatusDetails

fn clone(&self) -> RealtimeResponseStatusDetails

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeResponseStatusDetails

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

Formats the value using the given formatter.

impl Default for RealtimeResponseStatusDetails

fn default() -> RealtimeResponseStatusDetails

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RealtimeResponseStatusDetails

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeResponseStatusDetails

fn eq(&self, other: &RealtimeResponseStatusDetails) -> 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 RealtimeResponseStatusDetails

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 RealtimeResponseStatusDetails