markhor_core 0.1.0-alpha.0.2

Core library for Markhor, a project connecting AI models, documents, and workflows for knowledge work
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

mod active_extension;

use std::{fmt::Display, ops::{Deref, DerefMut}};

pub use active_extension::{ActiveExtension, ExtensionConfig};

use serde::{Deserialize, Serialize};
use thiserror::Error;

use crate::{chat::{chat::ChatApi, prompter::Prompter}, chunking::Chunker, convert::Converter, embedding::Embedder};

pub trait Extension: Send + Sync {
    fn uri(&self) -> &str;
    fn name(&self) -> &str;
    fn description(&self) -> &str;

    fn chat_model(&self) -> Option<Box<dyn ChatApi>> { None }
    fn embedding_model(&self) -> Option<Box<dyn Embedder>> { None }
    fn chunker(&self) -> Option<Box<dyn Chunker>> { None }
    fn converter(&self) -> Option<Box<dyn Converter>> { None }
    fn prompters(&self) -> Vec<Box<dyn Prompter>> { vec![] }
    fn tools(&self) -> Vec<Box<dyn crate::tool::Tool>> { vec![] }
}

#[derive(Debug, Error)]
pub enum UseExtensionError {
    #[error("Chat model not available in extension")]
    ChatModelNotAvailable,
    
    #[error("Embedding model not available in extension")]
    EmbeddingModelNotAvailable,
    
    #[error("Chunker not available in extension")]
    ChunkerNotAvailable,

    #[error("Converter not available in extension")]
    ConverterNotAvailable,

    #[error("Prompter not available in extension")]
    PrompterNotAvailable,

    #[error("Tool not available in extension")]
    ToolNotAvailable,
}

pub struct F11y<T: ?Sized> {
    trait_object: Box<T>,
    functionality_type: FunctionalityType,
    extension: ActiveExtension,
}

impl<T: ?Sized> F11y<T> {
    pub fn extension(&self) -> &ActiveExtension {
        &self.extension
    }

    pub fn functionality_type(&self) -> FunctionalityType {
        self.functionality_type
    }

    pub fn metadata_id(&self) -> String {
        let suffix = match self.functionality_type {
            _ => "",
        };
        format!("{} {}{}", self.extension.uri(), self.functionality_type, suffix)
    }
}

impl<T: ?Sized> Deref for F11y<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &*self.trait_object
    }
}

impl<T: ?Sized> DerefMut for F11y<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut *self.trait_object
    }
}

#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum FunctionalityType {
    ChatProvider,
    Embedder,
    Chunker,
    Converter,
    Prompter,
    Tool,
}

impl Display for FunctionalityType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        serde_json::to_string(self)
            .map_err(|_| std::fmt::Error)?
            .fmt(f)
    }
}