orch 0.0.16

Language model orchestration library
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

use thiserror::Error;

use crate::lm::LanguageModel;

use super::strategy::AlignmentStrategy;

/// The default number of retries for the alignment strategy, if not overriden.
pub const DEFAULT_RETRIES: usize = 2;

#[derive(Debug, Error)]
pub enum AlignmentStrategyBuilderError {
    #[error("{0} is not set")]
    ConfigurationNotSet(String),
}

#[derive(Default)]
pub struct AlignmentStrategyBuilder<'a> {
    lm: Option<&'a dyn LanguageModel>,
    retries: Option<usize>,
}

impl<'a> AlignmentStrategyBuilder<'a> {
    /// Creates a new `AlignmentStrategyBuilder` instance.
    pub fn new() -> Self {
        Self {
            lm: None,
            retries: Some(DEFAULT_RETRIES),
        }
    }

    /// Sets the language model to use for the alignment strategy.
    pub fn with_lm(mut self, lm: &'a dyn LanguageModel) -> Self {
        self.lm = Some(lm);
        self
    }

    /// Sets the number of retries for the alignment strategy.
    pub fn with_retries(mut self, retries: usize) -> Self {
        self.retries = Some(retries);
        self
    }

    /// Builds the alignment strategy.
    /// May fail with a [`AlignmentStrategyBuilderErrro`] if some required configurations are not set.
    pub fn try_build(self) -> Result<AlignmentStrategy<'a>, AlignmentStrategyBuilderError> {
        let Some(lm) = self.lm else {
            return Err(AlignmentStrategyBuilderError::ConfigurationNotSet(
                "Language model".to_string(),
            ));
        };
        let Some(retries) = self.retries else {
            return Err(AlignmentStrategyBuilderError::ConfigurationNotSet(
                "Retries".to_string(),
            ));
        };
        Ok(AlignmentStrategy { lm, retries })
    }
}