rs-puff 0.1.1

A modern (unofficial) Rust client for Turbopuffer
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

use serde::Serialize;
use std::collections::HashMap;

use crate::{DistanceMetric, Filter, RankBy, VectorEncoding};

#[derive(Debug, Clone, Default, Serialize)]
pub struct WriteParams {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub upsert_rows: Option<Vec<HashMap<String, serde_json::Value>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub upsert_columns: Option<HashMap<String, Vec<serde_json::Value>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub patch_rows: Option<Vec<HashMap<String, serde_json::Value>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub patch_columns: Option<HashMap<String, Vec<serde_json::Value>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub deletes: Option<Vec<serde_json::Value>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub delete_by_filter: Option<Filter>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub patch_by_filter: Option<PatchByFilter>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub upsert_condition: Option<Filter>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub patch_condition: Option<Filter>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub delete_condition: Option<Filter>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub distance_metric: Option<DistanceMetric>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub schema: Option<HashMap<String, serde_json::Value>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub delete_by_filter_allow_partial: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub patch_by_filter_allow_partial: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub disable_backpressure: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub return_affected_ids: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub copy_from_namespace: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct PatchByFilter {
    pub filters: Filter,
    pub patch: HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Default, Serialize)]
pub struct QueryParams {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rank_by: Option<RankBy>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub top_k: Option<u64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub filters: Option<Filter>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub include_attributes: Option<IncludeAttributes>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub exclude_attributes: Option<Vec<String>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub vector_encoding: Option<VectorEncoding>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub distance_metric: Option<DistanceMetric>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub consistency: Option<Consistency>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub aggregate_by: Option<HashMap<String, AggregateBy>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub group_by: Option<Vec<String>>,
}

#[derive(Debug, Clone, Serialize)]
#[serde(untagged)]
pub enum IncludeAttributes {
    All(bool),
    List(Vec<String>),
}

#[derive(Debug, Clone, Serialize)]
pub struct Consistency {
    pub level: ConsistencyLevel,
}

#[derive(Debug, Clone, Copy, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum ConsistencyLevel {
    Strong,
    Eventual,
}

#[derive(Debug, Clone)]
pub enum AggregateBy {
    Count,
    Sum(String),
}

impl serde::Serialize for AggregateBy {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        use serde::ser::SerializeSeq;
        match self {
            AggregateBy::Count => {
                let mut seq = serializer.serialize_seq(Some(1))?;
                seq.serialize_element("Count")?;
                seq.end()
            }
            AggregateBy::Sum(attr) => {
                let mut seq = serializer.serialize_seq(Some(2))?;
                seq.serialize_element("Sum")?;
                seq.serialize_element(attr)?;
                seq.end()
            }
        }
    }
}

#[derive(Debug, Clone, Default, Serialize)]
pub struct MultiQueryParams {
    pub queries: Vec<QueryParams>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub vector_encoding: Option<VectorEncoding>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub consistency: Option<Consistency>,
}