async-openai 0.34.0

//! Errors originating from API calls, parsing responses, and reading-or-writing to the file system.

use serde::{Deserialize, Serialize};

#[cfg(all(feature = "_api", not(target_family = "wasm")))]
#[derive(Debug, thiserror::Error)]
pub enum OpenAIError {
    /// Underlying error from reqwest library after an API call was made
    #[error("http error: {0}")]
    Reqwest(#[from] reqwest::Error),
    /// OpenAI returns error object with details of API call failure
    #[error("{0}")]
    ApiError(ApiError),
    /// Error when a response cannot be deserialized into a Rust type
    #[error("failed to deserialize api response: error:{0} content:{1}")]
    JSONDeserialize(serde_json::Error, String),
    /// Error on the client side when saving file to file system
    #[error("failed to save file: {0}")]
    FileSaveError(String),
    /// Error on the client side when reading file from file system
    #[error("failed to read file: {0}")]
    FileReadError(String),
    /// Error on SSE streaming
    #[error("stream failed: {0}")]
    StreamError(Box<StreamError>),
    /// Error from client side validation
    /// or when builder fails to build request before making API call
    #[error("invalid args: {0}")]
    InvalidArgument(String),
}

// no streaming support for wasm yet
#[cfg(all(feature = "_api", target_family = "wasm"))]
#[derive(Debug, thiserror::Error)]
pub enum OpenAIError {
    /// Underlying error from reqwest library after an API call was made
    #[error("http error: {0}")]
    Reqwest(#[from] reqwest::Error),
    /// OpenAI returns error object with details of API call failure
    #[error("{0}")]
    ApiError(ApiError),
    /// Error when a response cannot be deserialized into a Rust type
    #[error("failed to deserialize api response: error:{0} content:{1}")]
    JSONDeserialize(serde_json::Error, String),
    /// Error from client side validation
    /// or when builder fails to build request before making API call
    #[error("invalid args: {0}")]
    InvalidArgument(String),
}

#[cfg(not(feature = "_api"))]
#[derive(Debug)]
pub enum OpenAIError {
    /// Error from client side validation
    /// or when builder fails to build request before making API call
    InvalidArgument(String),
}

#[cfg(not(feature = "_api"))]
impl std::fmt::Display for OpenAIError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            OpenAIError::InvalidArgument(msg) => write!(f, "invalid args: {}", msg),
        }
    }
}

#[cfg(not(feature = "_api"))]
impl std::error::Error for OpenAIError {}

#[cfg(all(feature = "_api", not(target_family = "wasm")))]
#[derive(Debug, thiserror::Error)]
pub enum StreamError {
    /// Underlying error from reqwest_eventsource library when reading the stream
    #[error("{0}")]
    ReqwestEventSource(#[from] reqwest_eventsource::Error),
    /// Error when a stream event does not match one of the expected values
    #[error("Unknown event: {0:#?}")]
    UnknownEvent(eventsource_stream::Event),
    /// Error from eventsource_stream when parsing SSE
    #[error("EventStream error: {0}")]
    EventStream(String),
}

/// OpenAI API returns error object on failure
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct ApiError {
    pub message: String,
    pub r#type: Option<String>,
    pub param: Option<String>,
    pub code: Option<String>,
}

impl std::fmt::Display for ApiError {
    /// If all fields are available, `ApiError` is formatted as:
    /// `{type}: {message} (param: {param}) (code: {code})`
    /// Otherwise, missing fields will be ignored.
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let mut parts = Vec::new();

        if let Some(r#type) = &self.r#type {
            parts.push(format!("{}:", r#type));
        }

        parts.push(self.message.clone());

        if let Some(param) = &self.param {
            parts.push(format!("(param: {param})"));
        }

        if let Some(code) = &self.code {
            parts.push(format!("(code: {code})"));
        }

        write!(f, "{}", parts.join(" "))
    }
}

impl std::error::Error for ApiError {}

/// Wrapper to deserialize the error object nested in "error" JSON key
#[derive(Debug, Deserialize, Serialize)]
pub struct WrappedError {
    pub error: ApiError,
}

#[cfg(feature = "_api")]
pub(crate) fn map_deserialization_error(e: serde_json::Error, bytes: &[u8]) -> OpenAIError {
    let json_content = String::from_utf8_lossy(bytes);
    tracing::error!("failed deserialization of: {}", json_content);

    OpenAIError::JSONDeserialize(e, json_content.to_string())
}