Enum OpenAIError

pub enum OpenAIError {
    ConfigError(String),
    HTTPError(Error),
    DeserializeError(Error),
    APIError {
        message: String,
        err_type: Option<String>,
        code: Option<String>,
    },
    IOError(Error),
}

Represents any error that can occur while using the OpenAI Rust client library.

This enum covers:

1. Configuration errors, such as missing API keys or invalid builder settings.
2. Network/HTTP errors encountered while making requests.
3. Errors returned by the OpenAI API itself (e.g., rate limits, invalid parameters).
4. JSON parsing errors (e.g., unexpected response formats).
5. IO errors that might occur during operations like file handling.

Variants

ConfigError(String)

Errors related to invalid configuration or missing environment variables.

HTTPError(Error)

Errors returned by the underlying HTTP client (reqwest).

This typically indicates network-level issues, timeouts, TLS errors, etc.

DeserializeError(Error)

Errors that happen due to invalid or unexpected responses from the OpenAI API.

For instance, if the response body is not valid JSON or doesn’t match the expected schema.

APIError

Errors reported by the OpenAI API in its response body.

This might include invalid request parameters, rate-limit violations, or internal server errors. The attached string typically contains a more descriptive message returned by the API.

Fields

message: String

A short summary of what went wrong (as provided by the OpenAI API).

err_type: Option<String>

The type/category of error (e.g. ‘invalid_request_error’, ‘rate_limit_error’, etc.).

code: Option<String>

An optional error code that might be returned by the OpenAI API.

IOError(Error)

Errors that occur during I/O operations.

Implementations

impl OpenAIError

pub fn api_error( message: impl Into<String>, err_type: Option<&str>, code: Option<&str>, ) -> Self

Creates an OpenAIError::APIError from detailed information about the error.

Parameters

• message - A short description of the error.
• err_type - The error type from OpenAI (e.g., “invalid_request_error”).
• code - An optional error code from OpenAI.

Example

use chat_gpt_lib_rs::OpenAIError;

let api_err = OpenAIError::api_error("Invalid request", Some("invalid_request_error"), None);

Trait Implementations

impl Debug for OpenAIError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for OpenAIError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for OpenAIError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for OpenAIError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for OpenAIError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for OpenAIError

fn from(source: Error) -> Self

Converts to this type from the input type.