memex-contracts 0.6.5

Shared serde contracts for rust-memex transports and future frontends
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

use serde::{Deserialize, Serialize};
use std::fmt;

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct ChunkQuality {
    pub avg_chunk_length: usize,
    pub sentence_integrity: f32,
    pub word_integrity: f32,
    pub chunk_quality: f32,
}

#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum QualityTier {
    Empty,
    Purge,
    Warn,
    Good,
    Excellent,
}

#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum AuditRecommendation {
    Empty,
    Purge,
    Warn,
    Good,
    Excellent,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct AuditResult {
    pub namespace: String,
    pub document_count: usize,
    pub avg_chunk_length: usize,
    pub sentence_integrity: f32,
    pub word_integrity: f32,
    pub chunk_quality: f32,
    pub overall_score: f32,
    pub recommendation: AuditRecommendation,
    pub passes_threshold: bool,
}

impl AuditResult {
    pub fn chunk_quality_metrics(&self) -> ChunkQuality {
        ChunkQuality {
            avg_chunk_length: self.avg_chunk_length,
            sentence_integrity: self.sentence_integrity,
            word_integrity: self.word_integrity,
            chunk_quality: self.chunk_quality,
        }
    }

    pub fn quality_tier(&self) -> QualityTier {
        match self.recommendation {
            AuditRecommendation::Empty => QualityTier::Empty,
            AuditRecommendation::Purge => QualityTier::Purge,
            AuditRecommendation::Warn => QualityTier::Warn,
            AuditRecommendation::Good => QualityTier::Good,
            AuditRecommendation::Excellent => QualityTier::Excellent,
        }
    }
}

impl AuditRecommendation {
    pub const fn as_str(self) -> &'static str {
        match self {
            AuditRecommendation::Empty => "EMPTY",
            AuditRecommendation::Purge => "PURGE",
            AuditRecommendation::Warn => "WARN",
            AuditRecommendation::Good => "GOOD",
            AuditRecommendation::Excellent => "EXCELLENT",
        }
    }
}

impl fmt::Display for AuditRecommendation {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_str())
    }
}

impl QualityTier {
    pub const fn as_str(self) -> &'static str {
        match self {
            QualityTier::Empty => "EMPTY",
            QualityTier::Purge => "PURGE",
            QualityTier::Warn => "WARN",
            QualityTier::Good => "GOOD",
            QualityTier::Excellent => "EXCELLENT",
        }
    }
}

impl fmt::Display for QualityTier {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_str())
    }
}