ollama-oxide 0.2.0

A Rust library for integrating with Ollama's native API, providing low-level inference and high-level conveniences.
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

//! Running model primitive type

use serde::{Deserialize, Serialize};

use super::ModelDetails;

/// Information about a model currently loaded in memory
///
/// Contains runtime information about a model including VRAM usage,
/// context length, and expiration time.
///
/// # Example
///
/// ```json
/// {
///   "model": "gemma3",
///   "size": 6591830464,
///   "digest": "a2af6cc3...",
///   "details": { "format": "gguf", "family": "gemma3" },
///   "expires_at": "2025-10-17T16:47:07.93355-07:00",
///   "size_vram": 5333539264,
///   "context_length": 4096
/// }
/// ```
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RunningModel {
    /// Model name (e.g., "llama3.2", "gemma3")
    pub model: String,

    /// Total size of the model in bytes
    #[serde(default)]
    pub size: Option<u64>,

    /// SHA256 digest identifier of the model contents
    #[serde(default)]
    pub digest: Option<String>,

    /// Additional information about the model
    #[serde(default)]
    pub details: Option<ModelDetails>,

    /// Time when the model will be unloaded from memory (ISO 8601)
    #[serde(default)]
    pub expires_at: Option<String>,

    /// VRAM (GPU memory) usage in bytes
    #[serde(default)]
    pub size_vram: Option<u64>,

    /// Context length for the running model
    #[serde(default)]
    pub context_length: Option<u32>,
}

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

    #[test]
    fn test_running_model_deserialization() {
        let json = r#"{
            "model": "gemma3",
            "size": 6591830464,
            "digest": "a2af6cc3eb7fa8be8504abaf9b04e88f17a119ec3f04a3addf55f92841195f5a",
            "expires_at": "2025-10-17T16:47:07.93355-07:00",
            "size_vram": 5333539264,
            "context_length": 4096
        }"#;

        let model: RunningModel = serde_json::from_str(json).unwrap();
        assert_eq!(model.model, "gemma3");
        assert_eq!(model.size, Some(6591830464));
        assert_eq!(model.size_vram, Some(5333539264));
        assert_eq!(model.context_length, Some(4096));
    }

    #[test]
    fn test_running_model_minimal() {
        let json = r#"{"model": "llama3.2"}"#;
        let model: RunningModel = serde_json::from_str(json).unwrap();
        assert_eq!(model.model, "llama3.2");
        assert!(model.size.is_none());
        assert!(model.expires_at.is_none());
    }

    #[test]
    fn test_running_model_serialization_roundtrip() {
        let model = RunningModel {
            model: "test-model".to_string(),
            size: Some(1000),
            digest: Some("abc123".to_string()),
            details: None,
            expires_at: Some("2025-01-01T00:00:00Z".to_string()),
            size_vram: Some(500),
            context_length: Some(2048),
        };

        let json = serde_json::to_string(&model).unwrap();
        let deserialized: RunningModel = serde_json::from_str(&json).unwrap();
        assert_eq!(model, deserialized);
    }

    #[test]
    fn test_running_model_is_send_sync() {
        fn assert_send_sync<T: Send + Sync>() {}
        assert_send_sync::<RunningModel>();
    }

    #[test]
    fn test_running_model_with_details() {
        let json = r#"{
            "model": "gemma3",
            "size": 6591830464,
            "details": {
                "parent_model": "",
                "format": "gguf",
                "family": "gemma3",
                "families": ["gemma3"],
                "parameter_size": "4.3B",
                "quantization_level": "Q4_K_M"
            }
        }"#;

        let model: RunningModel = serde_json::from_str(json).unwrap();
        assert_eq!(model.model, "gemma3");
        assert!(model.details.is_some());
        let details = model.details.unwrap();
        assert_eq!(details.family, Some("gemma3".to_string()));
        assert_eq!(details.format, Some("gguf".to_string()));
    }
}