Class: CodexSDK::ThreadOptions

Inherits:
Data
  • Object
show all
Defined in:
lib/codex_sdk/options.rb

Overview

Per-thread options controlling model, sandbox, and behavior.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model: nil, sandbox_mode: nil, working_directory: nil, approval_policy: nil, dangerously_bypass_approvals_and_sandbox: false, reasoning_effort: nil, network_access: nil, web_search: nil, additional_directories: [], skip_git_repo_check: false) ⇒ ThreadOptions

Returns a new instance of ThreadOptions.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/codex_sdk/options.rb', line 36

def initialize(
  model: nil,
  sandbox_mode: nil,
  working_directory: nil,
  approval_policy: nil,
  dangerously_bypass_approvals_and_sandbox: false,
  reasoning_effort: nil,
  network_access: nil,
  web_search: nil,
  additional_directories: [],
  skip_git_repo_check: false
)
  super
end

Instance Attribute Details

#additional_directories ⇒ Object (readonly)

Returns the value of attribute additional_directories

Returns:

  • (Object) —

    the current value of additional_directories



24
25
26
 
# File 'lib/codex_sdk/options.rb', line 24

def additional_directories
  @additional_directories
end

#approval_policy ⇒ Object (readonly)

Returns the value of attribute approval_policy

Returns:

  • (Object) —

    the current value of approval_policy



24
25
26
 
# File 'lib/codex_sdk/options.rb', line 24

def approval_policy
  @approval_policy
end

#dangerously_bypass_approvals_and_sandbox ⇒ Object (readonly)

Returns the value of attribute dangerously_bypass_approvals_and_sandbox

Returns:

  • (Object) —

    the current value of dangerously_bypass_approvals_and_sandbox



24
25
26
 
# File 'lib/codex_sdk/options.rb', line 24

def dangerously_bypass_approvals_and_sandbox
  @dangerously_bypass_approvals_and_sandbox
end

#model ⇒ Object (readonly)

Returns the value of attribute model

Returns:

  • (Object) —

    the current value of model



24
25
26
 
# File 'lib/codex_sdk/options.rb', line 24

def model
  @model
end

#network_access ⇒ Object (readonly)

Returns the value of attribute network_access

Returns:

  • (Object) —

    the current value of network_access



24
25
26
 
# File 'lib/codex_sdk/options.rb', line 24

def network_access
  @network_access
end

#reasoning_effort ⇒ Object (readonly)

Returns the value of attribute reasoning_effort

Returns:

  • (Object) —

    the current value of reasoning_effort



24
25
26
 
# File 'lib/codex_sdk/options.rb', line 24

def reasoning_effort
  @reasoning_effort
end

#sandbox_mode ⇒ Object (readonly)

Returns the value of attribute sandbox_mode

Returns:

  • (Object) —

    the current value of sandbox_mode



24
25
26
 
# File 'lib/codex_sdk/options.rb', line 24

def sandbox_mode
  @sandbox_mode
end

#skip_git_repo_check ⇒ Object (readonly)

Returns the value of attribute skip_git_repo_check

Returns:

  • (Object) —

    the current value of skip_git_repo_check



24
25
26
 
# File 'lib/codex_sdk/options.rb', line 24

def skip_git_repo_check
  @skip_git_repo_check
end

#web_search ⇒ Object (readonly)

Returns the value of attribute web_search

Returns:

  • (Object) —

    the current value of web_search



24
25
26
 
# File 'lib/codex_sdk/options.rb', line 24

def web_search
  @web_search
end

#working_directory ⇒ Object (readonly)

Returns the value of attribute working_directory

Returns:

  • (Object) —

    the current value of working_directory



24
25
26
 
# File 'lib/codex_sdk/options.rb', line 24

def working_directory
  @working_directory
end