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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

use thiserror::Error;

use crate::lm::{LanguageModelBuilder, LanguageModelBuilderError};

use super::config::{DEFAULT_BASE_URL, DEFAULT_EMBEDDINGS_MODEL, DEFAULT_MODEL};
use super::Ollama;

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

/// Builds an [`Ollama`] instance.
pub struct OllamaBuilder {
    /// Base URL for the Ollama API. Defaults to [`DEFAULT_BASE_URL`].
    base_url: Option<String>,
    /// Model to use for text completion. Defaults to [`DEFAULT_MODEL`].
    model: Option<String>,
    /// Model to use for embedding generation. Defaults to [`DEFAULT_EMBEDDINGS_MODEL`].
    embeddings_model: Option<String>,
}

impl OllamaBuilder {
    /// Overrides the default base URL for the Ollama API.
    /// Defaults to [`DEFAULT_BASE_URL`].
    pub fn with_base_url(mut self, base_url: String) -> Self {
        self.base_url = Some(base_url);
        self
    }

    /// Overrides the default model to use for text completion.
    /// Defaults to [`DEFAULT_MODEL`].
    pub fn with_model(mut self, model: String) -> Self {
        self.model = Some(model);
        self
    }

    pub fn with_embeddings_model(mut self, embeddings_model: String) -> Self {
        self.embeddings_model = Some(embeddings_model);
        self
    }
}

impl LanguageModelBuilder<Ollama> for OllamaBuilder {
    fn new() -> Self {
        Self {
            base_url: Some(DEFAULT_BASE_URL.to_string()),
            model: Some(DEFAULT_MODEL.to_string()),
            embeddings_model: Some(DEFAULT_EMBEDDINGS_MODEL.to_string()),
        }
    }

    /// Tries to build an [`Ollama`] instance. May fail if the required configurations are not set.
    fn try_build(self) -> Result<Ollama, LanguageModelBuilderError> {
        let Some(base_url) = self.base_url else {
            return Err(LanguageModelBuilderError::ConfigurationNotSet(
                "Base URL".to_string(),
            ));
        };
        let Some(model) = self.model else {
            return Err(LanguageModelBuilderError::ConfigurationNotSet(
                "Model".to_string(),
            ));
        };
        let Some(embeddings_model) = self.embeddings_model else {
            return Err(LanguageModelBuilderError::ConfigurationNotSet(
                "Embeddings model".to_string(),
            ));
        };
        Ok(Ollama {
            base_url: base_url.to_owned(),
            model: model.to_owned(),
            embeddings_model: embeddings_model.to_owned(),
        })
    }
}