Class: OpenAI::Models::Beta::AgentSessionEnvironmentState

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

Defined Under Namespace

Modules: Status Classes: Error

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(code:, message:, type:) ⇒ Object

An error reported while preparing a session environment.

Parameters:

  • code (String) —

    A machine-readable error code.

  • message (String) —

    A human-readable error message.

  • type (String) —

    The error type.




# File 'lib/openai/models/beta/agent_session_environment_state.rb', line 31

Instance Attribute Details

#error ⇒ OpenAI::Models::Beta::AgentSessionEnvironmentState::Error?

An error reported while preparing a session environment.

Parameters:

  • value (OpenAI::Beta::AgentSessionEnvironmentState::Error, nil)

Returns:



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

required :error, -> { OpenAI::Beta::AgentSessionEnvironmentState::Error }, nil?: true

#id ⇒ String

The public ID of the environment.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#status ⇒ Symbol, OpenAI::Models::Beta::AgentSessionEnvironmentState::Status

The environment's connection status.

Parameters:

  • value (OpenAI::Models::Beta::AgentSessionEnvironmentState::status)

Returns:



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

required :status, enum: -> { OpenAI::Beta::AgentSessionEnvironmentState::Status }

#type ⇒ String

The environment type.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :type, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


28
 
# File 'sig/openai/models/beta/agent_session_environment_state.rbs', line 28

def to_hash: -> {