ai-lib 0.4.0

A unified AI SDK for Rust providing a single interface for multiple AI providers with hybrid architecture
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
// AI Client Builder Module
//
// This module contains the AiClientBuilder implementation with progressive
// custom configuration options for creating AiClient instances.

use super::metadata::metadata_from_provider;
use super::{AiClient, Provider, ProviderFactory};
use crate::api::ChatProvider;
use crate::config::{ConnectionOptions, ResilienceConfig};
use crate::metrics::{Metrics, NoopMetrics};
use crate::model::ModelResolver;
use crate::provider::classification::ProviderClassification;
use crate::provider::strategies::{FailoverProvider, RoundRobinProvider, RoutingStrategyBuilder};
use crate::rate_limiter::BackpressureController;
use crate::types::AiLibError;
use std::sync::Arc;

/// AI client builder with progressive custom configuration
pub struct AiClientBuilder {
    provider: Provider,
    base_url: Option<String>,
    proxy_url: Option<String>,
    timeout: Option<std::time::Duration>,
    pool_max_idle: Option<usize>,
    pool_idle_timeout: Option<std::time::Duration>,
    metrics: Option<Arc<dyn Metrics>>,
    // Model configuration options
    default_chat_model: Option<String>,
    default_multimodal_model: Option<String>,
    // Resilience configuration
    resilience_config: ResilienceConfig,
    #[cfg(feature = "interceptors")]
    interceptor_pipeline: Option<crate::interceptors::InterceptorPipeline>,
    #[cfg(feature = "interceptors")]
    interceptor_builder: Option<crate::interceptors::default::DefaultInterceptorsBuilder>,
    // Optional pre-built provider strategy (allows building provider directly)
    strategy: Option<Box<dyn ChatProvider>>,
    model_resolver: Option<Arc<ModelResolver>>,
}

impl AiClientBuilder {
    /// Create a new builder instance
    pub fn new(provider: Provider) -> Self {
        Self {
            provider,
            base_url: None,
            proxy_url: None,
            timeout: None,
            pool_max_idle: None,
            pool_idle_timeout: None,
            metrics: None,
            default_chat_model: None,
            default_multimodal_model: None,
            resilience_config: ResilienceConfig::default(),
            #[cfg(feature = "interceptors")]
            interceptor_pipeline: None,
            #[cfg(feature = "interceptors")]
            interceptor_builder: None,
            strategy: None,
            model_resolver: None,
        }
    }

    /// Set custom base URL
    pub fn with_base_url(mut self, base_url: &str) -> Self {
        self.base_url = Some(base_url.to_string());
        self
    }

    /// Set custom proxy URL
    pub fn with_proxy(mut self, proxy_url: Option<&str>) -> Self {
        self.proxy_url = proxy_url.map(|s| s.to_string());
        self
    }

    /// Explicitly disable proxy usage
    pub fn without_proxy(mut self) -> Self {
        self.proxy_url = Some("".to_string());
        self
    }

    /// Set custom timeout duration
    pub fn with_timeout(mut self, timeout: std::time::Duration) -> Self {
        self.timeout = Some(timeout);
        self
    }

    /// Set connection pool configuration
    pub fn with_pool_config(mut self, max_idle: usize, idle_timeout: std::time::Duration) -> Self {
        self.pool_max_idle = Some(max_idle);
        self.pool_idle_timeout = Some(idle_timeout);
        self
    }

    /// Set custom metrics implementation
    pub fn with_metrics(mut self, metrics: Arc<dyn Metrics>) -> Self {
        self.metrics = Some(metrics);
        self
    }

    #[cfg(feature = "interceptors")]
    pub fn with_interceptor_pipeline(
        mut self,
        pipeline: crate::interceptors::InterceptorPipeline,
    ) -> Self {
        self.interceptor_pipeline = Some(pipeline);
        self
    }

    #[cfg(feature = "interceptors")]
    pub fn enable_default_interceptors(mut self) -> Self {
        let p = crate::interceptors::create_default_interceptors();
        self.interceptor_pipeline = Some(p);
        self
    }

    #[cfg(feature = "interceptors")]
    pub fn enable_minimal_interceptors(mut self) -> Self {
        let p = crate::interceptors::default::DefaultInterceptorsBuilder::new()
            .enable_circuit_breaker(false)
            .enable_rate_limit(false)
            .build();
        self.interceptor_pipeline = Some(p);
        self
    }

