Codex.Realtime.ModelEvents (Codex SDK v0.7.2)

Low-level events from the realtime model transport layer.

These events are emitted by the WebSocket connection and represent raw model communication. They are typically wrapped in session events before being exposed to application code.

Summary

Types

connection_status()

t()

Functions

audio(opts)

Create an audio event.

audio_done(opts)

Create an audio done event.

audio_interrupted(opts)

Create an audio interrupted event.

connection_status(status)

Create a connection status event.

error(error)

Create an error event.

exception(exception, context \\ nil)

Create an exception event.

from_json(json)

Parse model event from JSON.

input_audio_transcription_completed(opts)

Create an input audio transcription completed event.

item_deleted(item_id)

Create an item deleted event.

item_updated(item)

Create an item updated event.

other(data)

Create an other event.

raw_server_event(data)

Create a raw server event.

tool_call(opts)

Create a tool call event.

transcript_delta(opts)

Create a transcript delta event.

turn_ended()

Create a turn ended event.

turn_started()

Create a turn started event.

Types

connection_status()

@type connection_status() :: :connecting | :connected | :disconnected

t()

@type t() ::
  Codex.Realtime.ModelEvents.ConnectionStatusEvent.t()
  | Codex.Realtime.ModelEvents.ErrorEvent.t()
  | Codex.Realtime.ModelEvents.ToolCallEvent.t()
  | Codex.Realtime.ModelEvents.AudioEvent.t()
  | Codex.Realtime.ModelEvents.AudioDoneEvent.t()
  | Codex.Realtime.ModelEvents.AudioInterruptedEvent.t()
  | Codex.Realtime.ModelEvents.TranscriptDeltaEvent.t()
  | Codex.Realtime.ModelEvents.ItemUpdatedEvent.t()
  | Codex.Realtime.ModelEvents.ItemDeletedEvent.t()
  | Codex.Realtime.ModelEvents.TurnStartedEvent.t()
  | Codex.Realtime.ModelEvents.TurnEndedEvent.t()
  | Codex.Realtime.ModelEvents.InputAudioTranscriptionCompletedEvent.t()
  | Codex.Realtime.ModelEvents.InputAudioTimeoutTriggeredEvent.t()
  | Codex.Realtime.ModelEvents.OtherEvent.t()
  | Codex.Realtime.ModelEvents.ExceptionEvent.t()
  | Codex.Realtime.ModelEvents.RawServerEvent.t()

Functions

audio(opts)

@spec audio(keyword()) :: Codex.Realtime.ModelEvents.AudioEvent.t()

Create an audio event.

audio_done(opts)

@spec audio_done(keyword()) :: Codex.Realtime.ModelEvents.AudioDoneEvent.t()

Create an audio done event.

audio_interrupted(opts)

@spec audio_interrupted(keyword()) ::
  Codex.Realtime.ModelEvents.AudioInterruptedEvent.t()

Create an audio interrupted event.

connection_status(status)

@spec connection_status(connection_status()) ::
  Codex.Realtime.ModelEvents.ConnectionStatusEvent.t()

Create a connection status event.

error(error)

@spec error(term()) :: Codex.Realtime.ModelEvents.ErrorEvent.t()

Create an error event.

exception(exception, context \\ nil)

@spec exception(Exception.t(), String.t() | nil) ::
  Codex.Realtime.ModelEvents.ExceptionEvent.t()

Create an exception event.

from_json(json)

@spec from_json(map()) :: {:ok, t()} | {:error, term()}

Parse model event from JSON.

input_audio_transcription_completed(opts)

@spec input_audio_transcription_completed(keyword()) ::
  Codex.Realtime.ModelEvents.InputAudioTranscriptionCompletedEvent.t()

Create an input audio transcription completed event.

item_deleted(item_id)

@spec item_deleted(String.t()) :: Codex.Realtime.ModelEvents.ItemDeletedEvent.t()

Create an item deleted event.

item_updated(item)

@spec item_updated(Codex.Realtime.Items.item()) ::
  Codex.Realtime.ModelEvents.ItemUpdatedEvent.t()

Create an item updated event.

other(data)

@spec other(term()) :: Codex.Realtime.ModelEvents.OtherEvent.t()

Create an other event.

raw_server_event(data)

@spec raw_server_event(term()) :: Codex.Realtime.ModelEvents.RawServerEvent.t()

Create a raw server event.

tool_call(opts)

@spec tool_call(keyword()) :: Codex.Realtime.ModelEvents.ToolCallEvent.t()

Create a tool call event.

transcript_delta(opts)

@spec transcript_delta(keyword()) ::
  Codex.Realtime.ModelEvents.TranscriptDeltaEvent.t()

Create a transcript delta event.

turn_ended()

@spec turn_ended() :: Codex.Realtime.ModelEvents.TurnEndedEvent.t()

Create a turn ended event.

turn_started()

@spec turn_started() :: Codex.Realtime.ModelEvents.TurnStartedEvent.t()

Create a turn started event.