Class: OpenAI::Models::Responses::ResponseError

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::ResponseError

Defined in:

lib/openai/models/responses/response_error.rb

Defined Under Namespace

Modules: Code

Instance Attribute Summary

• #code ⇒ Symbol, OpenAI::Models::Responses::ResponseError::Code

  The error code for the response.

• #message ⇒ String

  A human-readable description of the error.

Instance Method Summary

• #initialize(code: , message: ) ⇒ Object constructor

  Some parameter documentations has been truncated, see ResponseError for more details.

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: ) ⇒ Object

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

An error object returned when the model fails to generate a Response.

Parameters:

• code (Symbol, OpenAI::Models::Responses::ResponseError::Code) (defaults to: ) —

  The error code for the response.

• message (String) (defaults to: ) —

  A human-readable description of the error.

# File 'lib/openai/models/responses/response_error.rb', line 19

Instance Attribute Details

#code ⇒ Symbol, OpenAI::Models::Responses::ResponseError::Code

The error code for the response.

Returns:

• (Symbol, OpenAI::Models::Responses::ResponseError::Code)

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

required :code, enum: -> { OpenAI::Responses::ResponseError::Code }

#message ⇒ String

A human-readable description of the error.

Returns:

• (String)

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

required :message, String