Class: OpenAI::Models::Beta::AgentSessionErrorEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/agent_session_error_event.rb,
sig/openai/models/beta/agent_session_error_event.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(error:, event_id:, session_id:, type: :error) ⇒ Object

Emitted when a turn or session fails.

Parameters:

  • error (OpenAI::Models::Beta::SessionError) —

    The error that occurred.

  • event_id (String) —

    The unique ID of the event.

  • session_id (String) —

    The ID of the session associated with the event.

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

    The type of the object. Always error.




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

Instance Attribute Details

#error ⇒ OpenAI::Models::Beta::SessionError

The error that occurred.

Parameters:

  • value (OpenAI::Beta::SessionError)

Returns:



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

required :error, -> { OpenAI::Beta::SessionError }

#event_id ⇒ String

The unique ID of the event.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :event_id, String

#session_id ⇒ String

The ID of the session associated with the event.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :session_id, String

#type ⇒ Symbol, :error

The type of the object. Always error.

Parameters:

  • value (:error)

Returns:

  • (Symbol, :error) 


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

required :type, const: :error

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {