oaapi 0.2.0

An unofficial Rust client for the OpenAI API.
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

use crate::{ValidationError, ValidationResult};
use serde::{Deserialize, Serialize};
use std::fmt::Display;

/// The temperature for generations.
///
/// ## Range
/// `[0.0, 1.0]`
#[derive(Debug, Clone, Copy, PartialEq, Default, Serialize, Deserialize)]
#[serde(transparent)]
pub struct Temperature {
    value: f32,
}

impl Display for Temperature {
    fn fmt(
        &self,
        f: &mut std::fmt::Formatter<'_>,
    ) -> std::fmt::Result {
        write!(f, "{}", self.value)
    }
}

impl Temperature {
    /// Creates a new temperature.
    ///
    /// ## Error
    /// - [`ValidationError`] - If the temperature is not between 0.0 and 1.0.
    pub fn new(value: f32) -> ValidationResult<Self, f32> {
        if value < 0.0 || value > 1.0 {
            Err(ValidationError {
                type_name: "Temperature".to_string(),
                reason: "The temperature must be between 0.0 and 1.0."
                    .to_string(),
                value,
            })
        } else {
            Ok(Self {
                value,
            })
        }
    }

    /// Returns the value of the temperature as a string.
    pub(crate) fn format(self) -> String {
        self.value.to_string()
    }
}

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

    #[test]
    fn test_new() {
        assert!(Temperature::new(0.0).is_ok());
        assert!(Temperature::new(0.5).is_ok());
        assert!(Temperature::new(1.0).is_ok());

        assert!(Temperature::new(-0.1).is_err());
        assert!(Temperature::new(1.1).is_err());
    }

    #[test]
    fn test_format() {
        assert_eq!(
            Temperature::new(0.0)
                .unwrap()
                .format(),
            "0"
        );
        assert_eq!(
            Temperature::new(0.5)
                .unwrap()
                .format(),
            "0.5"
        );
        assert_eq!(
            Temperature::new(1.0)
                .unwrap()
                .format(),
            "1"
        );
    }

    #[test]
    fn serialize_temperature() {
        assert_eq!(
            serde_json::to_string(&Temperature::new(0.0).unwrap()).unwrap(),
            "0.0"
        );
        assert_eq!(
            serde_json::to_string(&Temperature::new(0.5).unwrap()).unwrap(),
            "0.5"
        );
        assert_eq!(
            serde_json::to_string(&Temperature::new(1.0).unwrap()).unwrap(),
            "1.0"
        );
    }

    #[test]
    fn deserialize_temperature() {
        assert_eq!(
            serde_json::from_str::<Temperature>("0.0").unwrap(),
            Temperature::new(0.0).unwrap()
        );
        assert_eq!(
            serde_json::from_str::<Temperature>("0.5").unwrap(),
            Temperature::new(0.5).unwrap()
        );
        assert_eq!(
            serde_json::from_str::<Temperature>("1.0").unwrap(),
            Temperature::new(1.0).unwrap()
        );
    }
}