Struct RealtimeClientEventSessionUpdate

pub struct RealtimeClientEventSessionUpdate {
    pub event_id: Option<String>,
    pub session: RealtimeSessionCreateRequest,
}

Send this event to update the session’s default configuration. The client may send this event at any time to update any field, except for voice. However, note that once a session has been initialized with a particular model, it can’t be changed to another model using session.update.

When the server receives a session.update, it will respond with a session.updated event showing the full, effective configuration. Only the fields that are present are updated. To clear a field like instructions, pass an empty string.

Fields

event_id: Option<String>

Optional client-generated ID used to identify this event.

session: RealtimeSessionCreateRequest

Implementations

impl RealtimeClientEventSessionUpdate

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

Create a builder for building RealtimeClientEventSessionUpdate. On the builder, call .event_id(...)(optional), .session(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RealtimeClientEventSessionUpdate.

Trait Implementations

impl Clone for RealtimeClientEventSessionUpdate

fn clone(&self) -> RealtimeClientEventSessionUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeClientEventSessionUpdate

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

Formats the value using the given formatter.

impl Default for RealtimeClientEventSessionUpdate

fn default() -> RealtimeClientEventSessionUpdate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RealtimeClientEventSessionUpdate

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeClientEventSessionUpdate

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

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 RealtimeClientEventSessionUpdate