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

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

/// The max tokens count.
///
/// ## Range
/// `[1, context_window_for_each_model]`
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
#[serde(transparent)]
pub struct MaxTokens {
    value: u32,
}

impl Default for MaxTokens {
    fn default() -> Self {
        Self {
            value: 1024,
        }
    }
}

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

impl MaxTokens {
    /// Creates a new max tokens count.
    ///
    /// ## Error
    /// - [`ValidationError`] - If the max tokens count is not between 1 and context window for each model.
    pub fn new(
        value: u32,
        model: ChatModel,
    ) -> ValidationResult<Self, u32> {
        let context_window = model.context_window();
        if value == 0 || value > context_window {
            Err(ValidationError {
                type_name: "MaxTokens".to_string(),
                reason: format!(
                    "The max tokens count must be between 1 and {}",
                    context_window,
                ),
                value,
            })
        } else {
            Ok(Self {
                value,
            })
        }
    }
}