Skip to main content

KnownRealtimeServerEvent

Enum KnownRealtimeServerEvent 

Source
#[non_exhaustive]
pub enum KnownRealtimeServerEvent {
Show 44 variants Error { error: RealtimeError, extra: Extra, }, SessionCreated { session: Box<RealtimeSessionConfig>, extra: Extra, }, SessionUpdated { session: Box<RealtimeSessionConfig>, extra: Extra, }, ConversationItemAdded { item: RealtimeItem, previous_item_id: Option<String>, extra: Extra, }, ConversationItemCreated { item: RealtimeItem, previous_item_id: Option<String>, extra: Extra, }, ConversationItemDone { item: RealtimeItem, previous_item_id: Option<String>, extra: Extra, }, ConversationItemRetrieved { item: RealtimeItem, extra: Extra, }, ConversationItemTruncated { item_id: String, content_index: u32, audio_end_ms: u64, extra: Extra, }, ConversationItemDeleted { item_id: String, extra: Extra, }, InputAudioTranscriptionDelta { item_id: String, content_index: Option<u32>, delta: String, extra: Extra, }, InputAudioTranscriptionCompleted { item_id: String, content_index: Option<u32>, transcript: String, usage: Option<RealtimeUsage>, extra: Extra, }, InputAudioTranscriptionFailed { item_id: String, content_index: Option<u32>, error: RealtimeError, extra: Extra, }, InputAudioTranscriptionSegment { item_id: String, id: Option<String>, speaker: Option<String>, text: Option<String>, start: Option<f64>, end: Option<f64>, extra: Extra, }, InputAudioBufferCommitted { item_id: String, previous_item_id: Option<String>, extra: Extra, }, InputAudioBufferCleared { extra: Extra, }, InputAudioBufferSpeechStarted { item_id: String, audio_start_ms: u64, extra: Extra, }, InputAudioBufferSpeechStopped { item_id: String, audio_end_ms: u64, extra: Extra, }, InputAudioBufferTimeoutTriggered { item_id: Option<String>, audio_start_ms: Option<u64>, audio_end_ms: Option<u64>, extra: Extra, }, OutputAudioBufferStarted { response_id: String, extra: Extra, }, OutputAudioBufferStopped { response_id: String, extra: Extra, }, OutputAudioBufferCleared { response_id: String, extra: Extra, }, RateLimitsUpdated { rate_limits: Vec<RealtimeRateLimit>, extra: Extra, }, ResponseCreated { response: Box<RealtimeResponse>, extra: Extra, }, ResponseDone { response: Box<RealtimeResponse>, extra: Extra, }, ResponseOutputItemAdded { response_id: String, output_index: u32, item: RealtimeItem, extra: Extra, }, ResponseOutputItemDone { response_id: String, output_index: u32, item: RealtimeItem, extra: Extra, }, ResponseContentPartAdded { response_id: String, item_id: String, output_index: u32, content_index: u32, part: RealtimeContentPart, extra: Extra, }, ResponseContentPartDone { response_id: String, item_id: String, output_index: u32, content_index: u32, part: RealtimeContentPart, extra: Extra, }, OutputTextDelta { response_id: String, item_id: String, output_index: u32, content_index: u32, delta: String, extra: Extra, }, OutputTextDone { response_id: String, item_id: String, output_index: u32, content_index: u32, text: String, extra: Extra, }, OutputAudioTranscriptDelta { response_id: String, item_id: String, output_index: u32, content_index: u32, delta: String, extra: Extra, }, OutputAudioTranscriptDone { response_id: String, item_id: String, output_index: u32, content_index: u32, transcript: String, extra: Extra, }, OutputAudioDelta { response_id: String, item_id: String, output_index: u32, content_index: u32, delta: String, extra: Extra, }, OutputAudioDone { response_id: String, item_id: String, output_index: u32, content_index: u32, extra: Extra, }, FunctionCallArgumentsDelta { response_id: String, item_id: String, output_index: u32, call_id: String, delta: String, extra: Extra, }, FunctionCallArgumentsDone { response_id: String, item_id: String, output_index: u32, call_id: String, arguments: String, name: Option<String>, extra: Extra, }, McpCallArgumentsDelta { response_id: String, item_id: String, output_index: u32, delta: String, extra: Extra, }, McpCallArgumentsDone { response_id: String, item_id: String, output_index: u32, arguments: String, extra: Extra, }, McpCallInProgress { item_id: String, output_index: u32, extra: Extra, }, McpCallCompleted { item_id: String, output_index: u32, extra: Extra, }, McpCallFailed { item_id: String, output_index: u32, extra: Extra, }, McpListToolsInProgress { item_id: Option<String>, extra: Extra, }, McpListToolsCompleted { item_id: Option<String>, extra: Extra, }, McpListToolsFailed { item_id: Option<String>, extra: Extra, },
}

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Error

Fields

§extra: Extra
§

SessionCreated

Fields

§extra: Extra
§

SessionUpdated

Fields

§extra: Extra
§

ConversationItemAdded

Fields

§previous_item_id: Option<String>
§extra: Extra
§

ConversationItemCreated

