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

Returned when input audio transcription is configured, and a transcription request for a user message failed. These events are separate from other error events so that the client can identify the related Item.

Fields

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

  • :error - required - {:%{}, [], [{{:optional, [], [:code]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:optional, [], [:message]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:optional, [], [:param]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:optional, [], [:type]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}]}
    Details of the transcription error.

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

  • :item_id - required - String.t()
    The ID of the user message item.

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

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() ::
  %ExOpenAI.Components.RealtimeServerEventConversationItemInputAudioTranscriptionFailed{
    content_index: integer(),
    error: %{
      optional(:code) => String.t(),
      optional(:message) => String.t(),
      optional(:param) => String.t(),
      optional(:type) => String.t()
    },
    event_id: String.t(),
    item_id: String.t(),
    type: :"conversation.item.input_audio_transcription.failed"
  }