    // --- Interceptor Configuration Proxies ---

    #[cfg(feature = "interceptors")]
    pub fn with_rate_limit(mut self, requests_per_minute: u32) -> Self {
        let builder = self.interceptor_builder.unwrap_or_default();
        self.interceptor_builder = Some(builder.with_rate_limit(requests_per_minute));
        self
    }

    #[cfg(feature = "interceptors")]
    pub fn with_circuit_breaker(mut self, threshold: u32, recovery: std::time::Duration) -> Self {
        let builder = self.interceptor_builder.unwrap_or_default();
        self.interceptor_builder = Some(builder.with_circuit_breaker(threshold, recovery));
        self
    }

    #[cfg(feature = "interceptors")]
    pub fn with_retry(
        mut self,
        max_attempts: u32,
        base_delay: std::time::Duration,
        max_delay: std::time::Duration,
    ) -> Self {
        let builder = self.interceptor_builder.unwrap_or_default();
        self.interceptor_builder = Some(builder.with_retry(max_attempts, base_delay, max_delay));
        self
    }

    #[cfg(feature = "interceptors")]
    pub fn with_interceptor_timeout(mut self, duration: std::time::Duration) -> Self {
        let builder = self.interceptor_builder.unwrap_or_default();
        self.interceptor_builder = Some(builder.with_timeout(duration));
        self
    }

    #[cfg(feature = "interceptors")]
    pub fn enable_retry(mut self, enable: bool) -> Self {
        let builder = self.interceptor_builder.unwrap_or_default();
        self.interceptor_builder = Some(builder.enable_retry(enable));
        self
    }

    #[cfg(feature = "interceptors")]
    pub fn enable_circuit_breaker(mut self, enable: bool) -> Self {
        let builder = self.interceptor_builder.unwrap_or_default();
        self.interceptor_builder = Some(builder.enable_circuit_breaker(enable));
        self
    }

    #[cfg(feature = "interceptors")]
    pub fn enable_rate_limit(mut self, enable: bool) -> Self {
        let builder = self.interceptor_builder.unwrap_or_default();
        self.interceptor_builder = Some(builder.enable_rate_limit(enable));
        self
    }

    #[cfg(feature = "interceptors")]
    pub fn enable_interceptor_timeout(mut self, enable: bool) -> Self {
        let builder = self.interceptor_builder.unwrap_or_default();
        self.interceptor_builder = Some(builder.enable_timeout(enable));
        self
    }

    /// Set default chat model for the client
    pub fn with_default_chat_model(mut self, model: &str) -> Self {
        self.default_chat_model = Some(model.to_string());
        self
    }

    /// Set default multimodal model for the client
    pub fn with_default_multimodal_model(mut self, model: &str) -> Self {
        self.default_multimodal_model = Some(model.to_string());
        self
    }

    /// Inject a custom model resolver (advanced usage).
    pub fn with_model_resolver(mut self, resolver: Arc<ModelResolver>) -> Self {
        self.model_resolver = Some(resolver);
        self
    }

    /// Enable smart defaults for resilience features
    pub fn with_smart_defaults(mut self) -> Self {
        self.resilience_config = ResilienceConfig::smart_defaults();
        self
    }

    /// Configure for production environment
    pub fn for_production(mut self) -> Self {
        self.resilience_config = ResilienceConfig::production();
        self
    }

    /// Configure for development environment
    pub fn for_development(mut self) -> Self {
        self.resilience_config = ResilienceConfig::development();
        self
    }

    /// Build and return a boxed `ChatProvider` according to the current builder configuration.
    /// If a custom `strategy` was provided via `with_strategy`, it will be returned directly.
    pub fn build_provider(mut self) -> Result<Box<dyn ChatProvider>, AiLibError> {
        // If caller supplied a custom strategy, use it directly
        if let Some(p) = self.strategy.take() {
            return Ok(p);
        }

        // Otherwise, construct provider according to builder configuration
        let base_url = self.determine_base_url()?;
        let proxy_url = self.determine_proxy_url();
        let timeout = self
            .timeout
            .unwrap_or_else(|| std::time::Duration::from_secs(30));
        let transport = self.create_custom_transport(proxy_url, timeout)?;

        ProviderFactory::create_adapter(self.provider, None, Some(base_url), transport)
    }

