View Source ExOpenAI.Components.RealtimeResponse (ex_openai.ex v1.8.0)

Schema representing a RealtimeResponse within the OpenAI API

Summary

Types

@type t() :: %ExOpenAI.Components.RealtimeResponse{
  conversation_id: String.t() | nil,
  id: String.t() | nil,
  max_output_tokens: (:inf | integer()) | nil,
  metadata: ExOpenAI.Components.Metadata.t() | nil,
  modalities: [:audio | :text] | nil,
  object: :"realtime.response" | nil,
  output: [ExOpenAI.Components.RealtimeConversationItem.t()] | nil,
  output_audio_format: (:g711_alaw | :g711_ulaw | :pcm16) | nil,
  status: (:incomplete | :failed | :cancelled | :completed) | nil,
  status_details:
    %{
      error: %{code: String.t(), type: String.t()},
      reason:
        :content_filter
        | :max_output_tokens
        | :client_cancelled
        | :turn_detected,
      type: :incomplete | :failed | :cancelled | :completed
    }
    | nil,
  temperature: float() | nil,
  usage:
    %{
      input_token_details: %{
        audio_tokens: integer(),
        cached_tokens: integer(),
        text_tokens: integer()
      },
      input_tokens: integer(),
      output_token_details: %{audio_tokens: integer(), text_tokens: integer()},
      output_tokens: integer(),
      total_tokens: integer()
    }
    | nil,
  voice:
    (:verse | :shimmer | :sage | :echo | :coral | :ballad | :ash | :alloy) | nil
}