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

Copy Markdown View Source

High-level session events for realtime applications.

These events are emitted by the session and provide a clean interface for application code to react to session state changes.

Summary

Types

t()

Functions

agent_end(agent, context)

Create an agent end event.

agent_start(agent, context)

Create an agent start event.

audio(model_audio, item_id, content_index, context)

Create an audio event.

audio_end(item_id, content_index, context)

Create an audio end event.

audio_interrupted(item_id, content_index, context)

Create an audio interrupted event.

error(error, context)

Create an error event.

guardrail_tripped(results, message, context)

Create a guardrail tripped event.

handoff(from_agent, to_agent, context)

Create a handoff event.

history_added(item, context)

Create a history added event.

history_updated(history, context)

Create a history updated event.

input_audio_timeout_triggered(context)

Create an input audio timeout triggered event.

raw_model_event(data, context)

Create a raw model event.

tool_end(agent, tool, arguments, output, context)

Create a tool end event.

tool_start(agent, tool, arguments, context)

Create a tool start event.

Types

t()

@type t() ::
  Codex.Realtime.Events.AgentStartEvent.t()
  | Codex.Realtime.Events.AgentEndEvent.t()
  | Codex.Realtime.Events.HandoffEvent.t()
  | Codex.Realtime.Events.ToolStartEvent.t()
  | Codex.Realtime.Events.ToolEndEvent.t()
  | Codex.Realtime.Events.RawModelEvent.t()
  | Codex.Realtime.Events.AudioEndEvent.t()
  | Codex.Realtime.Events.AudioEvent.t()
  | Codex.Realtime.Events.AudioInterruptedEvent.t()
  | Codex.Realtime.Events.ErrorEvent.t()
  | Codex.Realtime.Events.HistoryUpdatedEvent.t()
  | Codex.Realtime.Events.HistoryAddedEvent.t()
  | Codex.Realtime.Events.GuardrailTrippedEvent.t()
  | Codex.Realtime.Events.InputAudioTimeoutTriggeredEvent.t()

Functions

agent_end(agent, context)

@spec agent_end(term(), map()) :: Codex.Realtime.Events.AgentEndEvent.t()

Create an agent end event.

agent_start(agent, context)

@spec agent_start(term(), map()) :: Codex.Realtime.Events.AgentStartEvent.t()

Create an agent start event.

audio(model_audio, item_id, content_index, context)

@spec audio(
  Codex.Realtime.ModelEvents.AudioEvent.t() | map(),
  String.t(),
  non_neg_integer(),
  map()
) ::
  Codex.Realtime.Events.AudioEvent.t()

Create an audio event.

audio_end(item_id, content_index, context)

@spec audio_end(String.t(), non_neg_integer(), map()) ::
  Codex.Realtime.Events.AudioEndEvent.t()

Create an audio end event.

audio_interrupted(item_id, content_index, context)

@spec audio_interrupted(String.t(), non_neg_integer(), map()) ::
  Codex.Realtime.Events.AudioInterruptedEvent.t()

Create an audio interrupted event.

error(error, context)

@spec error(term(), map()) :: Codex.Realtime.Events.ErrorEvent.t()

Create an error event.

guardrail_tripped(results, message, context)

@spec guardrail_tripped(list(), String.t(), map()) ::
  Codex.Realtime.Events.GuardrailTrippedEvent.t()

Create a guardrail tripped event.

handoff(from_agent, to_agent, context)

@spec handoff(term(), term(), map()) :: Codex.Realtime.Events.HandoffEvent.t()

Create a handoff event.

history_added(item, context)

@spec history_added(Codex.Realtime.Items.item(), map()) ::
  Codex.Realtime.Events.HistoryAddedEvent.t()

Create a history added event.

history_updated(history, context)

@spec history_updated([Codex.Realtime.Items.item()], map()) ::
  Codex.Realtime.Events.HistoryUpdatedEvent.t()

Create a history updated event.

input_audio_timeout_triggered(context)

@spec input_audio_timeout_triggered(map()) ::
  Codex.Realtime.Events.InputAudioTimeoutTriggeredEvent.t()

Create an input audio timeout triggered event.

raw_model_event(data, context)

@spec raw_model_event(Codex.Realtime.ModelEvents.t(), map()) ::
  Codex.Realtime.Events.RawModelEvent.t()

Create a raw model event.

tool_end(agent, tool, arguments, output, context)

@spec tool_end(term(), term(), String.t(), term(), map()) ::
  Codex.Realtime.Events.ToolEndEvent.t()

Create a tool end event.

tool_start(agent, tool, arguments, context)

@spec tool_start(term(), term(), String.t(), map()) ::
  Codex.Realtime.Events.ToolStartEvent.t()

Create a tool start event.