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

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

/// Universal query over an edge shard: a scoring query with optional prefetch stages.
#[derive(Clone, Debug, PartialEq)]
pub struct QueryRequest {
    /// Sub-requests resolved first; their results form the candidate set the top-level
    /// `query` re-scores.
    pub prefetches: Vec<Prefetch>,
    /// How to score the candidates. `None` scrolls by id instead of scoring.
    pub query: Option<ScoringQuery>,
    /// Look only for points which satisfy these conditions.
    pub filter: Option<Filter>,
    /// Exclude results with a worse score than this.
    pub score_threshold: Option<ScoreType>,
    /// Max number of results to return.
    pub limit: usize,
    /// Offset of the first result to return. May be used to paginate results.
    /// Note: large offset values may cause performance issues.
    pub offset: usize,
    /// Search params for when there is no prefetch.
    pub params: Option<SearchParams>,
    /// Options for specifying which vectors to include into the response. Default is false.
    pub with_vector: WithVector,
    /// Select which payload to return with the response. Default is false.
    pub with_payload: WithPayloadInterface,
}

impl QueryRequest {
    pub fn new(limit: usize) -> Self {
        Self {
            prefetches: Vec::new(),
            query: None,
            filter: None,
            score_threshold: None,
            limit,
            offset: 0,
            params: None,
            with_vector: WithVector::Bool(false),
            with_payload: WithPayloadInterface::Bool(false),
        }
    }
}

/// One prefetch stage of a [`QueryRequest`]: produces the candidate set its parent re-scores.
/// Prefetches nest, forming a candidate-resolution tree evaluated leaves-first.
#[derive(Clone, Debug, PartialEq)]
pub struct Prefetch {
    /// Nested sub-prefetches resolved before this one.
    pub prefetches: Vec<Prefetch>,
    /// How to score this stage's candidates. `None` scrolls by id instead of scoring.
    pub query: Option<ScoringQuery>,
    /// Max number of candidates this stage passes to its parent.
    pub limit: usize,
    /// Additional search params.
    pub params: Option<SearchParams>,
    /// Look only for points which satisfy these conditions.
    pub filter: Option<Filter>,
    /// Exclude candidates with a worse score than this.
    pub score_threshold: Option<ScoreType>,
}

impl Prefetch {
    pub fn new(limit: usize) -> Self {
        Self {
            prefetches: Vec::new(),
            query: None,
            limit,
            params: None,
            filter: None,
            score_threshold: None,
        }
    }
}