Exception: OpenAI::Errors::APIConnectionError

Inherits:
APIError
  • Object
show all
Defined in:
lib/openai/errors.rb,
sig/openai/errors.rbs

Direct Known Subclasses

APITimeoutError

Instance Attribute Summary collapse

Attributes inherited from APIError

#headers, #url

Attributes inherited from Error

#cause

Instance Method Summary collapse

Methods inherited from APIError

#request_id

Constructor Details

#initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: "Connection error.", request_may_have_been_sent: true) ⇒ APIConnectionError

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of APIConnectionError.

Parameters:

  • url (URI::Generic)
  • status (nil) (defaults to: nil)
  • headers (Hash{String=>String}, nil) (defaults to: nil)
  • body (nil) (defaults to: nil)
  • request (nil) (defaults to: nil)
  • response (nil) (defaults to: nil)
  • message (String, nil) (defaults to: "Connection error.")
  • request_may_have_been_sent (Boolean) (defaults to: true) 


163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/openai/errors.rb', line 163

def initialize(
  url:,
  status: nil,
  headers: nil,
  body: nil,
  request: nil,
  response: nil,
  message: "Connection error.",
  request_may_have_been_sent: true
)
  @request_may_have_been_sent = request_may_have_been_sent
  super(url:, status:, headers:, body:, request:, response:, message:)
end

Instance Attribute Details

#body ⇒ nil

Returns:

  • (nil) 



# File 'lib/openai/errors.rb', line 128

#code ⇒ nil

Returns:

  • (nil) 



# File 'lib/openai/errors.rb', line 132

#param ⇒ nil

Returns:

  • (nil) 



# File 'lib/openai/errors.rb', line 136

#status ⇒ nil

Returns:

  • (nil) 



# File 'lib/openai/errors.rb', line 124

#type ⇒ nil

Returns:

  • (nil) 



# File 'lib/openai/errors.rb', line 140

Instance Method Details

#request_may_have_been_sent? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



151
 
# File 'lib/openai/errors.rb', line 151

def request_may_have_been_sent? = @request_may_have_been_sent