    /// Configure a simple max concurrent requests backpressure guard
    pub fn with_max_concurrency(mut self, max_concurrent_requests: usize) -> Self {
        let mut cfg = self.resilience_config.clone();
        cfg.backpressure = Some(crate::config::BackpressureConfig {
            max_concurrent_requests,
        });
        self.resilience_config = cfg;
        self
    }

    /// Set custom resilience configuration
    pub fn with_resilience_config(mut self, config: ResilienceConfig) -> Self {
        self.resilience_config = config;
        self
    }

    /// Provide a custom provider strategy (boxed ChatProvider)
    ///
    /// This allows injecting a fully custom implementation of `ChatProvider`,
    /// bypassing the standard provider factory logic.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use ai_lib::{AiClientBuilder, Provider};
    /// # use ai_lib::provider::strategies::RoundRobinProvider;
    /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// // Create a custom strategy (e.g., manually built RoundRobin)
    /// let strategy = RoundRobinProvider::new(vec![])?;
    ///
    /// let client = AiClientBuilder::new(Provider::OpenAI) // Provider enum ignored here
    ///     .with_strategy(Box::new(strategy))
    ///     .build()?;
    /// # Ok(())
    /// # }
    /// ```
    pub fn with_strategy(mut self, strategy: Box<dyn ChatProvider>) -> Self {
        self.strategy = Some(strategy);
        self
    }

    /// Compose a round-robin strategy from the provided providers.
    ///
    /// This method takes a collection of boxed `ChatProvider` instances and wraps them
    /// in a `RoundRobinProvider`.
    ///
    /// # Example
    ///
    /// ```rust
    /// # use ai_lib::{AiClientBuilder, Provider, AiClient};
    /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// let p1 = AiClientBuilder::new(Provider::OpenAI).build_provider()?;
    /// let p2 = AiClientBuilder::new(Provider::Anthropic).build_provider()?;
    ///
    /// let client = AiClientBuilder::new(Provider::OpenAI)
    ///     .with_round_robin_strategy(vec![p1, p2])?
    ///     .build()?;
    /// # Ok(())
    /// # }
    /// ```
    pub fn with_round_robin_strategy<I>(mut self, providers: I) -> Result<Self, AiLibError>
    where
        I: IntoIterator<Item = Box<dyn ChatProvider>>,
    {
        let providers_vec: Vec<_> = providers.into_iter().collect();
        let rr = RoundRobinProvider::new(providers_vec)?;
        self.strategy = Some(Box::new(rr));
        Ok(self)
    }

    /// Compose a failover strategy from the provided providers.
    pub fn with_failover_strategy<I>(mut self, providers: I) -> Result<Self, AiLibError>
    where
        I: IntoIterator<Item = Box<dyn ChatProvider>>,
    {
        let providers_vec: Vec<_> = providers.into_iter().collect();
        let failover = FailoverProvider::new(providers_vec)?;
        self.strategy = Some(Box::new(failover));
        Ok(self)
    }

    /// Compose a round-robin strategy from built-in `Provider` variants.
    pub fn with_round_robin_chain(mut self, providers: Vec<Provider>) -> Result<Self, AiLibError> {
        let adapters = Self::build_strategy_chain(providers)?;
        let rr = RoundRobinProvider::new(adapters)?;
        self.strategy = Some(Box::new(rr));
        Ok(self)
    }

    /// Compose a failover strategy from built-in `Provider` variants.
    pub fn with_failover_chain(mut self, providers: Vec<Provider>) -> Result<Self, AiLibError> {
        let adapters = Self::build_strategy_chain(providers)?;
        let failover = FailoverProvider::new(adapters)?;
        self.strategy = Some(Box::new(failover));
        Ok(self)
    }

    /// Use `RoutingStrategyBuilder` to configure a round-robin strategy inline.
    pub fn with_round_robin_builder(
        mut self,
        builder: RoutingStrategyBuilder,
    ) -> Result<Self, AiLibError> {
        let rr = builder.build_round_robin()?;
        self.strategy = Some(Box::new(rr));
        Ok(self)
    }

