Struct RealtimeClientEventConversationItemTruncate

pub struct RealtimeClientEventConversationItemTruncate {
    pub event_id: Option<String>,
    pub item_id: String,
    pub content_index: u64,
    pub audio_end_ms: u64,
}

Send this event to truncate a previous assistant message’s audio. The server will produce audio faster than realtime, so this event is useful when the user interrupts to truncate audio that has already been sent to the client but not yet played. This will synchronize the server’s understanding of the audio with the client’s playback.

Truncating audio will delete the server-side text transcript to ensure there is not text in the context that hasn’t been heard by the user.

If successful, the server will respond with a conversation.item.truncated event.

Fields

event_id: Option<String>

Optional client-generated ID used to identify this event.

item_id: String

The ID of the assistant message item to truncate. Only assistant message items can be truncated.

content_index: u64

The index of the content part to truncate. Set this to 0.

audio_end_ms: u64

Inclusive duration up to which audio is truncated, in milliseconds. If the audio_end_ms is greater than the actual audio duration, the server will respond with an error.

Implementations

impl RealtimeClientEventConversationItemTruncate

pub fn builder() -> RealtimeClientEventConversationItemTruncateBuilder<((), (), (), ())>

Create a builder for building RealtimeClientEventConversationItemTruncate. On the builder, call .event_id(...)(optional), .item_id(...), .content_index(...), .audio_end_ms(...) to set the values of the fields. Finally, call .build() to create the instance of RealtimeClientEventConversationItemTruncate.

Trait Implementations

impl Clone for RealtimeClientEventConversationItemTruncate

fn clone(&self) -> RealtimeClientEventConversationItemTruncate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeClientEventConversationItemTruncate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RealtimeClientEventConversationItemTruncate

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeClientEventConversationItemTruncate

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for RealtimeClientEventConversationItemTruncate

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RealtimeClientEventConversationItemTruncate