qdrant_client/builders/
sparse_index_config_builder.rs

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
use crate::qdrant::*;

pub struct SparseIndexConfigBuilder {
    ///
    /// Prefer a full scan search upto (excluding) this number of vectors.
    /// Note: this is number of vectors, not KiloBytes.
    pub(crate) full_scan_threshold: Option<Option<u64>>,
    ///
    /// Store inverted index on disk. If set to false, the index will be stored in RAM.
    pub(crate) on_disk: Option<Option<bool>>,
    ///
    /// Datatype used to store weights in the index.
    pub(crate) datatype: Option<Option<i32>>,
}

impl SparseIndexConfigBuilder {
    ///
    /// Prefer a full scan search upto (excluding) this number of vectors.
    /// Note: this is number of vectors, not KiloBytes.
    #[allow(unused_mut)]
    pub fn full_scan_threshold<VALUE: core::convert::Into<u64>>(self, value: VALUE) -> Self {
        let mut new = self;
        new.full_scan_threshold = Option::Some(Option::Some(value.into()));
        new
    }
    ///
    /// Store inverted index on disk. If set to false, the index will be stored in RAM.
    #[allow(unused_mut)]
    pub fn on_disk(self, value: bool) -> Self {
        let mut new = self;
        new.on_disk = Option::Some(Option::Some(value));
        new
    }
    ///
    /// Datatype used to store weights in the index.
    #[allow(unused_mut)]
    pub fn datatype<VALUE: core::convert::Into<i32>>(self, value: VALUE) -> Self {
        let mut new = self;
        new.datatype = Option::Some(Option::Some(value.into()));
        new
    }

    fn build_inner(self) -> Result<SparseIndexConfig, std::convert::Infallible> {
        Ok(SparseIndexConfig {
            full_scan_threshold: self.full_scan_threshold.unwrap_or_default(),
            on_disk: self.on_disk.unwrap_or_default(),
            datatype: self.datatype.unwrap_or_default(),
        })
    }
    /// Create an empty builder, with all fields set to `None` or `PhantomData`.
    fn create_empty() -> Self {
        Self {
            full_scan_threshold: core::default::Default::default(),
            on_disk: core::default::Default::default(),
            datatype: core::default::Default::default(),
        }
    }
}

impl From<SparseIndexConfigBuilder> for SparseIndexConfig {
    fn from(value: SparseIndexConfigBuilder) -> Self {
        value.build_inner().unwrap_or_else(|_| {
            panic!(
                "Failed to convert {0} to {1}",
                "SparseIndexConfigBuilder", "SparseIndexConfig"
            )
        })
    }
}

impl SparseIndexConfigBuilder {
    /// Builds the desired type. Can often be omitted.
    pub fn build(self) -> SparseIndexConfig {
        self.build_inner().unwrap_or_else(|_| {
            panic!(
                "Failed to build {0} into {1}",
                "SparseIndexConfigBuilder", "SparseIndexConfig"
            )
        })
    }
}

impl Default for SparseIndexConfigBuilder {
    fn default() -> Self {
        Self::create_empty()
    }
}