mini-openai 0.1.1

An OpenAI API client with minimal dependencies
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
use std::env;

#[cfg(all(feature = "reqwest", feature = "ureq"))]
compile_error!("Features 'reqwest' and 'ureq' are mutually exclusive.");

#[cfg(not(any(feature = "reqwest", feature = "ureq")))]
compile_error!("One of the features 'reqwest' and 'ureq' must be enabled.");

use serde::ser::{SerializeMap, SerializeSeq};
#[cfg(feature = "ureq")]
use ureq;

#[cfg(feature = "reqwest")]
use reqwest;

const OPENAI_API_KEY: &str = "OPENAI_API_KEY";
const OPENAI_API_BASE: &str = "OPENAI_API_BASE";
const DEFAULT_API_BASE: &str = "https://api.openai.com/v1";

#[derive(thiserror::Error, Debug)]
pub enum Error {
    #[error("The configuration contains errors: {0}")]
    BadConfigurationError(String),

    #[error("Failed to serialize response: {0}")]
    SerializationError(serde_json::Error),

    #[error("Failed to deserialize response: {0}")]
    DeserializationError(String),

    #[error("Network error: {0}")]
    NetworkError(String),

    #[error("API error: {0}")]
    ApiError(String),
}

pub const DEFAULT_CHAT_MODEL: &str = "gpt-4o-mini";
pub const DEFAULT_EMBEDDING_MODEL: &str = "text-embedding-ada-002";

pub const ROLE_SYSTEM: &str = "system";
pub const ROLE_USER: &str = "user";
pub const ROLE_ASSISTANT: &str = "assistant";

#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct Message {
    pub content: String,
    pub role: String,
}

#[derive(Debug)]
pub enum ResponseFormat {
    JsonObject,
    JsonSchema(serde_json::Value),
}

impl serde::Serialize for ResponseFormat {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        match self {
            ResponseFormat::JsonObject => {
                let mut map = serializer.serialize_map(Some(1))?;
                map.serialize_entry("type", "json_object")?;
                map.end()
            }
            ResponseFormat::JsonSchema(schema) => {
                let mut map = serializer.serialize_map(Some(2))?;
                map.serialize_entry("type", "json_schema")?;
                map.serialize_entry("json_schema", schema)?;
                map.end()
            }
        }
    }
}

#[derive(Debug)]
pub enum Stop {
    String(String),
    Array(Vec<String>),
}

impl serde::Serialize for Stop {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        match self {
            Stop::String(string) => serializer.serialize_str(&string),
            Stop::Array(strings) => {
                let mut array = serializer.serialize_seq(Some(strings.len()))?;

                for string in strings {
                    array.serialize_element(string)?;
                }

                array.end()
            }
        }
    }
}

fn is_false(value: &bool) -> bool {
    *value == false
}

// NOTE: As we're supporting non-OpenAI API implementations, we should only
// send options in requests that are set. Some implementations don't like if
// they see options they don't know, even if they're "null".

/// Chat completions structure.
///
/// For reference, see: https://platform.openai.com/docs/api-reference/chat
///
/// To construct this structure easily use the default trait:
///
/// ```rust
/// let request = mini_openai::ChatCompletions {
///   messages: vec![
///     mini_openai::Message{
///         role: mini_openai::ROLE_SYSTEM.into(),
///         content: "Who are you?".into()
///     }
///   ],
///   ..Default::default()
/// };
/// ```
#[derive(Debug, serde::Serialize)]
pub struct ChatCompletions {
    pub messages: Vec<Message>,
    pub model: String,
    #[serde(skip_serializing_if = "is_false")]
    pub store: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub metadata: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub logit_bias: Option<serde_json::Value>,
    #[serde(skip_serializing_if = "is_false")]
    pub logprobs: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub top_logprobs: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_tokens: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_completion_tokens: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub n: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub presence_penalty: Option<f32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub response_format: Option<ResponseFormat>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub seed: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub service_tier: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub stop: Option<Stop>,
    /// Must be 'false': Only non-streaming is supported.
    pub stream: bool,
    // pub stream_options: Option<>,
    // pub tools: Option<>,
    // pub tool_choice: Option<>,
    // pub parallel_tool_calls: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
}

