View Source ExOpenAI.Components.RealtimeServerEventConversationItemTruncated (ex_openai.ex v2.0.0-beta2)

Returned when an earlier assistant audio message item is truncated by the client with a conversation.item.truncate event. This event is used to synchronize the server's understanding of the audio with the client's playback.

This action will truncate the audio and remove the server-side text transcript to ensure there is no text in the context that hasn't been heard by the user.

Fields

  • :audio_end_ms - required - integer()
    The duration up to which the audio was truncated, in milliseconds.

  • :content_index - required - integer()
    The index of the content part that was truncated.

  • :event_id - required - String.t()
    The unique ID of the server event.

  • :item_id - required - String.t()
    The ID of the assistant message item that was truncated.

  • :type - required - :"conversation.item.truncated"
    The event type, must be conversation.item.truncated.
    Allowed values: "conversation.item.truncated"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.RealtimeServerEventConversationItemTruncated{
  audio_end_ms: integer(),
  content_index: integer(),
  event_id: String.t(),
  item_id: String.t(),
  type: :"conversation.item.truncated"
}