Class: OpenAI::Models::BatchError

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/batch_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, 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: nil, line: nil, message: nil, param: nil) ⇒ Object

Parameters:

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

    An error code identifying the error type.

  • line (Integer, nil) (defaults to: nil) —

    The line number of the input file where the error occurred, if applicable.

  • message (String) (defaults to: nil) —

    A human-readable message providing more details about the error.

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

    The name of the parameter that caused the error, if applicable.




# File 'lib/openai/models/batch_error.rb', line 30

Instance Attribute Details

#code ⇒ String?

An error code identifying the error type.

Returns:

  • (String, nil) 


10
 
# File 'lib/openai/models/batch_error.rb', line 10

optional :code, String

#line ⇒ Integer?

The line number of the input file where the error occurred, if applicable.

Returns:

  • (Integer, nil) 


16
 
# File 'lib/openai/models/batch_error.rb', line 16

optional :line, Integer, nil?: true

#message ⇒ String?

A human-readable message providing more details about the error.

Returns:

  • (String, nil) 


22
 
# File 'lib/openai/models/batch_error.rb', line 22

optional :message, String

#param ⇒ String?

The name of the parameter that caused the error, if applicable.

Returns:

  • (String, nil) 


28
 
# File 'lib/openai/models/batch_error.rb', line 28

optional :param, String, nil?: true