Class: OpenAI::Models::Responses::ResponseErrorEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_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, 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: , param: , sequence_number: , type: :error) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseErrorEvent for more details.

Emitted when an error occurs.

Parameters:

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

    The error code.

  • message (String) (defaults to: ) —

    The error message.

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

    The error parameter.

  • sequence_number (Integer) (defaults to: ) —

    The sequence number of this event.

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

    The type of the event. Always ‘error`.




# File 'lib/openai/models/responses/response_error_event.rb', line 37

Instance Attribute Details

#code ⇒ String?

The error code.

Returns:

  • (String, nil) 


11
 
# File 'lib/openai/models/responses/response_error_event.rb', line 11

required :code, String, nil?: true

#message ⇒ String

The error message.

Returns:

  • (String) 


17
 
# File 'lib/openai/models/responses/response_error_event.rb', line 17

required :message, String

#param ⇒ String?

The error parameter.

Returns:

  • (String, nil) 


23
 
# File 'lib/openai/models/responses/response_error_event.rb', line 23

required :param, String, nil?: true

#sequence_number ⇒ Integer

The sequence number of this event.

Returns:

  • (Integer) 


29
 
# File 'lib/openai/models/responses/response_error_event.rb', line 29

required :sequence_number, Integer

#type ⇒ Symbol, :error

The type of the event. Always ‘error`.

Returns:

  • (Symbol, :error) 


35
 
# File 'lib/openai/models/responses/response_error_event.rb', line 35

required :type, const: :error