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

use crate::macros::impl_enum_with_string_or_array_serialization;
use crate::ValidationResult;
use std::fmt::Display;

/// The stop sequence(s) option.
#[derive(Debug, Clone, Eq, PartialEq)]
pub enum StopOption {
    /// Single sequence.
    SingleSequence(String),
    /// Up to 4 sequences.
    UpTo4Sequences(Vec<String>),
}

impl Default for StopOption {
    fn default() -> Self {
        Self::SingleSequence(String::new())
    }
}

impl Display for StopOption {
    fn fmt(
        &self,
        f: &mut std::fmt::Formatter<'_>,
    ) -> std::fmt::Result {
        match self {
            | StopOption::SingleSequence(s) => {
                write!(f, "{}", s)
            },
            | StopOption::UpTo4Sequences(s) => write!(f, "[{}]", s.join(", ")),
        }
    }
}

impl StopOption {
    pub fn new_single<S: Into<String>>(sequence: S) -> Self {
        Self::SingleSequence(sequence.into())
    }

    /// Creates a new stop option with up to 4 sequences.
    ///
    /// ## Error
    /// - [`ValidationError`] - If the number of sequences is greater than 4.
    pub fn new_up_to_4<S: Into<String>>(
        sequences: Vec<S>
    ) -> ValidationResult<Self, usize> {
        if sequences.len() > 4 {
            Err(crate::ValidationError {
                type_name: "StopOption".to_string(),
                reason:
                    "The number of sequences must be less than or equal to 4."
                        .to_string(),
                value: sequences.len(),
            })
        } else {
            Ok(Self::UpTo4Sequences(
                sequences
                    .into_iter()
                    .map(|s| s.into())
                    .collect(),
            ))
        }
    }
}

impl_enum_with_string_or_array_serialization!(
    StopOption,
    SingleSequence(String),
    UpTo4Sequences(String)
);