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

This event is the output of audio transcription for user audio written to the user audio buffer. Transcription begins when the input audio buffer is committed by the client or server (when VAD is enabled). Transcription runs asynchronously with Response creation, so this event may come before or after the Response events.

Realtime API models accept audio natively, and thus input transcription is a separate process run on a separate ASR (Automatic Speech Recognition) model. The transcript may diverge somewhat from the model's interpretation, and should be treated as a rough guide.

Fields

  • :content_index - required - integer()
    The index of the content part containing the audio.

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

  • :item_id - required - String.t()
    The ID of the item containing the audio that is being transcribed.

  • :logprobs - optional - [ExOpenAI.Components.LogProbProperties.t()] | any()

  • :transcript - required - String.t()
    The transcribed text.

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

  • :usage - required - map()
    Usage statistics for the transcription, this is billed according to the ASR model's pricing rather than the realtime model's pricing.

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() ::
  %ExOpenAI.Components.RealtimeServerEventConversationItemInputAudioTranscriptionCompleted{
    content_index: integer(),
    event_id: String.t(),
    item_id: String.t(),
    logprobs: ([ExOpenAI.Components.LogProbProperties.t()] | any()) | nil,
    transcript: String.t(),
    type: :"conversation.item.input_audio_transcription.completed",
    usage: map()
  }