Codex.Protocol.CollaborationMode (Codex SDK v0.6.0)

Copy Markdown View Source

Collaboration mode configuration with presets.

Collaboration modes define different interaction styles with the model:

  • :plan - planning mode with high reasoning
  • :pair_programming - interactive coding with medium reasoning
  • :execute - execution mode with high reasoning
  • :custom - custom configuration

Summary

Types

t()

Collaboration mode with settings

Types

mode_kind()

@type mode_kind() :: :plan | :pair_programming | :execute | :custom

t()

@type t() :: %Codex.Protocol.CollaborationMode{
  developer_instructions: (String.t() | nil) | nil,
  mode: mode_kind(),
  model: String.t(),
  reasoning_effort: (Codex.Models.reasoning_effort() | nil) | nil
}

Collaboration mode with settings

Functions

from_map(data)

@spec from_map(map()) :: t()

to_map(cm)

@spec to_map(t()) :: map()