Enum ServerEvent

pub enum ServerEvent {
    Error(ErrorEvent),
    SessionCreated(SessionCreatedEvent),
    SessionUpdated(SessionUpdatedEvent),
    ConversationCreated(ConversationCreatedEvent),
    InputAudioBufferCommited(InputAudioBufferCommitedEvent),
    InputAudioBufferCleared(InputAudioBufferClearedEvent),
    InputAudioBufferSpeechStarted(InputAudioBufferSpeechStartedEvent),
    InputAudioBufferSpeechStopped(InputAudioBufferSpeechStoppedEvent),
    ConversationItemCreated(ConversationItemCreatedEvent),
    ConversationItemInputAudioTranscriptionCompleted(ConversationItemInputAudioTranscriptionCompletedEvent),
    ConversationItemInputAudioTranscriptionFailed(ConversationItemInputAudioTranscriptionFailedEvent),
    ConversationItemTruncated(ConversationItemTruncatedEvent),
    ConversationItemDeleted(ConversationItemDeletedEvent),
    ResponseCreated(ResponseCreatedEvent),
    ResponseDone(ResponseDoneEvent),
    ResponseOutputItemAdded(ResponseOutputItemAddedEvent),
    ResponseOutputItemDone(ResponseOutputItemDoneEvent),
    ResponseContentPartAdded(ResponseContentPartAddedEvent),
    ResponseContentPartDone(ResponseContentPartDoneEvent),
    ResponseTextDelta(ResponseTextDeltaEvent),
    ResponseTextDone(ResponseTextDoneEvent),
    ResponseAudioTranscriptDelta(ResponseAudioTranscriptDeltaEvent),
    ResponseAudioTranscriptDone(ResponseAudioTranscriptDoneEvent),
    ResponseAudioDelta(ResponseAudioDeltaEvent),
    ResponseAudioDone(ResponseAudioDoneEvent),
    ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent),
    ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent),
    RateLimitsUpdated(RateLimitsUpdatedEvent),
}

Available on crate feature realtime only.

These are events emitted from the OpenAI Realtime WebSocket server to the client.

Variants

Error(ErrorEvent)

Returned when an error occurs.

SessionCreated(SessionCreatedEvent)

Returned when a session is created. Emitted automatically when a new connection is established.

SessionUpdated(SessionUpdatedEvent)

Returned when a session is updated.

ConversationCreated(ConversationCreatedEvent)

Returned when a conversation is created. Emitted right after session creation.

InputAudioBufferCommited(InputAudioBufferCommitedEvent)

Returned when an input audio buffer is committed, either by the client or automatically in server VAD mode.

InputAudioBufferCleared(InputAudioBufferClearedEvent)

Returned when the input audio buffer is cleared by the client.

InputAudioBufferSpeechStarted(InputAudioBufferSpeechStartedEvent)

Returned in server turn detection mode when speech is detected.

InputAudioBufferSpeechStopped(InputAudioBufferSpeechStoppedEvent)

Returned in server turn detection mode when speech stops.

ConversationItemCreated(ConversationItemCreatedEvent)

Returned when a conversation item is created.

ConversationItemInputAudioTranscriptionCompleted(ConversationItemInputAudioTranscriptionCompletedEvent)

Returned when input audio transcription is enabled and a transcription succeeds.

ConversationItemInputAudioTranscriptionFailed(ConversationItemInputAudioTranscriptionFailedEvent)

Returned when input audio transcription is configured, and a transcription request for a user message failed.

ConversationItemTruncated(ConversationItemTruncatedEvent)

Returned when an earlier assistant audio message item is truncated by the client.

ConversationItemDeleted(ConversationItemDeletedEvent)

Returned when an item in the conversation is deleted.

ResponseCreated(ResponseCreatedEvent)

Returned when a new Response is created. The first event of response creation, where the response is in an initial state of “in_progress”.

ResponseDone(ResponseDoneEvent)

Returned when a Response is done streaming. Always emitted, no matter the final state.

ResponseOutputItemAdded(ResponseOutputItemAddedEvent)

Returned when a new Item is created during response generation.

ResponseOutputItemDone(ResponseOutputItemDoneEvent)

Returned when an Item is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

ResponseContentPartAdded(ResponseContentPartAddedEvent)

Returned when a new content part is added to an assistant message item during response generation.

ResponseContentPartDone(ResponseContentPartDoneEvent)

Returned when a content part is done streaming in an assistant message item. Also emitted when a Response is interrupted, incomplete, or cancelled.

ResponseTextDelta(ResponseTextDeltaEvent)

Returned when the text value of a “text” content part is updated.

ResponseTextDone(ResponseTextDoneEvent)

Returned when the text value of a “text” content part is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

ResponseAudioTranscriptDelta(ResponseAudioTranscriptDeltaEvent)

Returned when the model-generated transcription of audio output is updated.

ResponseAudioTranscriptDone(ResponseAudioTranscriptDoneEvent)

Returned when the model-generated transcription of audio output is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

ResponseAudioDelta(ResponseAudioDeltaEvent)

Returned when the model-generated audio is updated.

ResponseAudioDone(ResponseAudioDoneEvent)

Returned when the model-generated audio is done. Also emitted when a Response is interrupted, incomplete, or cancelled.

ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent)

Returned when the model-generated function call arguments are updated.

ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent)

Returned when the model-generated function call arguments are done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

RateLimitsUpdated(RateLimitsUpdatedEvent)

Emitted after every “response.done” event to indicate the updated rate limits.

Trait Implementations

impl Clone for ServerEvent

fn clone(&self) -> ServerEvent

Returns a copy 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.

impl Serialize for ServerEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.