Exception: OpenAI::Errors::APIError

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

Direct Known Subclasses

APIConnectionError, APIStatusError

Instance Attribute Summary collapse

Attributes inherited from Error

#cause

Instance Method Summary collapse

Constructor Details

#initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil) ⇒ APIError

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 APIError.

Parameters:

  • url (URI::Generic)
  • status (Integer, nil) (defaults to: nil)
  • headers (Hash{String=>String}, nil) (defaults to: nil)
  • body (Object, nil) (defaults to: nil)
  • request (nil) (defaults to: nil)
  • response (nil) (defaults to: nil)
  • message (String, nil) (defaults to: nil) 


112
113
114
115
116
117
118
119
120
 
# File 'lib/openai/errors.rb', line 112

def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
  @url = url
  @status = status
  @headers = headers
  @body = body
  @request = request
  @response = response
  super(message)
end

Instance Attribute Details

#body ⇒ Object?

Returns:

  • (Object, nil) 


85
86
87
 
# File 'lib/openai/errors.rb', line 85

def body
  @body
end

#code ⇒ String?

Returns:

  • (String, nil) 


88
89
90
 
# File 'lib/openai/errors.rb', line 88

def code
  @code
end

#headers ⇒ Hash{String=>String}?

Returns:

  • (Hash{String=>String}, nil) 


82
83
84
 
# File 'lib/openai/errors.rb', line 82

def headers
  @headers
end

#param ⇒ String?

Returns:

  • (String, nil) 


91
92
93
 
# File 'lib/openai/errors.rb', line 91

def param
  @param
end

#status ⇒ Integer?

Returns:

  • (Integer, nil) 


79
80
81
 
# File 'lib/openai/errors.rb', line 79

def status
  @status
end

#type ⇒ String?

Returns:

  • (String, nil) 


94
95
96
 
# File 'lib/openai/errors.rb', line 94

def type
  @type
end

#url ⇒ URI::Generic

Returns:

  • (URI::Generic) 


76
77
78
 
# File 'lib/openai/errors.rb', line 76

def url
  @url
end

Instance Method Details

#request_id ⇒ String?

The ID of the API request, returned via the x-request-id response header. This is nil when no HTTP response was received or the response did not include the header.

Returns:

  • (String, nil) 


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

def request_id = headers&.[]("x-request-id")