impl Default for ChatCompletions {
    fn default() -> Self {
        Self {
            messages: Default::default(),
            model: DEFAULT_CHAT_MODEL.into(),
            store: false,
            metadata: None,
            logit_bias: None,
            logprobs: false,
            top_logprobs: None,
            max_tokens: None,
            max_completion_tokens: None,
            n: None,
            presence_penalty: None,
            response_format: None,
            seed: None,
            service_tier: None,
            stop: None,
            stream: false,
            user: None,
        }
    }
}

#[derive(Debug, serde::Deserialize)]
pub struct Choice {
    pub index: usize,
    pub message: Message,
    //pub logprobs: Option<Logprobs>,
    pub finish_reason: String,
}

#[derive(Debug, serde::Deserialize)]
pub struct ChatCompletionsResponse {
    pub id: String,
    pub object: String,
    pub created: usize,
    pub model: String,
    pub choices: Vec<Choice>,
    //pub usage: Usage,
}

#[derive(Debug)]
pub enum Input {
    String(String),
    Array(Vec<String>),
}

impl From<String> for Input {
    fn from(value: String) -> Self {
        Self::String(value)
    }
}

impl From<&str> for Input {
    fn from(value: &str) -> Self {
        Self::String(value.to_string())
    }
}

impl From<Vec<String>> for Input {
    fn from(values: Vec<String>) -> Self {
        Self::Array(values)
    }
}

impl From<&[String]> for Input {
    fn from(values: &[String]) -> Self {
        Self::Array(values.to_vec())
    }
}

impl serde::Serialize for Input {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        match self {
            Input::String(string) => serializer.serialize_str(string),
            Input::Array(array) => {
                let mut seq = serializer.serialize_seq(Some(array.len()))?;
                for s in array {
                    seq.serialize_element(s)?;
                }
                seq.end()
            }
        }
    }
}

/// Embeddings request structure.
///
/// You can easily construct the input using .into():
///
/// ```rust
/// let embeddings = mini_openai::Embeddings {
///     input: "Hello".into(),
///     ..Default::default()
/// };
/// ```
///
#[derive(Debug, serde::Serialize)]
pub struct Embeddings {
    pub input: Input,
    pub model: String,
    //pub encoding_format: EncodingFormat,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dimensions: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
}

impl Default for Embeddings {
    fn default() -> Self {
        Self {
            input: Input::String("".into()),
            model: DEFAULT_EMBEDDING_MODEL.into(),
            dimensions: None,
            user: None,
        }
    }
}

#[derive(Debug, serde::Deserialize)]
pub struct EmbeddingsResponse {
    pub data: Vec<Embedding>,
    pub model: String,
    pub usage: Option<Usage>, // Not all implementations may return this
}

#[derive(Debug, serde::Deserialize)]
pub struct Embedding {
    pub index: u64,
    pub embedding: Vec<f32>,
}

#[derive(Debug, serde::Deserialize)]
pub struct Usage {
    pub prompt_tokens: u32,
    pub total_tokens: u32,
}

#[cfg(feature = "ureq")]
struct ClientImpl {
    client: ureq::Agent,
    token: Option<String>,
}

#[cfg(feature = "ureq")]
impl ClientImpl {
    fn new(token: Option<String>) -> Result<ClientImpl, Error> {
        Ok(Self {
            client: ureq::Agent::new(),
            token,
        })
    }

    fn do_request(&self, url: String, body: String) -> Result<String, Error> {
        let mut request = self
            .client
            .post(&url)
            .set("Content-Type", "application/json");

        if let Some(token) = self.token.as_ref() {
            request = request.set("Authorization", &format!("Bearer {}", token));
        }

        let response = request
            .send_string(&body)
            .map_err(|e| Error::NetworkError(e.to_string()))?;

        if response.status() != 200 {
            let text = format!("{} {}", response.status(), response.status_text());
            Err(Error::ApiError(text))?;
        }

        let body = response
            .into_string()
            .map_err(|e| Error::NetworkError(e.to_string()))?;
        Ok(body)
    }
}

#[cfg(feature = "reqwest")]
struct ClientImpl {
    client: reqwest::Client,
}

