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

Configuration types for realtime sessions.

This module defines all configuration structures for customizing realtime session behavior, including model settings, turn detection, transcription, and tracing options.

Summary

Types

audio_format()

eagerness()

modality()

model_name()

turn_detection_type()

Functions

default_session_settings()

Create default session model settings.

merge_settings(base, override)

Merge two session model settings, with the override taking precedence.

Types

audio_format()

@type audio_format() :: :pcm16 | :g711_ulaw | :g711_alaw | String.t()

eagerness()

@type eagerness() :: :auto | :low | :medium | :high

modality()

@type modality() :: :text | :audio

model_name()

@type model_name() ::
  :gpt_realtime
  | :gpt_4o_realtime_preview
  | :gpt_4o_mini_realtime_preview
  | String.t()

turn_detection_type()

@type turn_detection_type() :: :semantic_vad | :server_vad

Functions

default_session_settings()

@spec default_session_settings() :: Codex.Realtime.Config.SessionModelSettings.t()

Create default session model settings.

merge_settings(base, override)

@spec merge_settings(
  Codex.Realtime.Config.SessionModelSettings.t(),
  Codex.Realtime.Config.SessionModelSettings.t()
) :: Codex.Realtime.Config.SessionModelSettings.t()

Merge two session model settings, with the override taking precedence.

Only non-nil values from override are used.