Class: OpenAI::Models::Beta::BetaResponseInputItem::ShellCall

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_response_input_item.rb

Defined Under Namespace

Modules: Caller, Environment, Status Classes: Action, Agent

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

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(caller_id:, type: :program) ⇒ Object

Parameters:

  • caller_id (String) —

    The call ID of the program item that produced this tool call.

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

    The caller type. Always program.




# File 'lib/openai/models/beta/beta_response_input_item.rb', line 1821

Instance Attribute Details

#action ⇒ OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Action

The shell commands and limits that describe how to run the tool call.

Returns:



1766
 
# File 'lib/openai/models/beta/beta_response_input_item.rb', line 1766

required :action, -> { OpenAI::Beta::BetaResponseInputItem::ShellCall::Action }

#agent ⇒ OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Agent?

The agent that produced this item.

Returns:



1791
 
# File 'lib/openai/models/beta/beta_response_input_item.rb', line 1791

optional :agent, -> { OpenAI::Beta::BetaResponseInputItem::ShellCall::Agent }, nil?: true

#call_id ⇒ String

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

Returns:

  • (String) 


1772
 
# File 'lib/openai/models/beta/beta_response_input_item.rb', line 1772

required :call_id, String

#caller_ ⇒ OpenAI::Models::Beta::BetaResponseInputItem::ShellCall::Caller::Direct, ...

The execution context that produced this tool call.

Returns:



1797
1798
1799
1800
1801
1802
 
# File 'lib/openai/models/beta/beta_response_input_item.rb', line 1797

optional(
  :caller_,
  union: -> { OpenAI::Beta::BetaResponseInputItem::ShellCall::Caller },
  api_name: :caller,
  nil?: true
)

#environment ⇒ OpenAI::Models::Beta::BetaLocalEnvironment, ...

The environment to execute the shell commands in.

Returns:



1808
1809
1810
1811
1812
 
# File 'lib/openai/models/beta/beta_response_input_item.rb', line 1808

optional(
  :environment,
  union: -> { OpenAI::Beta::BetaResponseInputItem::ShellCall::Environment },
  nil?: true
)

#id ⇒ String?

The unique ID of the shell tool call. Populated when this item is returned via API.

Returns:

  • (String, nil) 


1785
 
# File 'lib/openai/models/beta/beta_response_input_item.rb', line 1785

optional :id, String, nil?: true

#status ⇒ Symbol, ...

The status of the shell call. One of in_progress, completed, or incomplete.

Returns:



1819
 
# File 'lib/openai/models/beta/beta_response_input_item.rb', line 1819

optional :status, enum: -> { OpenAI::Beta::BetaResponseInputItem::ShellCall::Status }, nil?: true

#type ⇒ Symbol, :shell_call

The type of the item. Always shell_call.

Returns:

  • (Symbol, :shell_call) 


1778
 
# File 'lib/openai/models/beta/beta_response_input_item.rb', line 1778

required :type, const: :shell_call

Class Method Details

.variants ⇒ Array(OpenAI::Models::Beta::BetaLocalEnvironment, OpenAI::Models::Beta::BetaContainerReference)

Returns:




# File 'lib/openai/models/beta/beta_response_input_item.rb', line 1945