Class: OpenAI::Models::Beta::AgentCommandExecutionItem

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

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(id:, command:, cwd:, duration_ms:, exit_code:, output:, status:, turn_id:, type: :command_execution) ⇒ Object

A command execution produced by the agent.

Parameters:

  • id (String) —

    The ID of the command execution item.

  • command (String) —

    The command that was executed.

  • cwd (String, nil) —

    The working directory used to execute the command.

  • duration_ms (Integer, nil) —

    The command duration in milliseconds.

  • exit_code (Integer, nil) —

    The process exit code, if the command completed.

  • output (String, nil) —

    The command output, if available.

  • status (Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus) —

    The status of the command execution.

  • turn_id (String) —

    The ID of the turn that contains this item.

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

    The item type. Always command_execution.




# File 'lib/openai/models/beta/agent_command_execution_item.rb', line 61

Instance Attribute Details

#command ⇒ String

The command that was executed.

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/openai/models/beta/agent_command_execution_item.rb', line 17

required :command, String

#cwd ⇒ String?

The working directory used to execute the command.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


23
 
# File 'lib/openai/models/beta/agent_command_execution_item.rb', line 23

required :cwd, String, nil?: true

#duration_ms ⇒ Integer?

The command duration in milliseconds.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


29
 
# File 'lib/openai/models/beta/agent_command_execution_item.rb', line 29

required :duration_ms, Integer, nil?: true

#exit_code ⇒ Integer?

The process exit code, if the command completed.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


35
 
# File 'lib/openai/models/beta/agent_command_execution_item.rb', line 35

required :exit_code, Integer, nil?: true

#id ⇒ String

The ID of the command execution item.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/openai/models/beta/agent_command_execution_item.rb', line 11

required :id, String

#output ⇒ String?

The command output, if available.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


41
 
# File 'lib/openai/models/beta/agent_command_execution_item.rb', line 41

required :output, String, nil?: true

#status ⇒ Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus

The status of the command execution.

Parameters:

  • value (OpenAI::Models::Beta::agent_function_call_status)

Returns:



47
 
# File 'lib/openai/models/beta/agent_command_execution_item.rb', line 47

required :status, enum: -> { OpenAI::Beta::AgentFunctionCallStatus }

#turn_id ⇒ String

The ID of the turn that contains this item.

Parameters:

  • value (String)

Returns:

  • (String) 


53
 
# File 'lib/openai/models/beta/agent_command_execution_item.rb', line 53

required :turn_id, String

#type ⇒ Symbol, :command_execution

The item type. Always command_execution.

Parameters:

  • value (:command_execution)

Returns:

  • (Symbol, :command_execution) 


59
 
# File 'lib/openai/models/beta/agent_command_execution_item.rb', line 59

required :type, const: :command_execution

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


48
 
# File 'sig/openai/models/beta/agent_command_execution_item.rbs', line 48

def to_hash: -> {