    /// Use `RoutingStrategyBuilder` to configure a failover strategy inline.
    pub fn with_failover_builder(
        mut self,
        builder: RoutingStrategyBuilder,
    ) -> Result<Self, AiLibError> {
        let failover = builder.build_failover()?;
        self.strategy = Some(Box::new(failover));
        Ok(self)
    }

    /// Build AiClient instance
    pub fn build(self) -> Result<AiClient, AiLibError> {
        let mut builder = self;
        // 1. Determine base_url: explicit setting > environment variable > default
        let base_url = builder.determine_base_url()?;

        // 2. Determine proxy_url: explicit setting > environment variable
        let proxy_url = builder.determine_proxy_url();

        // 3. Determine timeout: explicit setting > default
        let timeout = builder
            .timeout
            .unwrap_or_else(|| std::time::Duration::from_secs(30));

        // 4. Create provider strategy (custom or factory-built)
        let transport = builder.create_custom_transport(proxy_url, timeout)?;
        let chat_provider = if let Some(strategy) = builder.strategy.take() {
            strategy
        } else {
            ProviderFactory::create_adapter(
                builder.provider,
                None, // API key handled by config or env
                Some(base_url.clone()),
                transport,
            )?
        };

        // 5. Build backpressure controller if configured
        let bp_ctrl: Option<Arc<BackpressureController>> = builder
            .resilience_config
            .backpressure
            .as_ref()
            .map(|cfg| Arc::new(BackpressureController::new(cfg.max_concurrent_requests)));

        // 6. Create AiClient
        let metadata = metadata_from_provider(
            builder.provider,
            chat_provider.name().to_string(),
            Some(base_url.clone()),
            None,
            None,
        );

        let model_resolver = builder
            .model_resolver
            .unwrap_or_else(|| Arc::new(ModelResolver::new()));

        let client = AiClient {
            chat_provider,
            metadata,
            metrics: builder
                .metrics
                .unwrap_or_else(|| Arc::new(NoopMetrics::new())),
            model_resolver,
            connection_options: None,
            custom_default_chat_model: builder.default_chat_model,
            custom_default_multimodal_model: builder.default_multimodal_model,
            backpressure: bp_ctrl,
            #[cfg(feature = "interceptors")]
            interceptor_pipeline: builder
                .interceptor_pipeline
                .or_else(|| builder.interceptor_builder.map(|b| b.build())),
        };

        Ok(client)
    }

    /// Determine base_url, priority: explicit setting > environment variable > default
    fn determine_base_url(&self) -> Result<String, AiLibError> {
        resolve_base_url(self.provider, self.base_url.clone())
    }

    fn build_strategy_chain(
        providers: Vec<Provider>,
    ) -> Result<Vec<Box<dyn ChatProvider>>, AiLibError> {
        if providers.is_empty() {
            return Err(AiLibError::ConfigurationError(
                "routing strategy requires at least one provider".to_string(),
            ));
        }
        providers
            .into_iter()
            .map(|provider| Self::create_adapter_from_env(provider))
            .collect()
    }

    fn create_adapter_from_env(provider: Provider) -> Result<Box<dyn ChatProvider>, AiLibError> {
        let opts = ConnectionOptions::default().hydrate_with_env(provider.env_prefix());
        let resolved_base_url = resolve_base_url(provider, opts.base_url.clone())?;
        let transport = Self::transport_from_options(&opts)?;
        ProviderFactory::create_adapter(
            provider,
            opts.api_key.clone(),
            Some(resolved_base_url),
            transport,
        )
    }

    fn transport_from_options(
        opts: &ConnectionOptions,
    ) -> Result<Option<crate::transport::DynHttpTransportRef>, AiLibError> {
        let effective_proxy = if opts.disable_proxy {
            None
        } else {
            opts.proxy.clone()
        };

        if effective_proxy.is_none() && opts.timeout.is_none() {
            return Ok(None);
        }

        let transport_config = crate::transport::HttpTransportConfig {
            timeout: opts
                .timeout
                .unwrap_or_else(|| std::time::Duration::from_secs(30)),
            proxy: effective_proxy,
            pool_max_idle_per_host: None,
            pool_idle_timeout: None,
        };
        Ok(Some(
            crate::transport::HttpTransport::new_with_config(transport_config)?.boxed(),
        ))
    }

