OpenAIError Class
The OpenAIError class is designed to handle errors returned by the OpenAI API. It extracts relevant information from the error response and provides methods to access this information.
Properties
Error properties
| Property | Type | Description |
|---|---|---|
errCode | Integer | The error code returned by the API or the HTTP status. |
message | Text | The error message returned by the API or the HTTP status text. |
HTTP reponse properties
| Property | Type | Description |
|---|---|---|
response | Object | The full response object. |
status | Integer | The HTTP status code of the response. |
statusText | Text | The status text of the HTTP response. |
body | Object | The body of the error response. |
headers | Object | The headers of the error response. |
requestID | Text | The request ID from the error response headers. |
OpenAI specific
| Property | Type | Description |
|---|---|---|
code | Variant | The code of error returned by the API. |
type | Text | The type of error returned by the API. |
param | Text | The parameter that caused the error, if applicable. |
HTTP status code info
| Property | Type | Description |
|---|---|---|
isBadRequestError | Boolean | Indicates if the error is a 400 Bad Request error. |
isAuthenticationError | Boolean | Indicates if the error is a 401 Authentication error. |
isPermissionDeniedError | Boolean | Indicates ∏if the error is a 403 Permission Denied error. |
isNotFoundError | Boolean | Indicates if the error is a 404 Not Found error. |
isUnprocessableEntityError | Boolean | Indicates if the error is a 422 Unprocessable Entity error. |
isRateLimitError | Boolean | Indicates if the error is a 429 Rate Limit error. |
isInternalServerError | Boolean | Indicates if the error is a 500 or higher Internal Server error. |