Class: OpenAI::Models::Realtime::RealtimeError

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/realtime_error.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(message:, type:, code: nil, event_id: nil, param: nil) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Realtime::RealtimeError for more details.

Details of the error.

Parameters:

  • message (String) —

    A human-readable error message.

  • type (String) —

    The type of error (e.g., “invalid_request_error”, “server_error”).

  • code (String, nil) (defaults to: nil) —

    Error code, if any.

  • event_id (String, nil) (defaults to: nil) —

    The event_id of the client event that caused the error, if applicable.

  • param (String, nil) (defaults to: nil) —

    Parameter related to the error, if any.




# File 'lib/openai/models/realtime/realtime_error.rb', line 37

Instance Attribute Details

#code ⇒ String?

Error code, if any.

Returns:

  • (String, nil) 


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

optional :code, String, nil?: true

#event_id ⇒ String?

The event_id of the client event that caused the error, if applicable.

Returns:

  • (String, nil) 


29
 
# File 'lib/openai/models/realtime/realtime_error.rb', line 29

optional :event_id, String, nil?: true

#message ⇒ String

A human-readable error message.

Returns:

  • (String) 


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

required :message, String

#param ⇒ String?

Parameter related to the error, if any.

Returns:

  • (String, nil) 


35
 
# File 'lib/openai/models/realtime/realtime_error.rb', line 35

optional :param, String, nil?: true

#type ⇒ String

The type of error (e.g., “invalid_request_error”, “server_error”).

Returns:

  • (String) 


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

required :type, String