    /// Determine proxy_url, priority: explicit setting > environment variable
    fn determine_proxy_url(&self) -> Option<String> {
        // 1. Explicitly set proxy_url
        if let Some(ref proxy_url) = self.proxy_url {
            // If proxy_url is empty string, it means explicitly no proxy
            if proxy_url.is_empty() {
                return None;
            }
            return Some(proxy_url.clone());
        }

        // 2. AI_PROXY_URL from environment variable
        std::env::var("AI_PROXY_URL").ok()
    }

    /// Create custom HttpTransport
    fn create_custom_transport(
        &self,
        proxy_url: Option<String>,
        timeout: std::time::Duration,
    ) -> Result<Option<crate::transport::DynHttpTransportRef>, AiLibError> {
        // If no custom configuration, return None (use default transport)
        if proxy_url.is_none() && self.pool_max_idle.is_none() && self.pool_idle_timeout.is_none() {
            return Ok(None);
        }

        // Create custom HttpTransportConfig
        let transport_config = crate::transport::HttpTransportConfig {
            timeout,
            proxy: proxy_url,
            pool_max_idle_per_host: self.pool_max_idle,
            pool_idle_timeout: self.pool_idle_timeout,
        };

        // Create custom HttpTransport
        let transport = crate::transport::HttpTransport::new_with_config(transport_config)?;
        Ok(Some(transport.boxed()))
    }
}

pub(crate) fn resolve_base_url(
    provider: Provider,
    explicit: Option<String>,
) -> Result<String, AiLibError> {
    if let Some(url) = explicit {
        return Ok(url);
    }

    if let Some(env_var) = base_url_env_var(provider) {
        if let Ok(value) = std::env::var(env_var) {
            return Ok(value);
        }
    }

    if provider.is_config_driven() {
        return provider.get_default_config().map(|config| config.base_url);
    }

    default_base_url(provider)
}

fn base_url_env_var(provider: Provider) -> Option<&'static str> {
    match provider {
        Provider::Groq => Some("GROQ_BASE_URL"),
        Provider::XaiGrok => Some("GROK_BASE_URL"),
        Provider::Ollama => Some("OLLAMA_BASE_URL"),
        Provider::DeepSeek => Some("DEEPSEEK_BASE_URL"),
        Provider::Qwen => Some("DASHSCOPE_BASE_URL"),
        Provider::BaiduWenxin => Some("BAIDU_WENXIN_BASE_URL"),
        Provider::TencentHunyuan => Some("TENCENT_HUNYUAN_BASE_URL"),
        Provider::IflytekSpark => Some("IFLYTEK_BASE_URL"),
        Provider::Moonshot => Some("MOONSHOT_BASE_URL"),
        Provider::Anthropic => Some("ANTHROPIC_BASE_URL"),
        Provider::AzureOpenAI => Some("AZURE_OPENAI_BASE_URL"),
        Provider::HuggingFace => Some("HUGGINGFACE_BASE_URL"),
        Provider::TogetherAI => Some("TOGETHER_BASE_URL"),
        Provider::OpenRouter => Some("OPENROUTER_BASE_URL"),
        Provider::Replicate => Some("REPLICATE_BASE_URL"),
        Provider::ZhipuAI => Some("ZHIPU_BASE_URL"),
        Provider::MiniMax => Some("MINIMAX_BASE_URL"),
        Provider::Perplexity => Some("PERPLEXITY_BASE_URL"),
        Provider::AI21 => Some("AI21_BASE_URL"),
        // Independent adapters use fixed endpoints
        Provider::OpenAI | Provider::Gemini | Provider::Mistral | Provider::Cohere => None,
    }
}

fn default_base_url(provider: Provider) -> Result<String, AiLibError> {
    match provider {
        Provider::OpenAI => Ok("https://api.openai.com".to_string()),
        Provider::Gemini => Ok("https://generativelanguage.googleapis.com".to_string()),
        Provider::Mistral => Ok("https://api.mistral.ai".to_string()),
        Provider::Cohere => Ok("https://api.cohere.ai".to_string()),
        other => Err(AiLibError::ConfigurationError(format!(
            "Unknown provider for base URL determination: {other:?}"
        ))),
    }
}