#[cfg(feature = "reqwest")]
impl ClientImpl {
    fn new(token: Option<String>) -> Result<ClientImpl, Error> {
        let mut headers = reqwest::header::HeaderMap::new();

        if let Some(token) = token {
            let mut value = reqwest::header::HeaderValue::from_str(&format!("Bearer {}", token))
                .map_err(|e| Error::BadConfigurationError(e.to_string()))?;
            value.set_sensitive(true);
            headers.insert(reqwest::header::AUTHORIZATION, value);
        }

        let client = reqwest::ClientBuilder::new()
            .default_headers(headers)
            .build()
            .map_err(|e| Error::BadConfigurationError(e.to_string()))?;

        Ok(Self { client })
    }

    async fn do_request(&self, url: String, body: String) -> Result<String, Error> {
        let response = self
            .client
            .post(url)
            .header(reqwest::header::CONTENT_TYPE, "application/json")
            .body(body)
            .send()
            .await
            .map_err(|e| Error::NetworkError(e.to_string()))?
            .error_for_status()
            .map_err(|e| Error::ApiError(e.to_string()))?
            .text()
            .await
            .map_err(|e| Error::NetworkError(e.to_string()))?;

        Ok(response)
    }
}

pub struct Client {
    inner: ClientImpl,
    base_uri: String,
}

impl Client {
    /// Creates a new `Client` instance.
    ///
    /// This function will first check for environment variables `OPENAI_API_BASE` and `OPENAI_API_KEY`.
    /// If they are not set, it will use the provided `base_uri` and `token` parameters. If neither are set,
    /// it will use the default API base URI.
    ///
    /// If a `token` is not provided and `base_uri` is set to the OpenAI API base URI, an error will be returned.
    ///
    /// # Arguments
    ///
    /// * `base_uri`: The base URI of the API, or `None` to use the environment variable or default.
    /// * `token`: The API token, or `None` to use the environment variable.
    ///
    /// # Returns
    ///
    /// A `Result` containing the new `Client` instance, or an `Error` if the configuration is invalid.
    pub fn new(base_uri: Option<String>, token: Option<String>) -> Result<Client, Error> {
        let env_base_uri = env::var(OPENAI_API_BASE).unwrap_or_default();
        let env_token = env::var(OPENAI_API_KEY).unwrap_or_default();

        let base_uri = if env_base_uri.is_empty() {
            if let Some(uri) = base_uri {
                uri
            } else {
                DEFAULT_API_BASE.to_string()
            }
        } else {
            env_base_uri
        };

        let token = if env_token.is_empty() {
            token
        } else {
            Some(env_token)
        };

        Self::new_without_environment(base_uri, token)
    }

    /// Creates a new `Client` instance without checking environment variables.
    ///
    /// This function is used internally by `new` to create a client without checking for environment variables.
    ///
    /// # Arguments
    ///
    /// * `base_uri`: The base URI of the API.
    /// * `token`: The API token, or `None` if not required.
    ///
    /// # Returns
    ///
    /// If `base_uri` is empty, an error will be returned.
    /// If `base_uri` is set to the OpenAI API base URI and `token` is `None`, an error will be returned.
    /// A `Result` containing the new `Client` instance, or an `Error` if the configuration is invalid.
    pub fn new_without_environment(
        base_uri: String,
        token: Option<String>,
    ) -> Result<Client, Error> {
        if base_uri.is_empty() {
            return Err(Error::BadConfigurationError("No base URI given".into()));
        }

        // Only check if there's a token if we're connecting to OpenAI.
        // Custom endpoints may not require it, so don't enforce it for them.
        if base_uri == DEFAULT_API_BASE && token.is_none() {
            return Err(Error::BadConfigurationError("Missing api token".into()));
        }

        let inner = ClientImpl::new(token)?;
        Ok(Self { inner, base_uri })
    }

