lattice-embed 0.2.2

SIMD-accelerated vector operations and embedding generation
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

//! Error types for embedding operations.

use thiserror::Error;

/// **Stable**: external consumers may depend on this; breaking changes require a SemVer bump.
///
/// Errors that can occur during embedding operations.
#[derive(Error, Debug)]
#[non_exhaustive]
pub enum EmbedError {
    /// Model not loaded (needs initialization).
    #[error("model not loaded: {0}")]
    ModelNotLoaded(String),

    /// Wrong model loaded (concurrent model switch in progress).
    ///
    /// This can happen when multiple tasks request different models concurrently.
    /// The caller should retry with backoff.
    #[error("wrong model loaded: expected {expected}, got {actual}")]
    WrongModelLoaded {
        /// Model that was expected.
        expected: String,
        /// Model that was actually loaded.
        actual: String,
    },

    /// Model initialization failed.
    #[error("model initialization failed: {0}")]
    ModelInitialization(String),

    /// Embedding inference failed.
    #[error("embedding inference failed: {0}")]
    InferenceFailed(String),

    /// Blocking task failed (panic or cancellation).
    ///
    /// The model cache may be lost; next call will reinitialize.
    #[error("task execution failed: {0}")]
    TaskFailed(String),

    /// Invalid input provided.
    #[error("invalid input: {0}")]
    InvalidInput(String),

    /// Input text exceeds maximum allowed length.
    #[error("text too long: {length} chars exceeds maximum {max} chars")]
    TextTooLong {
        /// Actual length in characters.
        length: usize,
        /// Maximum allowed length.
        max: usize,
    },

    /// Dimension mismatch between expected and actual.
    #[error("dimension mismatch: expected {expected}, got {actual}")]
    DimensionMismatch {
        /// Expected dimension.
        expected: usize,
        /// Actual dimension.
        actual: usize,
    },

    /// Model not supported by this service.
    #[error("model not supported: {0}")]
    UnsupportedModel(String),

    /// Internal logic error (count mismatch, unexpected state).
    #[error("internal error: {0}")]
    Internal(String),
}

/// **Stable**: result type alias for embedding operations.
pub type Result<T> = std::result::Result<T, EmbedError>;

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

    #[test]
    fn test_error_display() {
        let err = EmbedError::DimensionMismatch {
            expected: 384,
            actual: 768,
        };
        assert_eq!(err.to_string(), "dimension mismatch: expected 384, got 768");
    }

    #[test]
    fn test_error_variants() {
        let err = EmbedError::ModelNotLoaded("test".into());
        assert_eq!(err.to_string(), "model not loaded: test");

        let err = EmbedError::WrongModelLoaded {
            expected: "small".into(),
            actual: "large".into(),
        };
        assert!(err.to_string().contains("expected small"));

        let err = EmbedError::ModelInitialization("failed".into());
        assert!(err.to_string().contains("initialization"));

        let err = EmbedError::InferenceFailed("oom".into());
        assert!(err.to_string().contains("inference"));

        let err = EmbedError::TaskFailed("panic".into());
        assert!(err.to_string().contains("task"));

        let err = EmbedError::InvalidInput("empty".into());
        assert!(err.to_string().contains("invalid input"));

        let err = EmbedError::UnsupportedModel("gpt4".into());
        assert!(err.to_string().contains("not supported"));

        let err = EmbedError::Internal("bug".into());
        assert!(err.to_string().contains("internal"));

        let err = EmbedError::TextTooLong {
            length: 50000,
            max: 32768,
        };
        assert!(err.to_string().contains("50000"));
        assert!(err.to_string().contains("32768"));
    }
}