Struct RealtimeClientEventResponseCreate

pub struct RealtimeClientEventResponseCreate {
    pub event_id: Option<String>,
    pub response: Option<RealtimeResponseCreateParams>,
}

This event instructs the server to create a Response, which means triggering model inference. When in Server VAD mode, the server will create Responses automatically.

A Response will include at least one Item, and may have two, in which case the second will be a function call. These Items will be appended to the conversation history.

The server will respond with a response.created event, events for Items and content created, and finally a response.done event to indicate the Response is complete.

The response.create event includes inference configuration like instructions, and temperature. These fields will override the Session’s configuration for this Response only.

Fields

event_id: Option<String>

Optional client-generated ID used to identify this event.

response: Option<RealtimeResponseCreateParams>

Implementations

impl RealtimeClientEventResponseCreate

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

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

Trait Implementations

impl Clone for RealtimeClientEventResponseCreate

fn clone(&self) -> RealtimeClientEventResponseCreate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeClientEventResponseCreate

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

Formats the value using the given formatter.

impl Default for RealtimeClientEventResponseCreate

fn default() -> RealtimeClientEventResponseCreate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RealtimeClientEventResponseCreate

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeClientEventResponseCreate

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

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 RealtimeClientEventResponseCreate