helios-engine 0.5.5

A powerful and flexible Rust framework for building LLM-powered agents with tool support, both locally and online
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

//! # Error and Result Module
//!
//! This module defines the custom error type `HeliosError` for the Helios Engine,
//! and a convenient `Result` type alias.

use thiserror::Error;

/// The custom error type for the Helios Engine.
#[derive(Error, Debug)]
pub enum HeliosError {
    /// An error related to configuration.
    #[error("Configuration error: {0}")]
    ConfigError(String),

    /// An error related to the Language Model (LLM).
    #[error("LLM error: {0}")]
    LLMError(String),

    /// An error related to a tool.
    #[error("Tool error: {0}")]
    ToolError(String),

    /// An error related to an agent.
    #[error("Agent error: {0}")]
    AgentError(String),

    /// An error related to a network request.
    #[error("Network error: {0}")]
    NetworkError(#[from] reqwest::Error),

    /// An error related to serialization or deserialization.
    #[error("Serialization error: {0}")]
    SerializationError(#[from] serde_json::Error),

    /// An I/O error.
    #[error("IO error: {0}")]
    IoError(#[from] std::io::Error),

    /// An error related to parsing TOML.
    #[error("TOML parsing error: {0}")]
    TomlError(#[from] toml::de::Error),

    /// An error from the Llama C++ backend.
    #[cfg(feature = "local")]
    #[error("Llama C++ error: {0}")]
    LlamaCppError(String),

    /// An error from the Candle backend.
    #[cfg(feature = "candle")]
    #[error("Candle error: {0}")]
    CandleError(#[from] candle_core::Error),
}

/// A convenient `Result` type alias for the Helios Engine.
pub type Result<T> = std::result::Result<T, HeliosError>;

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

    /// Tests that the error types can be created.
    #[test]
    fn test_error_types() {
        let config_error = HeliosError::ConfigError("Config issue".to_string());
        assert!(matches!(config_error, HeliosError::ConfigError(_)));

        let llm_error = HeliosError::LLMError("LLM issue".to_string());
        assert!(matches!(llm_error, HeliosError::LLMError(_)));

        let tool_error = HeliosError::ToolError("Tool issue".to_string());
        assert!(matches!(tool_error, HeliosError::ToolError(_)));

        let agent_error = HeliosError::AgentError("Agent issue".to_string());
        assert!(matches!(agent_error, HeliosError::AgentError(_)));
    }

    /// Tests the display formatting of the error types.
    #[test]
    fn test_error_display() {
        let config_error = HeliosError::ConfigError("Config issue".to_string());
        assert_eq!(
            format!("{}", config_error),
            "Configuration error: Config issue"
        );

        let llm_error = HeliosError::LLMError("LLM issue".to_string());
        assert_eq!(format!("{}", llm_error), "LLM error: LLM issue");

        let tool_error = HeliosError::ToolError("Tool issue".to_string());
        assert_eq!(format!("{}", tool_error), "Tool error: Tool issue");

        let agent_error = HeliosError::AgentError("Agent issue".to_string());
        assert_eq!(format!("{}", agent_error), "Agent error: Agent issue");
    }
}