dim-rs 0.2.4

Vectorize data with LLM
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

use serde::{Serialize, Deserialize};
/// The type of data that is being vectorized. This enum represents the different
/// types of data that can be processed and vectorized in the system.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum DataType {
    /// Image data type for processing image files and raw image data
    Image,
    /// Text data type for processing strings and text documents
    Text, 
    /// Audio data type for processing audio files and sound data
    Audio,
    /// Video data type for processing video files and motion picture data
    Video,
}

/// A vector that contains a vectorized data and the original data. This struct pairs
/// the original data with its vector representation and type information.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Vector<T> {
    /// The vector representation of the data as floating point values
    vector: Vec<f32>,
    /// The original data being vectorized
    data: T,
    /// The type of the data being stored
    data_type: DataType,
}

/// Shared behaviors between `Vector` types. This trait defines the common operations
/// that can be performed on vectorized data regardless of the underlying data type.
pub trait VectorOperations<T> {
    /// Get the vector representation of the data
    /// 
    /// Returns a clone of the internal vector of f32 values
    fn get_vector(&self) -> Vec<f32>;

    /// Get a reference to the original data
    ///
    /// Returns an immutable reference to the stored data
    fn get_data(&self) -> &T;

    /// Get the type of data stored
    ///
    /// Returns the DataType enum indicating what kind of data is vectorized
    fn get_data_type(&self) -> DataType;

    /// Get dimensionality of the vector
    ///
    /// Returns the length of the vector representation
    fn get_dimensionality(&self) -> usize {
        self.get_vector().len()
    }

    /// Write a new vector to the vector field
    ///
    /// # Arguments
    /// * `vector` - The new vector to replace the existing one
    fn overwrite_vector(&mut self, vector: Vec<f32>);
}

impl<T> VectorOperations<T> for Vector<T> {
    fn get_vector(&self) -> Vec<f32> {
        self.vector.clone()
    }

    fn get_data_type(&self) -> DataType {
        self.data_type
    }

    fn get_data(&self) -> &T {
        &self.data
    }

    fn overwrite_vector(&mut self, vector: Vec<f32>) {
        self.vector = vector;
    }
}

impl<DynamicImage> Vector<DynamicImage> {
    /// Initialize a new vector from image data
    ///
    /// # Arguments
    /// * `data` - The image data to be vectorized
    ///
    /// # Returns
    /// A new Vector instance containing the image data
    pub fn from_image(data: DynamicImage) -> Self {
        Self {
            vector: vec![],
            data,
            data_type: DataType::Image,
        }
    }
}

impl<String> Vector<String> {
    /// Initialize a new vector from text data
    ///
    /// # Arguments
    /// * `data` - The text data to be vectorized
    ///
    /// # Returns 
    /// A new Vector instance containing the text data
    pub fn from_text(data: String) -> Self {
        Self {
            vector: vec![],
            data,
            data_type: DataType::Text,
        }
    }
}