qdrant-edge 0.8.0

A lightweight, in-process vector search engine designed for embedded devices, autonomous systems, and mobile agents.
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

//! Fluent builder for [`QueryRequest`].
//!
//! Builder fields mirror [`QueryRequest`] explicitly so adding a field
//! to the target struct forces a compile error here.

use crate::common::types::ScoreType;
use crate::segment::types::{Filter, SearchParams, WithPayloadInterface, WithVector};
use crate::shard::query::ScoringQuery;

use crate::edge::requests::query::{Prefetch, QueryRequest};

/// Fluent builder for [`QueryRequest`].
///
/// `limit` is required and passed through [`Self::new`]; every other field is
/// optional and falls back to the [`QueryRequest::new`] defaults.
#[derive(Clone, Debug)]
pub struct QueryRequestBuilder {
    prefetches: Vec<Prefetch>,
    query: Option<ScoringQuery>,
    filter: Option<Filter>,
    score_threshold: Option<ScoreType>,
    limit: usize,
    offset: usize,
    params: Option<SearchParams>,
    with_vector: WithVector,
    with_payload: WithPayloadInterface,
}

impl QueryRequestBuilder {
    pub fn new(limit: usize) -> Self {
        let QueryRequest {
            prefetches,
            query,
            filter,
            score_threshold,
            limit,
            offset,
            params,
            with_vector,
            with_payload,
        } = QueryRequest::new(limit);
        Self {
            prefetches,
            query,
            filter,
            score_threshold,
            limit,
            offset,
            params,
            with_vector,
            with_payload,
        }
    }

    /// Replaces the whole prefetch list; see [`Self::add_prefetch`] to append one stage.
    pub fn prefetches(mut self, prefetches: Vec<Prefetch>) -> Self {
        self.prefetches = prefetches;
        self
    }

    pub fn add_prefetch(mut self, prefetch: Prefetch) -> Self {
        self.prefetches.push(prefetch);
        self
    }

    pub fn query(mut self, query: ScoringQuery) -> Self {
        self.query = Some(query);
        self
    }

    pub fn filter(mut self, filter: Filter) -> Self {
        self.filter = Some(filter);
        self
    }

    pub fn score_threshold(mut self, score_threshold: ScoreType) -> Self {
        self.score_threshold = Some(score_threshold);
        self
    }

    pub fn offset(mut self, offset: usize) -> Self {
        self.offset = offset;
        self
    }

    pub fn params(mut self, params: SearchParams) -> Self {
        self.params = Some(params);
        self
    }

    pub fn with_vector(mut self, with_vector: WithVector) -> Self {
        self.with_vector = with_vector;
        self
    }

    pub fn with_payload(mut self, with_payload: WithPayloadInterface) -> Self {
        self.with_payload = with_payload;
        self
    }

    pub fn build(self) -> QueryRequest {
        // Exhaustively destructure Self and construct QueryRequest:
        // adding a field to either type forces a compile error here.
        let Self {
            prefetches,
            query,
            filter,
            score_threshold,
            limit,
            offset,
            params,
            with_vector,
            with_payload,
        } = self;
        QueryRequest {
            prefetches,
            query,
            filter,
            score_threshold,
            limit,
            offset,
            params,
            with_vector,
            with_payload,
        }
    }
}