    /// Creates a new `Client` instance from environment variables.
    ///
    /// This function will read the `OPENAI_API_BASE` and `OPENAI_API_KEY` environment variables and use them to create a client.
    ///
    /// # Returns
    ///
    /// A `Result` containing the new `Client` instance, or an `Error` if the environment variables are not set.
    pub fn new_from_environment() -> Result<Client, Error> {
        let env_base_uri =
            env::var(OPENAI_API_BASE).map_err(|e| Error::BadConfigurationError(e.to_string()))?;
        let env_token = env::var(OPENAI_API_KEY).unwrap_or_default();

        let token = if env_token.is_empty() {
            None
        } else {
            Some(env_token)
        };

        Self::new_without_environment(env_base_uri, token)
    }

    /// Sends a request to the OpenAI API to generate a completion for a chat conversation.
    ///
    /// This function takes a `ChatCompletions` struct as input, which defines the parameters of the completion request,
    /// including the chat history, model to use, and desired response format.
    ///
    /// The function returns a `ChatCompletionsResponse` struct, which contains the generated completion.
    ///
    /// # Arguments
    ///
    /// * `request`: The `ChatCompletions` struct containing the request parameters.
    ///
    /// # Returns
    ///
    /// A `Result` containing the `ChatCompletionsResponse` struct, or an `Error` if the request fails.
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// use mini_openai::{Client, ChatCompletions, Message, ROLE_USER};
    ///
    /// let client = Client::new(None, None).unwrap();
    ///
    /// // Create a new chat completion request
    /// let mut request = ChatCompletions::default();
    ///
    /// // Add a message to the chat history
    /// request.messages.push(Message {
    ///     content: "Hello!".to_string(),
    ///     role: ROLE_USER.to_string(),
    /// });
    ///
    /// // Send the request to the OpenAI API
    /// let response = client.chat_completions(&request).await.unwrap();
    ///
    /// // Print the generated completion
    /// println!("{}", response.choices[0].message.content);
    /// ```
    #[cfg(feature = "reqwest")]
    pub async fn chat_completions(
        &self,
        request: &ChatCompletions,
    ) -> Result<ChatCompletionsResponse, Error> {
        let url = format!("{}/chat/completions", self.base_uri);
        let body = serde_json::to_string(request).map_err(Error::SerializationError)?;
        let response = self.inner.do_request(url, body).await?;

        serde_json::from_str(&response).map_err(|e| Error::DeserializationError(e.to_string()))
    }

    /// Sends a request to the OpenAI API to generate a completion for a chat conversation.
    ///
    /// This function takes a `ChatCompletions` struct as input, which defines the parameters of the completion request,
    /// including the chat history, model to use, and desired response format.
    ///
    /// The function returns a `ChatCompletionsResponse` struct, which contains the generated completion.
    ///
    /// # Arguments
    ///
    /// * `request`: The `ChatCompletions` struct containing the request parameters.
    ///
    /// # Returns
    ///
    /// A `Result` containing the `ChatCompletionsResponse` struct, or an `Error` if the request fails.
    ///
    /// # Example
    ///
    /// ```rust
    /// use mini_openai::{Client, ChatCompletions, Message, ROLE_USER};
    ///
    /// let client = Client::new(None, None).unwrap();
    ///
    /// // Create a new chat completion request
    /// let mut request = ChatCompletions::default();
    ///
    /// // Add a message to the chat history
    /// request.messages.push(Message {
    ///     content: "Hello!".to_string(),
    ///     role: ROLE_USER.to_string(),
    /// });
    ///
    /// // Send the request to the OpenAI API
    /// let response = client.chat_completions(&request).unwrap();
    ///
    /// // Print the generated completion
    /// println!("{}", response.choices[0].message.content);
    /// ```
    #[cfg(feature = "ureq")]
    pub fn chat_completions(
        &self,
        request: &ChatCompletions,
    ) -> Result<ChatCompletionsResponse, Error> {
        let url = format!("{}/chat/completions", self.base_uri);
        let body = serde_json::to_string(request).map_err(Error::SerializationError)?;
        let response = self.inner.do_request(url, body)?;

        serde_json::from_str(&response).map_err(|e| Error::DeserializationError(e.to_string()))
    }

