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

//! Embed response primitive type

use serde::{Deserialize, Serialize};

/// Response from POST /api/embed endpoint
///
/// Contains the generated embeddings and timing information.
///
/// # Example Response
///
/// ```json
/// {
///   "model": "nomic-embed-text",
///   "embeddings": [[0.010071, -0.001759, 0.050072, ...]],
///   "total_duration": 14143917,
///   "load_duration": 1019500,
///   "prompt_eval_count": 8
/// }
/// ```
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct EmbedResponse {
    /// Model that produced the embeddings
    #[serde(default)]
    pub model: Option<String>,

    /// Array of embedding vectors (one per input text)
    ///
    /// Each inner vector contains the embedding dimensions (e.g., 768 or 1024 floats).
    #[serde(default)]
    pub embeddings: Vec<Vec<f64>>,

    /// Total time spent generating embeddings in nanoseconds
    #[serde(default)]
    pub total_duration: Option<i64>,

    /// Time spent loading the model in nanoseconds
    #[serde(default)]
    pub load_duration: Option<i64>,

    /// Number of input tokens processed
    #[serde(default)]
    pub prompt_eval_count: Option<i32>,
}

impl EmbedResponse {
    /// Get the number of embeddings returned
    ///
    /// This corresponds to the number of input texts provided.
    pub fn len(&self) -> usize {
        self.embeddings.len()
    }

    /// Check if there are no embeddings
    pub fn is_empty(&self) -> bool {
        self.embeddings.is_empty()
    }

    /// Get the dimension of the embeddings
    ///
    /// Returns None if there are no embeddings.
    pub fn dimensions(&self) -> Option<usize> {
        self.embeddings.first().map(|e| e.len())
    }

    /// Get the first embedding (convenience for single-input requests)
    ///
    /// Returns None if there are no embeddings.
    pub fn first_embedding(&self) -> Option<&Vec<f64>> {
        self.embeddings.first()
    }

    /// Get total duration in milliseconds (convenience method)
    ///
    /// Converts from nanoseconds to milliseconds.
    pub fn total_duration_ms(&self) -> Option<f64> {
        self.total_duration.map(|ns| ns as f64 / 1_000_000.0)
    }

    /// Get load duration in milliseconds (convenience method)
    ///
    /// Converts from nanoseconds to milliseconds.
    pub fn load_duration_ms(&self) -> Option<f64> {
        self.load_duration.map(|ns| ns as f64 / 1_000_000.0)
    }
}