rskit-llm-openai 0.2.0-alpha.3

OpenAI provider implementation for rskit
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

//! Configuration for the `OpenAI` provider.

use rskit_util::SecretString;
use serde::Deserialize;

/// `OpenAI` provider configuration.
#[derive(Clone, Debug, Deserialize)]
pub struct Config {
    /// `OpenAI` API key.
    ///
    /// The value is redacted in debug/display output,
    /// and adapters pass it to `rskit-httpclient` as redacting auth state.
    pub api_key: SecretString,

    /// Base URL (default: `https://api.openai.com/v1`).
    #[serde(default = "default_base_url")]
    pub base_url: String,

    /// Chat model name (e.g. `gpt-4o`).
    #[serde(default = "default_model")]
    pub model: String,

    /// Embedding model name (e.g. `text-embedding-3-small`).
    #[serde(default = "default_embedding_model")]
    pub embedding_model: String,

    /// Optional embedding vector dimensions.
    ///
    /// Leave unset for models that do not accept a `dimensions` request field
    /// or when the model default dimensionality should be used.
    #[serde(default)]
    pub embedding_dimensions: Option<usize>,
}

fn default_base_url() -> String {
    "https://api.openai.com/v1".into()
}

fn default_model() -> String {
    "gpt-4o".into()
}

fn default_embedding_model() -> String {
    "text-embedding-3-small".into()
}

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

    #[test]
    fn config_deserialize_with_defaults() {
        let json = r#"{"api_key":"sk-test"}"#;
        let cfg: Config = serde_json::from_str(json).unwrap();
        assert_eq!(cfg.api_key.expose(), "sk-test");
        assert_eq!(cfg.base_url, "https://api.openai.com/v1");
        assert_eq!(cfg.model, "gpt-4o");
        assert_eq!(cfg.embedding_model, "text-embedding-3-small");
        assert_eq!(cfg.embedding_dimensions, None);
    }

    #[test]
    fn config_custom_values() {
        let json = r#"{
            "api_key":"sk-test",
            "base_url":"http://localhost:8080",
            "model":"gpt-3.5-turbo",
            "embedding_model":"text-embedding-ada-002",
            "embedding_dimensions":768
        }"#;
        let cfg: Config = serde_json::from_str(json).unwrap();
        assert_eq!(cfg.base_url, "http://localhost:8080");
        assert_eq!(cfg.model, "gpt-3.5-turbo");
        assert_eq!(cfg.embedding_model, "text-embedding-ada-002");
        assert_eq!(cfg.embedding_dimensions, Some(768));
    }
}