ai_lib/lib.rs
1//! AI-lib: A Unified AI SDK for Rust
2//!
3//! This library provides a single, consistent interface for interacting with multiple AI model providers.
4//!
5//! # Quick Start
6//!
7//! ```rust
8//! use ai_lib::{AiClient, Provider, ChatCompletionRequest, Message, Role};
9//! use ai_lib::types::common::Content;
10//!
11//! #[tokio::main]
12//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
13//! // Switch provider by changing Provider:: value
14//! let client = AiClient::new(Provider::Groq)?;
15//!
16//! let request = ChatCompletionRequest::new(
17//! "llama3-8b-8192".to_string(),
18//! vec![Message {
19//! role: Role::User,
20//! content: Content::Text("Hello, how are you?".to_string()),
21//! function_call: None,
22//! }],
23//! );
24//!
25//! println!("Client created successfully with provider: {:?}", client.current_provider());
26//! println!("Request prepared for model: {}", request.model);
27//!
28//! Ok(())
29//! }
30//! ```
31//!
32//! # Proxy Support
33//!
34//! AI-lib supports proxy configuration via environment variables:
35//!
36//! ```bash
37//! # Set proxy server
38//! export AI_PROXY_URL=http://proxy.example.com:8080
39//!
40//! # Proxy with authentication
41//! export AI_PROXY_URL=http://username:password@proxy.example.com:8080
42//!
43//! # HTTPS proxy
44//! export AI_PROXY_URL=https://proxy.example.com:8080
45//! ```
46//!
47//! All AI provider requests will automatically use the specified proxy server.
48
49pub mod api;
50pub mod client;
51pub mod config;
52pub mod metrics;
53pub mod provider;
54pub mod transport;
55pub mod types;
56pub mod utils; // minimal explicit configuration entrypoint
57
58// Re-export main types for user convenience
59pub use api::ChatApi;
60pub use client::{AiClient, AiClientBuilder, Provider};
61pub use types::{
62 AiLibError, ChatCompletionRequest, ChatCompletionResponse, Choice, Message, Role, Usage,
63};
64// Convenience re-exports: make the most-used types available from the crate root so
65// users don't need deep imports for common flows.
66pub use api::ChatCompletionChunk;
67pub use client::CancelHandle;
68pub use metrics::{Metrics, MetricsExt, NoopMetrics, NoopTimer, Timer};
69pub use transport::{
70 DynHttpTransport, DynHttpTransportRef, HttpClient, HttpTransport, TransportError,
71};
72// Re-export minimal configuration type
73pub use config::ConnectionOptions;
74pub use types::common::Content;
75
76// Re-export configuration types
77pub use provider::config::{FieldMapping, ProviderConfig};
78pub use provider::configs::ProviderConfigs;
79
80// Re-export model management tools
81pub use provider::models::{
82 CustomModelManager, LoadBalancingStrategy, ModelArray, ModelCapabilities, ModelEndpoint,
83 ModelInfo, ModelSelectionStrategy, PerformanceMetrics, PricingInfo, QualityTier, SpeedTier,
84};
85
86// Re-export batch processing functionality
87pub use api::chat::{batch_utils, BatchResult};
88
89// Re-export enhanced file utilities
90pub use utils::file::{
91 create_temp_dir, get_file_extension, get_file_size, guess_mime_from_path, is_audio_file,
92 is_file_size_acceptable, is_image_file, is_text_file, is_video_file, read_file, remove_file,
93 save_temp_file, validate_file,
94};