Class: OpenAI::Models::Responses::FunctionShellTool

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/function_shell_tool.rb,
sig/openai/models/responses/function_shell_tool.rbs

Defined Under Namespace

Modules: AllowedCaller, Environment

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize ⇒ Object 



18
 
# File 'sig/openai/models/responses/function_shell_tool.rbs', line 18

def initialize: (

Instance Attribute Details

#allowed_callers ⇒ Array<Symbol, OpenAI::Models::Responses::FunctionShellTool::AllowedCaller>?

The tool invocation context(s).

Parameters:

  • value (::Array[OpenAI::Models::Responses::FunctionShellTool::allowed_caller], nil)

Returns:



17
18
19
20
21
 
# File 'lib/openai/models/responses/function_shell_tool.rb', line 17

optional :allowed_callers,
-> {
  OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Responses::FunctionShellTool::AllowedCaller]
},
nil?: true

#environment ⇒ OpenAI::Models::Responses::ContainerAuto, ...

Parameters:

  • value (OpenAI::Models::Responses::FunctionShellTool::environment, nil)

Returns:



26
 
# File 'lib/openai/models/responses/function_shell_tool.rb', line 26

optional :environment, union: -> { OpenAI::Responses::FunctionShellTool::Environment }, nil?: true

#type ⇒ Symbol, :shell

The type of the shell tool. Always shell.

Parameters:

  • value (:shell)

Returns:

  • (Symbol, :shell) 


11
 
# File 'lib/openai/models/responses/function_shell_tool.rb', line 11

required :type, const: :shell

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/responses/function_shell_tool.rb', line 43

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


24
 
# File 'sig/openai/models/responses/function_shell_tool.rbs', line 24

def to_hash: -> {