cortexdb-sdk 0.2.0-beta.2

Rust HTTP client SDK for CortexDB
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169

use super::transport::decode_value;
use super::CortexDbClient;
use crate::http::path;
use crate::{
    AnnEvaluationResponse, SdkResult, SearchExplainResponse, SearchResponse, VectorAlgorithm,
};

impl CortexDbClient {
    pub fn search_keyword(
        &self,
        scope: &str,
        query: &str,
        limit: usize,
    ) -> SdkResult<serde_json::Value> {
        self.post(
            &path(
                "/v1/search",
                &[
                    ("scope", scope),
                    ("mode", "keyword"),
                    ("q", query),
                    ("limit", &limit.to_string()),
                ],
            ),
            "",
        )
    }

    pub fn search_keyword_response(
        &self,
        scope: &str,
        query: &str,
        limit: usize,
    ) -> SdkResult<SearchResponse> {
        decode_value(self.search_keyword(scope, query, limit)?)
    }

    pub fn search_auto(
        &self,
        scope: &str,
        query: &str,
        vector: Option<&str>,
        limit: usize,
    ) -> SdkResult<serde_json::Value> {
        let limit = limit.to_string();
        let mut params = vec![
            ("scope", scope),
            ("mode", "auto"),
            ("q", query),
            ("limit", limit.as_str()),
        ];
        if let Some(vector) = vector {
            params.push(("vector", vector));
        }
        self.post(&path("/v1/search", &params), "")
    }

    pub fn search_auto_response(
        &self,
        scope: &str,
        query: &str,
        vector: Option<&str>,
        limit: usize,
    ) -> SdkResult<SearchResponse> {
        decode_value(self.search_auto(scope, query, vector, limit)?)
    }

    pub fn search_explain(
        &self,
        scope: &str,
        query: &str,
        mode: &str,
        vector: Option<&str>,
        limit: usize,
    ) -> SdkResult<serde_json::Value> {
        let limit = limit.to_string();
        let mut params = vec![
            ("scope", scope),
            ("mode", mode),
            ("q", query),
            ("limit", limit.as_str()),
        ];
        if let Some(vector) = vector {
            params.push(("vector", vector));
        }
        self.post(&path("/v1/search/explain", &params), "")
    }

    pub fn search_explain_response(
        &self,
        scope: &str,
        query: &str,
        mode: &str,
        vector: Option<&str>,
        limit: usize,
    ) -> SdkResult<SearchExplainResponse> {
        decode_value(self.search_explain(scope, query, mode, vector, limit)?)
    }

    pub fn search_vector(
        &self,
        scope: &str,
        vector: &[i16],
        algorithm: VectorAlgorithm,
        limit: usize,
    ) -> SdkResult<serde_json::Value> {
        let literal = vector
            .iter()
            .map(i16::to_string)
            .collect::<Vec<_>>()
            .join(",");
        self.post(
            &path(
                "/v1/search",
                &[
                    ("scope", scope),
                    ("mode", "vector"),
                    ("algorithm", algorithm.as_str()),
                    ("vector", &literal),
                    ("limit", &limit.to_string()),
                ],
            ),
            "",
        )
    }

    pub fn search_vector_response(
        &self,
        scope: &str,
        vector: &[i16],
        algorithm: VectorAlgorithm,
        limit: usize,
    ) -> SdkResult<SearchResponse> {
        decode_value(self.search_vector(scope, vector, algorithm, limit)?)
    }

    pub fn evaluate_ann(
        &self,
        scope: &str,
        vector: &[i16],
        limit: usize,
    ) -> SdkResult<serde_json::Value> {
        let literal = vector
            .iter()
            .map(i16::to_string)
            .collect::<Vec<_>>()
            .join(",");
        self.post(
            &path(
                "/v1/search/ann-evaluate",
                &[
                    ("scope", scope),
                    ("vector", &literal),
                    ("limit", &limit.to_string()),
                ],
            ),
            "",
        )
    }

    pub fn evaluate_ann_response(
        &self,
        scope: &str,
        vector: &[i16],
        limit: usize,
    ) -> SdkResult<AnnEvaluationResponse> {
        decode_value(self.evaluate_ann(scope, vector, limit)?)
    }
}