openai-oxide 0.14.0

// OpenAI API error types

use serde::{Deserialize, Serialize};

/// Serialize a `#[serde(rename_all = "...")]` string enum to its JSON name.
///
/// Used in multipart form fields where we need the renamed string (e.g. `"fine-tune"`)
/// instead of the Rust variant name.
pub(crate) fn enum_to_string<T: Serialize>(value: &T) -> Result<String, OpenAIError> {
    let v = serde_json::to_value(value)?;
    v.as_str()
        .map(|s| s.to_string())
        .ok_or_else(|| OpenAIError::InvalidArgument(format!("expected string enum, got {v}")))
}

/// Error response body from the OpenAI API.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ErrorResponse {
    pub error: ApiErrorDetail,
}

/// Detail within an API error response.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ApiErrorDetail {
    pub message: String,
    #[serde(rename = "type")]
    pub type_: Option<String>,
    pub param: Option<String>,
    pub code: Option<String>,
}

/// All errors that can occur when using this library.
#[derive(Debug, thiserror::Error)]
pub enum OpenAIError {
    /// The API returned an error response.
    #[error("API error (status {status}): {message}")]
    ApiError {
        status: u16,
        message: String,
        type_: Option<String>,
        code: Option<String>,
        /// The `x-request-id` header value for debugging with OpenAI support.
        request_id: Option<String>,
    },

    /// HTTP request failed.
    #[error("request error: {0}")]
    RequestError(#[from] reqwest::Error),

    /// JSON (de)serialization failed.
    #[error("JSON error: {0}")]
    JsonError(#[from] serde_json::Error),

    /// SSE stream error.
    #[error("stream error: {0}")]
    StreamError(String),

    /// Invalid argument passed by the caller.
    #[error("invalid argument: {0}")]
    InvalidArgument(String),

    /// WebSocket error.
    #[cfg(feature = "websocket")]
    #[error("websocket error: {0}")]
    WebSocketError(String),
}