    /// Attempts to retrieve a chat completion and deserializes the response into a custom type.
    ///
    /// This function makes multiple attempts to retrieve a chat completion, up to a specified maximum number of tries.
    /// If a successful response is received, it will attempt to deserialize the response into the desired type using
    /// a provided converter function. If an error is caused anywhere the whole chain is retried up to *max_tries* times.
    ///
    /// If all attempts fail, the error that was last received will be returned.
    ///
    /// # Arguments
    ///
    /// * `request`: The chat completion request to send.
    /// * `max_tries`: The maximum number of attempts to make.
    /// * `converter`: A function that takes the content of the chat completion response and attempts to deserialize it
    ///               into the desired type.
    ///
    /// # Returns
    ///
    /// * `Result<T, Error>`: The deserialized result if successful, or the final error if all attempts fail.
    ///
    /// # Errors
    ///
    /// * Any errors that occur during the network request itself.
    /// * Any errors that occur during deserialization.
    ///
    /// # Example
    ///
    /// For the likely case that you want to parse JSON, you can use the `parse_json_lenient` helper function.
    /// Here's how to use it:
    ///
    /// ```rust,ignore
    /// #[derive(Debug, serde::Deserialize)]
    /// struct Hello {
    ///     hello: String,
    /// }
    ///
    /// let client = mini_openai::Client::new(None, None).unwrap();
    /// let request = mini_openai::ChatCompletions {
    ///     messages: vec![
    ///         mini_openai::Message {
    ///             content: r#"Respond with {"hello": "world"}"#.into(),
    ///             role: mini_openai::ROLE_SYSTEM.into(),
    ///         }
    ///     ],
    ///     ..Default::default()
    /// };
    ///
    /// let hello: Hello = client.chat_completions_into(&request, 3, mini_openai::parse_json_lenient).await.unwrap();
    /// println!("Result: {:?}", hello);
    /// ```
    #[cfg(feature = "reqwest")]
    pub async fn chat_completions_into<F, T, E>(
        &self,
        request: &ChatCompletions,
        max_tries: usize,
        converter: F,
    ) -> Result<T, Error>
    where
        F: Fn(String) -> Result<T, E>,
        E: ToString,
    {
        let mut error: Option<Error> = None;

        for _ in 1..=max_tries {
            match self.chat_completions(request).await {
                Ok(mut response) => {
                    let choice = response.choices.swap_remove(0);
                    match converter(choice.message.content) {
                        Ok(result) => return Ok(result),
                        Err(e) => error = Some(Error::DeserializationError(e.to_string())),
                    }
                }
                Err(e) => {
                    error = Some(e);
                }
            }
        }

        Err(error.unwrap())
    }

    /// Attempts to retrieve a chat completion and deserializes the response into a custom type.
    ///
    /// This function makes multiple attempts to retrieve a chat completion, up to a specified maximum number of tries.
    /// If a successful response is received, it will attempt to deserialize the response into the desired type using
    /// a provided converter function. If an error is caused anywhere the whole chain is retried up to *max_tries* times.
    ///
    /// If all attempts fail, the error that was last received will be returned.
    ///
    /// # Arguments
    ///
    /// * `request`: The chat completion request to send.
    /// * `max_tries`: The maximum number of attempts to make.
    /// * `converter`: A function that takes the content of the chat completion response and attempts to deserialize it
    ///               into the desired type.
    ///
    /// # Returns
    ///
    /// * `Result<T, Error>`: The deserialized result if successful, or the final error if all attempts fail.
    ///
    /// # Errors
    ///
    /// * Any errors that occur during the network request itself.
    /// * Any errors that occur during deserialization.
    ///
    /// # Example
    ///
    /// For the likely case that you want to parse JSON, you can use the `parse_json_lenient` helper function.
    /// Here's how to use it:
    ///
    /// ```rust
    /// #[derive(Debug, serde::Deserialize)]
    /// struct Hello {
    ///     hello: String,
    /// }
    ///
    /// let client = mini_openai::Client::new(None, None).unwrap();
    /// let request = mini_openai::ChatCompletions {
    ///     messages: vec![
    ///         mini_openai::Message {
    ///             content: r#"Respond with {"hello": "world"}"#.into(),
    ///             role: mini_openai::ROLE_SYSTEM.into(),
    ///         }
    ///     ],
    ///     ..Default::default()
    /// };
    ///
    /// let hello: Hello = client.chat_completions_into(&request, 3, mini_openai::parse_json_lenient).unwrap();
    /// println!("Result: {:?}", hello);
    /// ```
    #[cfg(feature = "ureq")]
    pub fn chat_completions_into<F, T, E>(
        &self,
        request: &ChatCompletions,
        max_tries: usize,
        converter: F,
    ) -> Result<T, Error>
    where
        F: Fn(String) -> Result<T, E>,
        E: ToString,
    {
        let mut error: Option<Error> = None;

        for _ in 1..=max_tries {
            match self.chat_completions(request) {
                Ok(mut response) => {
                    let choice = response.choices.swap_remove(0);
                    match converter(choice.message.content) {
                        Ok(result) => return Ok(result),
                        Err(e) => error = Some(Error::DeserializationError(e.to_string())),
                    }
                }
                Err(e) => {
                    error = Some(e);
                }
            }
        }

        Err(error.unwrap())
    }

