Enum OpenAIError 

pub enum OpenAIError {
    Http(Error),
    Body(BodyError),
    Stream(ParseError),
    Json(Error),
    Decode(DecodeError),
    Api(String),
    RateLimit {
        message: String,
        retry_after: Option<Duration>,
    },
    ServerError {
        status: u16,
        message: String,
    },
    Timeout,
}

Errors that can arise when calling the OpenAI API.

Variants

Http(Error)

HTTP layer errors.

Body(BodyError)

Response body parsing failures.

Stream(ParseError)

SSE parsing failures.

Json(Error)

JSON serialization/deserialization errors.

Decode(DecodeError)

Base64 decoding failures (e.g., image payloads).

Api(String)

API contract violations or unsupported operations.

RateLimit

Rate limit exceeded (HTTP 429).

Fields

message: String

Message from the API.

retry_after: Option<Duration>

Suggested retry delay from Retry-After header.

ServerError

Server error (HTTP 5xx).

Fields

status: u16

HTTP status code.

message: String

Error message.

Timeout

Request timed out.

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, f: &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<DecodeError> for OpenAIError

fn from(value: DecodeError) -> Self

Converts to this type from the input type.

impl From<Error> for OpenAIError

fn from(value: BodyError) -> Self

Converts to this type from the input type.

impl From<Error> for OpenAIError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for OpenAIError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for OpenAIError

fn from(value: SseParseError) -> Self

Converts to this type from the input type.