Skip to main content

RealtimeTranscriptEvent

Enum RealtimeTranscriptEvent 

Source
pub enum RealtimeTranscriptEvent {
    ItemObserved {
        item_id: String,
        previous_item_id: Option<String>,
        role: RealtimeTranscriptRole,
        response_id: Option<String>,
    },
    ItemSkipped {
        item_id: String,
        previous_item_id: Option<String>,
    },
    UserTranscriptFinal {
        item_id: String,
        previous_item_id: Option<String>,
        content_index: u32,
        text: String,
    },
    AssistantTextDelta {
        response_id: String,
        delta_id: String,
        item_id: String,
        previous_item_id: Option<String>,
        content_index: u32,
        delta: String,
    },
    AssistantTranscriptDelta {
        response_id: String,
        delta_id: String,
        item_id: String,
        previous_item_id: Option<String>,
        content_index: u32,
        delta: String,
    },
    AssistantTranscriptTruncated {
        response_id: String,
        item_id: String,
        content_index: u32,
        text: String,
    },
    AssistantTranscriptFinalText {
        response_id: String,
        item_id: String,
        content_index: u32,
        text: String,
    },
    AssistantTurnCompleted {
        response_id: String,
        stop_reason: StopReason,
        usage: Usage,
    },
    AssistantTurnInterrupted {
        response_id: String,
    },
}
Expand description

A typed, identity-bearing realtime transcript event consumed by the session.

Variants§

§

ItemObserved

Observe a provider item and its causal predecessor without committing content yet.

Fields

§item_id: String
§previous_item_id: Option<String>
§response_id: Option<String>
§

ItemSkipped

Observe a provider item that participates in provider causal ordering but must not materialize transcript content.

Fields

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

UserTranscriptFinal

Provider finalized the transcript for a user input item.

Fields

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

AssistantTextDelta

Provider emitted an assistant display-text delta for an output item — authored text the model writes (e.g. OpenAI realtime response.output_text.delta).

Materializes as crate::types::AssistantBlock::Text.

Fields

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

AssistantTranscriptDelta

Provider emitted an assistant spoken-transcript delta for an output item — text derived from audio output (e.g. OpenAI realtime response.output_audio_transcript.delta).

Identity shape mirrors Self::AssistantTextDelta so the session’s idempotent ordering / staging logic owns dedup uniformly across lanes. Materializes as crate::types::AssistantBlock::Transcript with source: TranscriptSource::Spoken (T9/T10).

Fields

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

AssistantTranscriptTruncated

Provider reported the assistant output item was truncated to the heard transcript prefix.

Fields

§response_id: String
§item_id: String
§content_index: u32
§text: String
§

AssistantTranscriptFinalText

R5-7: provider supplied authoritative final transcript text for an assistant output item, overriding any incomplete delta accumulation.

Necessary for two cases:

  1. Final-only providers that emit a single AssistantTranscriptFinal observation without prior deltas.
  2. Recovery from delta loss (R5-1: lossy media lane back-pressure may drop transcript deltas; the final’s text is the authoritative reconciliation).

The materializer locates the staged item by (response_id, item_id, content_index), replaces its accumulated content with text, and (if no item is staged yet) creates one on the spoken lane. Flush still happens via AssistantTurnCompleted; this variant only updates the staged content.

Fields

§response_id: String
§item_id: String
§content_index: u32
§text: String
§

AssistantTurnCompleted

Provider turn reached a terminal boundary. The session decides which staged assistant items, if any, are now canonical.

Fields

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

AssistantTurnInterrupted

Provider turn was interrupted before terminal materialization.

Fields

§response_id: String

Trait Implementations§

Source§

impl Clone for RealtimeTranscriptEvent

Source§

fn clone(&self) -> RealtimeTranscriptEvent

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 RealtimeTranscriptEvent

Source§

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

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

impl<'de> Deserialize<'de> for RealtimeTranscriptEvent

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 JsonSchema for RealtimeTranscriptEvent

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for RealtimeTranscriptEvent

Source§

fn eq(&self, other: &RealtimeTranscriptEvent) -> 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 Serialize for RealtimeTranscriptEvent

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 RealtimeTranscriptEvent

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> Same for T

Source§

type Output = T

Should always be Self
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
Source§

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