helixir 0.1.9

Interactive CLI tutorial for learning HelixDB
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435

use serde::{Deserialize, Serialize};

// continent lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct AddContinentInput {
    pub name: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct AddContinentResult {
    pub continent: ContinentData,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct ContinentData {
    pub id: String,
    pub name: String,
}

// country lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct AddCountryInput {
    pub continent_id: String,
    pub name: String,
    pub currency: String,
    pub population: i64,
    pub gdp: f64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct AddCountryResult {
    pub country: CountryData,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct CountryData {
    pub id: String,
    pub name: String,
    pub currency: String,
    pub population: i64,
    pub gdp: f64,
    pub label: String,
}


// city lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct AddCityInput {
    pub country_id: String,
    pub name: String,
    pub description: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct AddCityResult {
    pub city: CityData,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct CityData {
    pub id: String,
    pub name: String,
    pub description: String,
}

// set capital city lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct AddCapitalInput {
    pub country_id: String,
    pub city_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct AddCapitalResult {
    pub country_capital: CapitalEdgeData,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct CapitalEdgeData {
    pub id: String,
    pub from_node: String,
    pub to_node: String,
    pub label: String,
}

// embedding lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct CreateDescEmbeddingInput {
    pub city_id: String,
    pub vector: Vec<f64>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct CreateDescEmbeddingResult {
    pub embedding: DescEmbeddingData,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct DescEmbeddingData {
    pub id: String,
    pub data: Vec<f64>,
    pub label: String,
    pub score: f64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct CityEmbeddingEdgeData {
    pub id: String,
    pub from_node: String,
    pub to_node: String,
    pub label: String,
}

// get continent, city and country

#[derive(Serialize, Deserialize, Debug)]
pub struct GetContinentInput {
    pub continent_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetContinentResult {
    pub continent: ContinentData,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountryInput {
    pub country_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountryResult {
    pub country: CountryData,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCityInput {
    pub city_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCityResult {
    pub city: CityData,
}

// get all by node

#[derive(Serialize, Deserialize, Debug)]
pub struct GetAllContinentsResult {
    pub continents: Vec<ContinentData>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetAllCountriesResult {
    pub countries: Vec<CountryData>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetAllCitiesResult {
    pub cities: Vec<CityData>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesInContinentInput {
    pub continent_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesInContinentResult {
    pub countries: Vec<CountryData>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCitiesInCountryInput {
    pub country_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCitiesInCountryResult {
    pub cities: Vec<CityData>,
}

// get capital city lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCapitalInput {
    pub country_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCapitalResult {
    pub capital: Vec<CityData>,
}

// get country names lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct CountryNameData {
    pub name: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountryNamesResult {
    pub countries: Vec<String>,
}

// get nodes by name lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct GetContinentByNameInput {
    pub continent_name: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetContinentByNameResult {
    pub continent: Vec<ContinentData>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountryByNameInput {
    pub country_name: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountryByNameResult {
    pub country: Vec<CountryData>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCityByNameInput {
    pub city_name: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCityByNameResult {
    pub city: Vec<CityData>,
}

// get countries by filtering lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesByCurrencyInput {
    pub currency: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesByCurrencyResult {
    pub countries: Vec<CountryData>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesByPopulationInput {
    pub max_population: u64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesByPopulationResult {
    pub countries: Vec<CountryData>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesByGdpInput {
    pub min_gdp: f64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesByGdpResult {
    pub countries: Vec<CountryData>,
}

// get countries by multiple conditions lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesByPopGdpInput {
    pub min_population: i64,
    pub max_gdp: f64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesByPopGdpResult {
    pub countries: Vec<CountryData>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesByCurrPopInput {
    pub currency: String,
    pub max_population: i64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesByCurrPopResult {
    pub countries: Vec<CountryData>,
}

// get countries with capitals lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountriesWithCapitalsResult {
    pub countries: Vec<CountryData>,
}

// get range of nodes lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct GetContinentCitiesInput {
    pub continent_name: String,
    pub k: u64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetContinentCitiesResult {
    pub cities: Vec<CityData>,
}

// count capitals lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct CountCapitalsResult {
    pub num_capital: u64,
}

// get countries by city count lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountryByCityCntInput {
    pub num_cities: u64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetCountryByCityCntResult {
    pub countries: Vec<CountryData>,
}

// semantic search lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct SearchDescriptionsInput {
    pub vector: Vec<f64>,
    pub k: u64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct SearchDescriptionsResult {
    pub cities: Vec<CityData>,
}

// updating nodes lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct UpdateCurrencyInput {
    pub country_id: String,
    pub currency: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct UpdateCurrencyResult {
    pub country: CountryData,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct UpdatePopGdpInput {
    pub country_id: String,
    pub population: i64,
    pub gdp: f64,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct UpdatePopGdpResult {
    pub country: CountryData,
}

// updating meta relationships lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct UpdateCapitalInput {
    pub country_id: String,
    pub city_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct UpdateCapitalResult {
    pub city: CityData,
}

// updating embeddings lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct UpdateDescriptionInput {
    pub city_id: String,
    pub description: String,
    pub vector: Vec<f64>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct UpdateDescriptionResult {
    pub city: CityData,
}

// deleting nodes lesson

#[derive(Serialize, Deserialize, Debug)]
pub struct DeleteCityInput {
    pub city_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct DeleteCityResult {
    pub success: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct DeleteCapitalInput {
    pub country_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct DeleteCapitalResult {
    pub success: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct DeleteCountryInput {
    pub country_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct DeleteCountryResult {
    pub success: String,
}