api_openai_compatible 0.2.0

Shared OpenAI wire-protocol HTTP layer for OpenAI-compatible APIs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

//! Error type and result alias for OpenAI-compatible API operations.

mod private
{
  use error_tools::dependency::thiserror;

  /// Error variants for OpenAI-compatible API operations.
  ///
  /// Covers transport failures, API-level errors, and configuration problems.
  /// Convert from `reqwest::Error`, `serde_json::Error`, and
  /// `reqwest::header::InvalidHeaderValue` via `From` impls.
  #[ derive( Debug, Clone, PartialEq, thiserror::Error ) ]
  #[ non_exhaustive ]
  pub enum OpenAiCompatError
  {
    /// Error body returned by the API (e.g. invalid model name).
    #[ error( "API error : {0}" ) ]
    Api( String ),

    /// HTTP transport error (4xx / 5xx status code).
    #[ error( "HTTP error : {0}" ) ]
    Http( String ),

    /// Network connectivity error (DNS, TCP, etc.).
    #[ error( "Network error : {0}" ) ]
    Network( String ),

    /// Request exceeded the configured timeout.
    #[ error( "Timeout : {0}" ) ]
    Timeout( String ),

    /// Failed to deserialise the response body.
    #[ error( "Deserialisation error : {0}" ) ]
    Deserialise( String ),

    /// API key is absent or contains characters invalid in an HTTP header.
    #[ error( "Invalid API key : {0}" ) ]
    InvalidApiKey( String ),

    /// Environment is misconfigured (e.g. unparseable base URL).
    #[ error( "Environment error : {0}" ) ]
    Environment( String ),
  }

  /// Crate-level result type backed by a boxed dynamic error.
  pub type Result< T > = error_tools::untyped::Result< T >;

  impl From< reqwest::Error > for OpenAiCompatError
  {
    #[ inline ]
    fn from( e : reqwest::Error ) -> Self
    {
      if e.is_timeout()
      {
        Self::Timeout( e.to_string() )
      }
      else if e.is_connect()
      {
        Self::Network( e.to_string() )
      }
      else
      {
        Self::Http( e.to_string() )
      }
    }
  }

  impl From< serde_json::Error > for OpenAiCompatError
  {
    #[ inline ]
    fn from( e : serde_json::Error ) -> Self
    {
      Self::Deserialise( e.to_string() )
    }
  }

  impl From< reqwest::header::InvalidHeaderValue > for OpenAiCompatError
  {
    #[ inline ]
    fn from( e : reqwest::header::InvalidHeaderValue ) -> Self
    {
      Self::InvalidApiKey( e.to_string() )
    }
  }
}

crate::mod_interface!
{
  exposed use
  {
    OpenAiCompatError,
    Result,
  };
}