callm 0.2.0

Run Generative AI models directly on your hardware
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

//! This module provides template implementations for different templating engines.

pub mod dummy;
pub use dummy::TemplateDummy;
pub mod jinja;
pub use jinja::TemplateJinja;

use crate::error::CallmError;
use std::fmt;

/// A trait defining the interface for template implementations.
pub trait TemplateImpl {
    /// Returns the beginning-of-sequence (BOS) token.
    fn get_bos_token(&self) -> Option<&str>;

    /// Sets the beginning-of-sequence (BOS) token.
    fn set_bos_token(&mut self, bos_token: Option<String>);

    /// Returns the end-of-sequence (EOS) token.
    fn get_eos_token(&self) -> Option<&str>;

    /// Sets the end-of-sequence (EOS) token.
    fn set_eos_token(&mut self, eos_token: Option<String>);

    /// Applies the template to the given messages and returns the formatted string.
    fn apply(&self, messages: &[(MessageRole, String)]) -> Result<String, CallmError>;
}

/// An enum representing the roles in a message exchange.
#[derive(Clone, Debug, PartialEq)]
pub enum MessageRole {
    /// The system role.
    System,
    /// The user role.
    User,
    /// The assistant role.
    Assistant,
}

impl fmt::Display for MessageRole {
    /// Formats the `MessageRole` enum for display.
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            MessageRole::System => write!(f, "system"),
            MessageRole::User => write!(f, "user"),
            MessageRole::Assistant => write!(f, "assistant"),
        }
    }
}