    /// Sends a request to the OpenAI API to generate embeddings of text.
    ///
    /// This function takes a `Embeddings` struct as input..
    ///
    /// The function returns a `EmbeddingsResponse` struct, which contains the generated embeddings.
    ///
    /// # Arguments
    ///
    /// * `request`: The `Embeddings` struct containing the request parameters.
    ///
    /// # Returns
    ///
    /// A `Result` containing the `EmbeddingsResponse` struct, or an `Error` if the request fails.
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// use mini_openai::{Client, Embeddings, Message, ROLE_USER};
    ///
    /// let client = Client::new(None, None).unwrap();
    ///
    /// // Create a new chat completion request
    /// let request = Embeddings { input: "Hello".into(), ..Default::default() };
    ///
    /// // Send the request to the OpenAI API
    /// let response = client.embeddings(&request).await.unwrap();
    ///
    /// // Print the generated completion
    /// println!("{}", response.data[0].embedding);
    /// ```
    #[cfg(feature = "reqwest")]
    pub async fn embeddings(&self, request: &Embeddings) -> Result<EmbeddingsResponse, Error> {
        let url = format!("{}/embeddings", self.base_uri);
        let body = serde_json::to_string(request).map_err(Error::SerializationError)?;
        let response = self.inner.do_request(url, body).await?;

        serde_json::from_str(&response).map_err(|e| Error::DeserializationError(e.to_string()))
    }

    /// Sends a request to the OpenAI API to generate embeddings of text.
    ///
    /// This function takes a `Embeddings` struct as input..
    ///
    /// The function returns a `EmbeddingsResponse` struct, which contains the generated embeddings.
    ///
    /// # Arguments
    ///
    /// * `request`: The `Embeddings` struct containing the request parameters.
    ///
    /// # Returns
    ///
    /// A `Result` containing the `EmbeddingsResponse` struct, or an `Error` if the request fails.
    ///
    /// # Example
    ///
    /// ```rust
    /// use mini_openai::{Client, Embeddings, Message, ROLE_USER};
    ///
    /// let client = Client::new(None, None).unwrap();
    ///
    /// // Create a new chat completion request
    /// let request = Embeddings { input: "Hello".into(), ..Default::default() };
    ///
    /// // Send the request to the OpenAI API
    /// let response = client.embeddings(&request).unwrap();
    ///
    /// // Print the generated completion
    /// println!("{:?}", response.data[0].embedding);
    /// ```
    #[cfg(feature = "ureq")]
    pub fn embeddings(&self, request: &Embeddings) -> Result<EmbeddingsResponse, Error> {
        let url = format!("{}/embeddings", self.base_uri);
        let body = serde_json::to_string(request).map_err(Error::SerializationError)?;
        let response = self.inner.do_request(url, body)?;

        serde_json::from_str(&response).map_err(|e| Error::DeserializationError(e.to_string()))
    }
}

