arms 0.0.3

🧬 The adaptive model routing system for exploration and exploitation.
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

use std::collections::HashMap;

use crate::client::config::{Config, ModelName};
use crate::provider::provider;
use crate::router::router;
use crate::types::error::OpenAIError;
use crate::types::{chat, responses};

pub struct Client {
    providers: HashMap<ModelName, Box<dyn provider::Provider>>,
    router: Box<dyn router::Router>,
}

impl Client {
    pub fn new(config: Config) -> Self {
        let mut cfg = config.clone();
        cfg.populate();

        let providers = cfg
            .models
            .iter()
            .map(|m| (m.name.clone(), provider::construct_provider(m.clone())))
            .collect();

        Self {
            providers: providers,
            router: router::construct_router(cfg.router_mode, cfg.models),
        }
    }

    pub async fn create_response(
        &mut self,
        request: responses::CreateResponse,
    ) -> Result<responses::Response, OpenAIError> {
        let candidate = self.router.sample();
        let provider = self.providers.get(&candidate).unwrap();
        provider.create_response(request).await
    }

    // This is chat completion endpoint.
    pub async fn create_completion(
        &mut self,
        request: chat::CreateChatCompletionRequest,
    ) -> Result<chat::CreateChatCompletionResponse, OpenAIError> {
        let candidate = self.router.sample();
        let provider = self.providers.get(&candidate).unwrap();
        provider.create_completion(request).await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::client::config::{Config, ModelConfig, RouterMode};
    use dotenvy::from_filename;

    #[test]
    fn test_client_new() {
        from_filename(".env.test").ok();

        struct TestCase {
            name: &'static str,
            config: Config,
            expected_router_name: &'static str,
        }

        let cases = vec![
            TestCase {
                name: "basic config",
                config: Config::builder()
                    .models(vec![
                        ModelConfig::builder()
                            .name("model_c".to_string())
                            .build()
                            .unwrap(),
                    ])
                    .build()
                    .unwrap(),
                expected_router_name: "RandomRouter",
            },
            TestCase {
                name: "weighted round-robin router",
                config: Config::builder()
                    .router_mode(RouterMode::WRR)
                    .models(vec![
                        crate::client::config::ModelConfig::builder()
                            .name("model_a".to_string())
                            .provider(Some("openai".to_string()))
                            .base_url(Some("https://api.openai.com/v1".to_string()))
                            .weight(1)
                            .build()
                            .unwrap(),
                        crate::client::config::ModelConfig::builder()
                            .name("model_b".to_string())
                            .provider(Some("openai".to_string()))
                            .base_url(Some("https://api.openai.com/v1".to_string()))
                            .weight(3)
                            .build()
                            .unwrap(),
                    ])
                    .build()
                    .unwrap(),
                expected_router_name: "WeightedRoundRobinRouter",
            },
            TestCase {
                name: "router tracker enabled",
                config: Config::builder()
                    .models(vec![
                        ModelConfig::builder()
                            .name("model_a".to_string())
                            .provider(Some("openai".to_string()))
                            .base_url(Some("https://api.openai.com/v1".to_string()))
                            .build()
                            .unwrap(),
                        ModelConfig::builder()
                            .name("model_b".to_string())
                            .provider(Some("openai".to_string()))
                            .base_url(Some("https://api.openai.com/v1".to_string()))
                            .build()
                            .unwrap(),
                    ])
                    .build()
                    .unwrap(),
                expected_router_name: "RandomRouter",
            },
        ];

        for case in cases {
            let client = Client::new(case.config.clone());
            assert_eq!(
                client.router.name(),
                case.expected_router_name,
                "Test case '{}' failed",
                case.name
            );
            assert_eq!(
                client.providers.len(),
                case.config.models.len(),
                "Test case '{}' failed on providers count",
                case.name
            );
        }
    }
}