chroma-types 0.14.0

Chroma-provided crate for internal types used in the Chroma API.
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
102
103
104
105
106
107
108
109
110
111
112

use crate::{chroma_proto, ConversionError};
use chroma_error::{ChromaError, ErrorCodes};

use thiserror::Error;

#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub enum SegmentScope {
    VECTOR,
    METADATA,
    RECORD,
    SQLITE,
}

impl From<SegmentScope> for String {
    fn from(scope: SegmentScope) -> String {
        match scope {
            SegmentScope::VECTOR => "VECTOR".to_string(),
            SegmentScope::METADATA => "METADATA".to_string(),
            SegmentScope::RECORD => "RECORD".to_string(),
            SegmentScope::SQLITE => "SQLITE".to_string(),
        }
    }
}

impl TryFrom<&str> for SegmentScope {
    type Error = SegmentScopeConversionError;

    fn try_from(scope: &str) -> Result<Self, Self::Error> {
        match scope {
            "VECTOR" => Ok(SegmentScope::VECTOR),
            "METADATA" => Ok(SegmentScope::METADATA),
            "RECORD" => Ok(SegmentScope::RECORD),
            "SQLITE" => Ok(SegmentScope::SQLITE),
            _ => Err(SegmentScopeConversionError::InvalidScope),
        }
    }
}

#[derive(Error, Debug)]
pub enum SegmentScopeConversionError {
    #[error("Invalid segment scope, valid scopes are: Vector, Metadata")]
    InvalidScope,
    #[error(transparent)]
    DecodeError(#[from] ConversionError),
}

impl_base_convert_error!(SegmentScopeConversionError, {
    SegmentScopeConversionError::InvalidScope => ErrorCodes::InvalidArgument,
});

impl From<chroma_proto::SegmentScope> for SegmentScope {
    fn from(value: chroma_proto::SegmentScope) -> Self {
        match value {
            chroma_proto::SegmentScope::Vector => Self::VECTOR,
            chroma_proto::SegmentScope::Metadata => Self::METADATA,
            chroma_proto::SegmentScope::Record => Self::RECORD,
            chroma_proto::SegmentScope::Sqlite => Self::SQLITE,
        }
    }
}

impl From<SegmentScope> for chroma_proto::SegmentScope {
    fn from(value: SegmentScope) -> Self {
        match value {
            SegmentScope::VECTOR => Self::Vector,
            SegmentScope::METADATA => Self::Metadata,
            SegmentScope::RECORD => Self::Record,
            SegmentScope::SQLITE => Self::Sqlite,
        }
    }
}

impl TryFrom<i32> for SegmentScope {
    type Error = SegmentScopeConversionError;

    fn try_from(scope: i32) -> Result<Self, Self::Error> {
        let maybe_scope = chroma_proto::SegmentScope::try_from(scope);
        match maybe_scope {
            Ok(scope) => match scope {
                chroma_proto::SegmentScope::Vector => Ok(SegmentScope::VECTOR),
                chroma_proto::SegmentScope::Metadata => Ok(SegmentScope::METADATA),
                chroma_proto::SegmentScope::Record => Ok(SegmentScope::RECORD),
                chroma_proto::SegmentScope::Sqlite => Ok(SegmentScope::SQLITE),
            },
            Err(_) => Err(SegmentScopeConversionError::InvalidScope),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_segment_scope_try_from() {
        let proto_scope = chroma_proto::SegmentScope::Vector;
        let converted_scope: SegmentScope = proto_scope.into();
        assert_eq!(converted_scope, SegmentScope::VECTOR);

        let proto_scope = chroma_proto::SegmentScope::Metadata;
        let converted_scope: SegmentScope = proto_scope.into();
        assert_eq!(converted_scope, SegmentScope::METADATA);

        let proto_scope = chroma_proto::SegmentScope::Sqlite;
        let converted_scope: SegmentScope = proto_scope.into();
        assert_eq!(converted_scope, SegmentScope::SQLITE);

        let proto_scope = chroma_proto::SegmentScope::Record;
        let converted_scope: SegmentScope = proto_scope.into();
        assert_eq!(converted_scope, SegmentScope::RECORD);
    }
}