/// Helper function to be used with Client::chat_completions_into().
///
/// Pass this function to chat_completions_into() to let it parse a JSON
/// document. This function allows for some blabber emitted by the LLM,
/// making things like explanations or markdown-style fences a non-issue.
pub fn parse_json_lenient<T>(text: String) -> Result<T, String>
where
    T: serde::de::DeserializeOwned,
{
    let found = (text.find('{'), text.rfind('}'));
    if let (Some(begin), Some(end)) = found {
        let json = &text[begin..=end];
        serde_json::from_str(json).map_err(|e| e.to_string())
    } else {
        Err("The text doesn't contain a JSON object".into())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[cfg(feature = "ureq")]
    #[test]
    fn test_chat_completions() -> Result<(), Error> {
        let client = Client::new(None, None)?;
        let request = ChatCompletions {
            messages: vec![Message {
                role: ROLE_SYSTEM.into(),
                content: "Just say OK.".into(),
            }],
            ..Default::default()
        };

        let response: ChatCompletionsResponse = client.chat_completions(&request)?;

        assert_eq!(response.choices.len(), 1);
        assert_eq!(response.choices[0].message.content.contains("OK"), true);

        Ok(())
    }

    #[cfg(feature = "reqwest")]
    #[tokio::test]
    async fn test_chat_completions() -> Result<(), Error> {
        let client = Client::new(None, None)?;
        let request = ChatCompletions {
            messages: vec![Message {
                role: ROLE_SYSTEM.into(),
                content: "Just say OK.".into(),
            }],
            ..Default::default()
        };

        let response: ChatCompletionsResponse = client.chat_completions(&request).await?;

        assert_eq!(response.choices.len(), 1);
        assert_eq!(response.choices[0].message.content.contains("OK"), true);

        Ok(())
    }

    #[cfg(feature = "ureq")]
    #[test]
    fn test_chat_completions_into() -> Result<(), Error> {
        #[derive(serde::Deserialize)]
        struct Test {
            hello: String,
        }

        let client = Client::new(None, None)?;
        let request = ChatCompletions {
            messages: vec![Message {
                role: ROLE_SYSTEM.into(),
                content: r#"Respond with this JSON: {"hello": "a word of your choosing"}."#.into(),
            }],
            ..Default::default()
        };

        let response: Test = client.chat_completions_into(&request, 3, parse_json_lenient)?;
        assert_eq!(response.hello.is_empty(), false);

        Ok(())
    }

    #[cfg(feature = "reqwest")]
    #[tokio::test]
    async fn test_chat_completions_into() -> Result<(), Error> {
        #[derive(serde::Deserialize)]
        struct Test {
            hello: String,
        }

        let client = Client::new(None, None)?;
        let request = ChatCompletions {
            messages: vec![Message {
                role: ROLE_SYSTEM.into(),
                content: r#"Respond with this JSON: {"hello": "a word of your choosing"}."#.into(),
            }],
            ..Default::default()
        };

        let response: Test = client
            .chat_completions_into(&request, 3, parse_json_lenient)
            .await?;
        assert_eq!(response.hello.is_empty(), false);

        Ok(())
    }

    #[cfg(feature = "ureq")]
    #[test]
    fn test_embeddings() -> Result<(), Error> {
        let client = Client::new(None, None)?;
        let request = Embeddings {
            input: "Hello".into(),
            ..Default::default()
        };

        let response: EmbeddingsResponse = client.embeddings(&request)?;

        assert_eq!(response.data.len(), 1);
        assert_eq!(response.data[0].embedding.is_empty(), false);

        Ok(())
    }

    #[cfg(feature = "reqwest")]
    #[tokio::test]
    async fn test_embeddings() -> Result<(), Error> {
        let client = Client::new(None, None)?;
        let request = Embeddings {
            input: "Hello".into(),
            ..Default::default()
        };

        let response: EmbeddingsResponse = client.embeddings(&request).await?;

        assert_eq!(response.data.len(), 1);
        assert_eq!(response.data[0].embedding.is_empty(), false);

        Ok(())
    }

    #[test]
    fn test_parse_json_lenient() -> Result<(), String> {
        #[derive(serde::Deserialize)]
        struct Test {
            hello: String,
        }

        let test: Test = parse_json_lenient(r#"Here's your JSON: {"hello": "world"}"#.into())?;
        assert_eq!(test.hello, "world");

        let test: Result<Test, String> =
            parse_json_lenient(r#"JSON is a great choice for your request!"#.into());
        assert_eq!(test.is_err(), true);

        Ok(())
    }
}