Class: OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall::Action

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

Overview

See Also:

  • OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall#action

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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

Parameters:

  • command —

    The command to run.

  • env —

    Environment variables to set for the command.

  • timeout_ms —

    Optional timeout in milliseconds for the command.

  • user —

    Optional user to run the command as.

  • working_directory —

    Optional working directory to run the command in.

  • type —

    The type of the local shell action. Always exec.



483
 
# File 'sig/openai/models/responses/response_output_item.rbs', line 483

def initialize: (

Instance Attribute Details

#command ⇒ ::Array[String]

The command to run.

Returns:

  • (::Array[String]) 


550
 
# File 'lib/openai/models/responses/response_output_item.rb', line 550

required :command, OpenAI::Internal::Type::ArrayOf[String]

#env ⇒ ::Hash[Symbol, String]

Environment variables to set for the command.

Returns:

  • (::Hash[Symbol, String]) 


556
 
# File 'lib/openai/models/responses/response_output_item.rb', line 556

required :env, OpenAI::Internal::Type::HashOf[String]

#timeout_ms ⇒ Integer?

Optional timeout in milliseconds for the command.

Returns:

  • (Integer, nil) 


568
 
# File 'lib/openai/models/responses/response_output_item.rb', line 568

optional :timeout_ms, Integer, nil?: true

#type ⇒ :exec

The type of the local shell action. Always exec.

Returns:

  • (:exec) 


562
 
# File 'lib/openai/models/responses/response_output_item.rb', line 562

required :type, const: :exec

#user ⇒ String?

Optional user to run the command as.

Returns:

  • (String, nil) 


574
 
# File 'lib/openai/models/responses/response_output_item.rb', line 574

optional :user, String, nil?: true

#working_directory ⇒ String?

Optional working directory to run the command in.

Returns:

  • (String, nil) 


580
 
# File 'lib/openai/models/responses/response_output_item.rb', line 580

optional :working_directory, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


492
 
# File 'sig/openai/models/responses/response_output_item.rbs', line 492

def to_hash: -> {