Beta-era alias of conversation.item.added still emitted by some peers.

Fields

§previous_item_id: Option<String>
§extra: Extra
§

ConversationItemDone

Fields

§previous_item_id: Option<String>
§extra: Extra
§

ConversationItemRetrieved

Fields

§extra: Extra
§

ConversationItemTruncated

Fields

§item_id: String
§content_index: u32
§audio_end_ms: u64
§extra: Extra
§

ConversationItemDeleted

Fields

§item_id: String
§extra: Extra
§

InputAudioTranscriptionDelta

Fields

§item_id: String
§content_index: Option<u32>
§delta: String
§extra: Extra
§

InputAudioTranscriptionCompleted

Fields

§item_id: String
§content_index: Option<u32>
§transcript: String
§extra: Extra
§

InputAudioTranscriptionFailed

Fields

§item_id: String
§content_index: Option<u32>
§extra: Extra
§

InputAudioTranscriptionSegment

Fields

§item_id: String
§speaker: Option<String>
§start: Option<f64>
§extra: Extra
§

InputAudioBufferCommitted

Fields

§item_id: String
§previous_item_id: Option<String>
§extra: Extra
§

InputAudioBufferCleared

Fields

§extra: Extra
§

InputAudioBufferSpeechStarted

Fields

§item_id: String
§audio_start_ms: u64
§extra: Extra
§

InputAudioBufferSpeechStopped

Fields

§item_id: String
§audio_end_ms: u64
§extra: Extra
§

InputAudioBufferTimeoutTriggered

Fields

§item_id: Option<String>
§audio_start_ms: Option<u64>
§audio_end_ms: Option<u64>
§extra: Extra
§

OutputAudioBufferStarted

Fields

§response_id: String
§extra: Extra
§

OutputAudioBufferStopped

Fields

§response_id: String
§extra: Extra
§

OutputAudioBufferCleared

Fields

§response_id: String
§extra: Extra
§

RateLimitsUpdated

Fields

§rate_limits: Vec<RealtimeRateLimit>
§extra: Extra
§

ResponseCreated

Fields

§extra: Extra
§

ResponseDone

Fields

§extra: Extra
§

ResponseOutputItemAdded

Fields

§response_id: String
§output_index: u32
§extra: Extra
§

ResponseOutputItemDone

Fields

§response_id: String
§output_index: u32
§extra: Extra
§

ResponseContentPartAdded

Fields

§response_id: String
§item_id: String
§output_index: u32
§content_index: u32
§extra: Extra
§

ResponseContentPartDone

Fields

§response_id: String
§item_id: String
§output_index: u32
§content_index: u32
§extra: Extra
§

OutputTextDelta

Fields

§response_id: String
§item_id: String
§output_index: u32
§content_index: u32
§delta: String
§extra: Extra
§

OutputTextDone

Fields

§response_id: String
§item_id: String
§output_index: u32
§content_index: u32
§text: String
§extra: Extra
§

OutputAudioTranscriptDelta

Fields

§response_id: String
§item_id: String
§output_index: u32
§content_index: u32
§delta: String
§extra: Extra
§

OutputAudioTranscriptDone

Fields

§response_id: String
§item_id: String
§output_index: u32
§content_index: u32
§transcript: String
§extra: Extra
§

OutputAudioDelta

Fields

§response_id: String
§item_id: String
§output_index: u32
§content_index: u32
§delta: String

Base64-encoded audio in the session output format.

§extra: Extra
§

OutputAudioDone

Fields

§response_id: String
§item_id: String
§output_index: u32
§content_index: u32
§extra: Extra
§

FunctionCallArgumentsDelta

Fields

§response_id: String
§item_id: String
§output_index: u32
§call_id: String
§delta: String
§extra: Extra
§

FunctionCallArgumentsDone

Fields

§response_id: String
§item_id: String
§output_index: u32
§call_id: String
§arguments: String
§extra: Extra
§

McpCallArgumentsDelta

Fields

§response_id: String
§item_id: String
§output_index: u32
§delta: String
§extra: Extra
§

McpCallArgumentsDone

Fields

§response_id: String
§item_id: String
§output_index: u32
§arguments: String
§extra: Extra
§

McpCallInProgress

Fields

§item_id: String
§output_index: u32
§extra: Extra
§

McpCallCompleted

Fields

§item_id: String
§output_index: u32
§extra: Extra
§

McpCallFailed

Fields

§item_id: String
§output_index: u32
§extra: Extra
§

McpListToolsInProgress

Fields

§item_id: Option<String>
§extra: Extra
§

McpListToolsCompleted

Fields

§item_id: Option<String>
§extra: Extra
§

McpListToolsFailed

Fields

§item_id: Option<String>
§extra: Extra

Trait Implementations§

Source§

impl Clone for KnownRealtimeServerEvent

Source§

fn clone(&self) -> KnownRealtimeServerEvent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KnownRealtimeServerEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for KnownRealtimeServerEvent

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for KnownRealtimeServerEvent

Source§

fn eq(&self, other: &KnownRealtimeServerEvent) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for KnownRealtimeServerEvent

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for KnownRealtimeServerEvent

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.