Class: OpenAI::Models::Responses::ResponseItem::LocalShellCall

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_item.rb

Defined Under Namespace

Modules: Status Classes: Action

Instance Attribute 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, 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(command: , env: , timeout_ms: nil, user: nil, working_directory: nil, type: :exec) ⇒ Object

Some parameter documentations has been truncated, see Action for more details.

Execute a shell command on the server.

Parameters:

  • command (Array<String>) (defaults to: ) —

    The command to run.

  • env (Hash{Symbol=>String}) (defaults to: ) —

    Environment variables to set for the command.

  • timeout_ms (Integer, nil) (defaults to: nil) —

    Optional timeout in milliseconds for the command.

  • user (String, nil) (defaults to: nil) —

    Optional user to run the command as.

  • working_directory (String, nil) (defaults to: nil) —

    Optional working directory to run the command in.

  • type (Symbol, :exec) (defaults to: :exec) —

    The type of the local shell action. Always ‘exec`.




# File 'lib/openai/models/responses/response_item.rb', line 147

Instance Attribute Details

#action ⇒ OpenAI::Models::Responses::ResponseItem::LocalShellCall::Action

Execute a shell command on the server.

Returns:



127
 
# File 'lib/openai/models/responses/response_item.rb', line 127

required :action, -> { OpenAI::Responses::ResponseItem::LocalShellCall::Action }

#call_id ⇒ String

The unique ID of the local shell tool call generated by the model.

Returns:

  • (String) 


133
 
# File 'lib/openai/models/responses/response_item.rb', line 133

required :call_id, String

#id ⇒ String

The unique ID of the local shell call.

Returns:

  • (String) 


121
 
# File 'lib/openai/models/responses/response_item.rb', line 121

required :id, String

#status ⇒ Symbol, OpenAI::Models::Responses::ResponseItem::LocalShellCall::Status

The status of the local shell call.

Returns:



139
 
# File 'lib/openai/models/responses/response_item.rb', line 139

required :status, enum: -> { OpenAI::Responses::ResponseItem::LocalShellCall::Status }

#type ⇒ Symbol, :local_shell_call

The type of the local shell call. Always ‘local_shell_call`.

Returns:

  • (Symbol, :local_shell_call) 


145
 
# File 'lib/openai/models/responses/response_item.rb', line 145

required :type, const: :local_shell_call