Enum ServerEvent 

#[non_exhaustive]
pub enum ServerEvent {
    SessionCreated(SessionCreatedEvent),
    SessionUpdated(SessionUpdatedEvent),
    ConversationCreated(ConversationCreatedEvent),
    ConversationItemCreated(ConversationItemCreatedEvent),
    ConversationItemRetrieved(ConversationItemRetrievedEvent),
    ConversationItemDeleted(ConversationItemDeletedEvent),
    ConversationItemTruncated(ConversationItemTruncatedEvent),
    InputAudioTranscriptionCompleted(InputAudioTranscriptionCompletedEvent),
    InputAudioTranscriptionFailed(InputAudioTranscriptionFailedEvent),
    InputAudioBufferCommitted(InputAudioBufferCommittedEvent),
    InputAudioBufferCleared(InputAudioBufferClearedEvent),
    InputAudioBufferSpeechStarted(SpeechStartedEvent),
    InputAudioBufferSpeechStopped(SpeechStoppedEvent),
    OutputAudioBufferStarted(OutputAudioBufferEvent),
    OutputAudioBufferStopped(OutputAudioBufferStoppedEvent),
    OutputAudioBufferCleared(OutputAudioBufferEvent),
    ResponseCreated(ResponseCreatedEvent),
    ResponseDone(ResponseDoneEvent),
    ResponseOutputItemAdded(ResponseOutputItemEvent),
    ResponseOutputItemDone(ResponseOutputItemEvent),
    ResponseContentPartAdded(ResponseContentPartEvent),
    ResponseContentPartDone(ResponseContentPartEvent),
    ResponseTextDelta(ResponseTextDeltaEvent),
    ResponseTextDone(ResponseTextDoneEvent),
    ResponseAudioDelta(ResponseAudioDeltaEvent),
    ResponseAudioDone(ResponseAudioDoneEvent),
    ResponseAudioTranscriptDelta(ResponseAudioTranscriptDeltaEvent),
    ResponseAudioTranscriptDone(ResponseAudioTranscriptDoneEvent),
    ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent),
    ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent),
    RateLimitsUpdated(RateLimitsUpdatedEvent),
    Error(ErrorEvent),
    Unknown,
}

Server events received from the OpenAI Realtime API.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SessionCreated(SessionCreatedEvent)

Session was created (first event after connection).

SessionUpdated(SessionUpdatedEvent)

Session configuration was updated.

ConversationCreated(ConversationCreatedEvent)

Conversation was created.

ConversationItemCreated(ConversationItemCreatedEvent)

Conversation item was created.

ConversationItemRetrieved(ConversationItemRetrievedEvent)

Conversation item was retrieved.

ConversationItemDeleted(ConversationItemDeletedEvent)

Conversation item was deleted.

ConversationItemTruncated(ConversationItemTruncatedEvent)

Conversation item was truncated.

InputAudioTranscriptionCompleted(InputAudioTranscriptionCompletedEvent)

Input audio transcription completed.

InputAudioTranscriptionFailed(InputAudioTranscriptionFailedEvent)

Input audio transcription failed.

InputAudioBufferCommitted(InputAudioBufferCommittedEvent)

Input audio buffer was committed.

InputAudioBufferCleared(InputAudioBufferClearedEvent)

Input audio buffer was cleared.

InputAudioBufferSpeechStarted(SpeechStartedEvent)

Speech started in input audio.

InputAudioBufferSpeechStopped(SpeechStoppedEvent)

Speech stopped in input audio.

OutputAudioBufferStarted(OutputAudioBufferEvent)

Output audio buffer playback started.

OutputAudioBufferStopped(OutputAudioBufferStoppedEvent)

Output audio buffer playback stopped.

OutputAudioBufferCleared(OutputAudioBufferEvent)

Output audio buffer was cleared.

ResponseCreated(ResponseCreatedEvent)

Response was created.

ResponseDone(ResponseDoneEvent)

Response generation completed.

ResponseOutputItemAdded(ResponseOutputItemEvent)

Output item was added to response.

ResponseOutputItemDone(ResponseOutputItemEvent)

Output item completed.

ResponseContentPartAdded(ResponseContentPartEvent)

Content part was added.

ResponseContentPartDone(ResponseContentPartEvent)

Content part completed.

ResponseTextDelta(ResponseTextDeltaEvent)

Text delta received.

ResponseTextDone(ResponseTextDoneEvent)

Text output completed.

ResponseAudioDelta(ResponseAudioDeltaEvent)

Audio delta received.

ResponseAudioDone(ResponseAudioDoneEvent)

Audio output completed.

ResponseAudioTranscriptDelta(ResponseAudioTranscriptDeltaEvent)

Audio transcript delta received.

ResponseAudioTranscriptDone(ResponseAudioTranscriptDoneEvent)

Audio transcript completed.

ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent)

Function call arguments delta.

ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent)

Function call arguments completed.

RateLimitsUpdated(RateLimitsUpdatedEvent)

Rate limits updated.

Error(ErrorEvent)

Error occurred.

Unknown

An event type this version of the library does not know about.

OpenAI adds realtime events regularly. Without this arm a single unrecognised type would fail deserialization and tear down the session, so unknown events are surfaced here instead.

Note that the payload is not preserved: serde’s other attribute is only allowed on a unit variant.

Implementations

impl ServerEvent

pub fn is_error(&self) -> bool

Check if this is an error event.

pub fn event_id(&self) -> Option<&str>

Get the event ID if available.

Trait Implementations

impl Clone for ServerEvent

fn clone(&self) -> ServerEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServerEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.