Class: OpenAI::Models::Beta::AgentSession

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

Defined Under Namespace

Modules: RequiredAction, Status Classes: 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(environment_id:, type: :environment_connection) ⇒ Object

Reconnect a session environment.

Parameters:

  • environment_id (String) —

    The ID of the environment to reconnect.

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

    The type of the object. Always environment_connection.




# File 'lib/openai/models/beta/agent_session.rb', line 82

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::AgentSession::Agent

The agent running in the session.

Parameters:

  • value (OpenAI::Beta::AgentSession::Agent)

Returns:



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

required :agent, -> { OpenAI::Beta::AgentSession::Agent }

#created_at ⇒ Integer

The Unix timestamp, in seconds, when the session was created.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :created_at, Integer

#environment ⇒ OpenAI::Models::Beta::Environment::None, ...

The execution environment for the session.

Parameters:

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

Returns:



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

required :environment, union: -> { OpenAI::Beta::Environment }

#error ⇒ String?

The error that caused the session to fail, if any.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :error, String, nil?: true

#id ⇒ String

The ID of the session.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#last_active_at ⇒ Integer

The Unix timestamp, in seconds, when the session was last active.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :last_active_at, Integer

#metadata ⇒ Hash{Symbol=>String}

Custom string key-value pairs attached to the session.

Parameters:

  • value (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}) 


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

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

#object ⇒ Symbol, :"agent.session"

The object type. Always agent.session.

Parameters:

  • value (:"agent.session")

Returns:

  • (Symbol, :"agent.session") 


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

required :object, const: :"agent.session"

#required_actions ⇒ Array<OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection>

Actions that must be completed before the session can continue.

Parameters:

  • value (::Array[OpenAI::Models::Beta::AgentSession::required_action])

Returns:



59
60
61
62
 
# File 'lib/openai/models/beta/agent_session.rb', line 59

required(
  :required_actions,
  -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AgentSession::RequiredAction] }
)

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

The current status of the session.

Parameters:

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

Returns:



68
 
# File 'lib/openai/models/beta/agent_session.rb', line 68

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

#usage ⇒ OpenAI::Models::Beta::TokenUsage?

Recorded token usage for a session or turn. Usage is best effort and may change.

Parameters:

  • value (OpenAI::Beta::TokenUsage, nil)

Returns:



74
 
# File 'lib/openai/models/beta/agent_session.rb', line 74

required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true

#vault_ids ⇒ Array<String>

The IDs of vaults made available to the session.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


80
 
# File 'lib/openai/models/beta/agent_session.rb', line 80

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/agent_session.rb', line 221

.variants ⇒ Array(OpenAI::Models::Beta::AgentSession::RequiredAction::FunctionCall, OpenAI::Models::Beta::AgentSession::RequiredAction::EnvironmentConnection)

Returns:




# File 'lib/openai/models/beta/agent_session.rb', line 311

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


60
 
# File 'sig/openai/models/beta/agent_session.rbs', line 60

def to_hash: -> {