Enum ClientEvent

pub enum ClientEvent {
    SessionUpdate(SessionUpdateEvent),
    InputAudioBufferAppend(InputAudioBufferAppendEvent),
    InputAudioBufferCommit(InputAudioBufferCommitEvent),
    InputAudioBufferClear(InputAudioBufferClearEvent),
    ConversationItemCreate(ConversationItemCreateEvent),
    ConversationItemTruncate(ConversationItemTruncateEvent),
    ConversationItemDelete(ConversationItemDeleteEvent),
    ResponseCreate(ResponseCreateEvent),
    ResponseCancel(ResponseCancelEvent),
}

Available on crate feature realtime only.

These are events that the OpenAI Realtime WebSocket server will accept from the client.

Variants

SessionUpdate(SessionUpdateEvent)

Send this event to update the session’s default configuration.

InputAudioBufferAppend(InputAudioBufferAppendEvent)

Send this event to append audio bytes to the input audio buffer.

InputAudioBufferCommit(InputAudioBufferCommitEvent)

Send this event to commit audio bytes to a user message.

InputAudioBufferClear(InputAudioBufferClearEvent)

Send this event to clear the audio bytes in the buffer.

ConversationItemCreate(ConversationItemCreateEvent)

Send this event when adding an item to the conversation.

ConversationItemTruncate(ConversationItemTruncateEvent)

Send this event when you want to truncate a previous assistant message’s audio.

ConversationItemDelete(ConversationItemDeleteEvent)

Send this event when you want to remove any item from the conversation history.

ResponseCreate(ResponseCreateEvent)

Send this event to trigger a response generation.

ResponseCancel(ResponseCancelEvent)

Send this event to cancel an in-progress response.

Trait Implementations

impl Debug for ClientEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ConversationItemCreateEvent> for ClientEvent

fn from(value: ConversationItemCreateEvent) -> Self

Converts to this type from the input type.

impl From<ConversationItemDeleteEvent> for ClientEvent

fn from(value: ConversationItemDeleteEvent) -> Self

Converts to this type from the input type.

impl From<ConversationItemTruncateEvent> for ClientEvent

fn from(value: ConversationItemTruncateEvent) -> Self

Converts to this type from the input type.

impl From<InputAudioBufferAppendEvent> for ClientEvent

fn from(value: InputAudioBufferAppendEvent) -> Self

Converts to this type from the input type.

impl From<InputAudioBufferClearEvent> for ClientEvent

fn from(value: InputAudioBufferClearEvent) -> Self

Converts to this type from the input type.

impl From<InputAudioBufferCommitEvent> for ClientEvent

fn from(value: InputAudioBufferCommitEvent) -> Self

Converts to this type from the input type.

impl From<ResponseCancelEvent> for ClientEvent

fn from(value: ResponseCancelEvent) -> Self

Converts to this type from the input type.

impl From<ResponseCreateEvent> for ClientEvent

fn from(value: ResponseCreateEvent) -> Self

Converts to this type from the input type.

impl From<SessionUpdateEvent> for ClientEvent

fn from(value: SessionUpdateEvent) -> Self

Converts to this type from the input type.

impl Into<String> for &ClientEvent

fn into(self) -> String

Converts this type into the (usually inferred) input type.

impl Serialize for ClientEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.