Enum OpenAIError 

pub enum OpenAIError {
    Reqwest(Error),
    ApiError(ApiError),
    JSONDeserialize(Error, String),
    FileSaveError(String),
    FileReadError(String),
    StreamError(Box<StreamError>),
    Boxed(Box<dyn Error + Send + Sync + 'static>),
    InvalidArgument(String),
}

Available on crate feature _api and non-target_family=wasm only.

Variants

Reqwest(Error)

Underlying error from reqwest library after an API call was made

ApiError(ApiError)

OpenAI returns error object with details of API call failure

JSONDeserialize(Error, String)

Error when a response cannot be deserialized into a Rust type

FileSaveError(String)

Error on the client side when saving file to file system

FileReadError(String)

Error on the client side when reading file from file system

StreamError(Box<StreamError>)

Error on SSE streaming

Boxed(Box<dyn Error + Send + Sync + 'static>)

Available on crate feature middleware only.

Error from middlewares

InvalidArgument(String)

Error from client side validation or when builder fails to build request before making API call

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<Box<dyn Error + Sync + Send>> for OpenAIError

Available on crate feature middleware only.

fn from(error: BoxError) -> 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<UninitializedFieldError> for OpenAIError

Available on crate features response-types or audio-types or file-types or image-types or chat-completion-types or completion-types or embedding-types or moderation-types or administration-types only.

fn from(value: UninitializedFieldError) -> Self

Converts to this type from the input type.

impl Policy<HttpRequestFactory, Response, OpenAIError> for SimpleRetryPolicy

type Future = Pin<Box<dyn Future<Output = ()> + Send>>

The Future type returned by Policy::retry.

fn retry( &mut self, _req: &mut HttpRequestFactory, result: &mut Result<Response, OpenAIError>, ) -> Option<Self::Future>

Check the policy if a certain request should be retried.

fn clone_request( &mut self, req: &HttpRequestFactory, ) -> Option<HttpRequestFactory>

Tries to clone a request before being passed to the inner service.