Class: OpenAI::Models::Realtime::RealtimeErrorEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/realtime_error_event.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, 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, #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:, type: :error) ⇒ Object

Returned when an error occurs, which could be a client problem or a server problem. Most errors are recoverable and the session will stay open, we recommend to implementors to monitor and log error messages by default.

Parameters:

  • error (OpenAI::Models::Realtime::RealtimeError) —

    Details of the error.

  • event_id (String) —

    The unique ID of the server event.

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

    The event type, must be ‘error`.




# File 'lib/openai/models/realtime/realtime_error_event.rb', line 25

Instance Attribute Details

#error ⇒ OpenAI::Models::Realtime::RealtimeError

Details of the error.

Returns:



11
 
# File 'lib/openai/models/realtime/realtime_error_event.rb', line 11

required :error, -> { OpenAI::Realtime::RealtimeError }

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


17
 
# File 'lib/openai/models/realtime/realtime_error_event.rb', line 17

required :event_id, String

#type ⇒ Symbol, :error

The event type, must be ‘error`.

Returns:

  • (Symbol, :error) 


23
 
# File 'lib/openai/models/realtime/realtime_error_event.rb', line 23

required :type, const: :error