Skip to main content

RealtimeSessionEvent

Enum RealtimeSessionEvent 

Source
pub enum RealtimeSessionEvent {
Show 14 variants InputTranscriptPartial { text: String, }, InputTranscriptFinal { text: String, }, InputTranscriptFinalForItem { item_id: String, previous_item_id: Option<String>, content_index: u32, text: String, }, TurnStarted, TurnCommitted, TurnCompleted { response_id: String, stop_reason: StopReason, usage: Usage, }, OutputTextDelta { delta: String, }, OutputTextDeltaForItem { response_id: String, delta_id: String, item_id: String, previous_item_id: Option<String>, content_index: u32, delta: String, }, OutputAudioChunk { chunk: RealtimeAudioChunk, }, OutputVideoChunk { chunk: RealtimeVideoChunk, }, Interrupted { response_id: Option<String>, }, ToolCallRequested { call_id: String, tool_name: String, arguments: Value, }, AssistantTranscriptTruncated { response_id: Option<String>, item_id: String, audio_played_ms: u64, truncated_text: Option<String>, }, RealtimeTranscript { event: RealtimeTranscriptEvent, },
}
Expand description

Provider-neutral realtime event stream.

Variants§

§

InputTranscriptPartial

Fields

§text: String
§

InputTranscriptFinal

Fields

§text: String
§

InputTranscriptFinalForItem

Fields

§item_id: String
§previous_item_id: Option<String>
§content_index: u32
§text: String
§

TurnStarted

§

TurnCommitted

§

TurnCompleted

Fields

§response_id: String
§stop_reason: StopReason
§usage: Usage
§

OutputTextDelta

Fields

§delta: String
§

OutputTextDeltaForItem

Fields

§response_id: String
§delta_id: String
§item_id: String
§previous_item_id: Option<String>
§content_index: u32
§delta: String
§

OutputAudioChunk

§

OutputVideoChunk

§

Interrupted

Fields

§response_id: Option<String>
§

ToolCallRequested

Fields

§call_id: String
§tool_name: String
§arguments: Value
§

AssistantTranscriptTruncated

The assistant output identified by item_id was truncated at audio_played_ms because the user barged in. truncated_text is the heard prefix, or None if the provider has not yet re-projected it.

Fields

§response_id: Option<String>
§item_id: String
§audio_played_ms: u64
§truncated_text: Option<String>
§

RealtimeTranscript

Identity-bearing transcript event for providers that need to expose an ordering/append fact without an otherwise public channel event.

Implementations§

Source§

impl RealtimeSessionEvent

Source

pub fn to_public_event(&self) -> Option<RealtimeEvent>

Project an internal provider event into the public channel event shape.

Trait Implementations§

Source§

impl Clone for RealtimeSessionEvent

Source§

fn clone(&self) -> RealtimeSessionEvent

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 RealtimeSessionEvent

Source§

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

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

impl PartialEq for RealtimeSessionEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for RealtimeSessionEvent

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more