algoliasearch 0.1.7

Algolia client
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
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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
use std::{
    collections::{HashMap, HashSet},
    fmt,
};

use serde::{
    de::{self, Deserialize, Deserializer, SeqAccess, Visitor},
    ser::{Serialize, SerializeSeq, Serializer},
};
use serde_repr::*;

enum_str!(SortFacetValuesBy {
    Count("count"),
    Alpha("alpha"),
});

#[cfg(test)]
mod sort_facet_values_by_tests {
    use super::*;
    use serde_json;

    #[test]
    fn test_serialize() {
        assert_eq!(
            serde_json::to_string(&SortFacetValuesBy::Count).unwrap(),
            r#""count""#
        );
        assert_eq!(
            serde_json::to_string(&SortFacetValuesBy::Alpha).unwrap(),
            r#""alpha""#
        );
    }

    #[test]
    fn test_deserialize() {
        assert_eq!(
            serde_json::from_str::<SortFacetValuesBy>(r#""count""#).unwrap(),
            SortFacetValuesBy::Count
        );
        assert_eq!(
            serde_json::from_str::<SortFacetValuesBy>(r#""alpha""#).unwrap(),
            SortFacetValuesBy::Alpha
        );
        assert_eq!(
            serde_json::from_str::<SortFacetValuesBy>(r#""unknown""#)
                .unwrap_err()
                .classify(),
            serde_json::error::Category::Data
        );
        assert_eq!(
            serde_json::from_str::<SortFacetValuesBy>(r#""unknown""#)
                .unwrap_err()
                .to_string(),
            "invalid value: unknown SortFacetValuesBy variant: unknown, \
             expected a string for SortFacetValuesBy at line 1 column 9"
        );
    }
}

#[derive(Clone, Debug, PartialEq, Hash)]
/// [https://www.algolia.com/doc/api-reference/api-parameters/typoTolerance/](https://www.algolia.com/doc/api-reference/api-parameters/typoTolerance/)
pub enum TypoTolerance {
    #[allow(missing_docs)]
    Enabled,
    #[allow(missing_docs)]
    Disabled,
    #[allow(missing_docs)]
    Min,
    #[allow(missing_docs)]
    Strict,
}

struct TypoToleranceVisitor;

impl<'de> Visitor<'de> for TypoToleranceVisitor {
    type Value = TypoTolerance;

    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter.write_str("a bool or String")
    }

    fn visit_bool<E>(self, value: bool) -> Result<Self::Value, E>
    where
        E: de::Error,
    {
        if value {
            Ok(TypoTolerance::Enabled)
        } else {
            Ok(TypoTolerance::Disabled)
        }
    }

    fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
    where
        E: de::Error,
    {
        match value {
            "min" => Ok(TypoTolerance::Min),
            "strict" => Ok(TypoTolerance::Strict),
            _ => Err(E::custom(format!(
                r#"expected "min" or "strict", got "{}""#,
                value
            ))),
        }
    }
}

impl<'de> Deserialize<'de> for TypoTolerance {
    fn deserialize<D>(deserializer: D) -> Result<TypoTolerance, D::Error>
    where
        D: Deserializer<'de>,
    {
        deserializer.deserialize_any(TypoToleranceVisitor)
    }
}

impl Serialize for TypoTolerance {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match self {
            TypoTolerance::Enabled => serializer.serialize_bool(true),
            TypoTolerance::Disabled => serializer.serialize_bool(false),
            TypoTolerance::Min => serializer.serialize_str("min"),
            TypoTolerance::Strict => serializer.serialize_str("strict"),
        }
    }
}

#[cfg(test)]
mod typo_tolerance_tests {
    use super::*;
    use serde_json;

    #[test]
    fn test_serialize() {
        assert_eq!(
            serde_json::to_string(&TypoTolerance::Enabled).unwrap(),
            r#"true"#
        );
        assert_eq!(
            serde_json::to_string(&TypoTolerance::Disabled).unwrap(),
            r#"false"#
        );
        assert_eq!(
            serde_json::to_string(&TypoTolerance::Min).unwrap(),
            r#""min""#
        );
        assert_eq!(
            serde_json::to_string(&TypoTolerance::Strict).unwrap(),
            r#""strict""#
        );
    }

    #[test]
    fn test_deserialize() {
        assert_eq!(
            serde_json::from_str::<TypoTolerance>(r#"true"#).unwrap(),
            TypoTolerance::Enabled
        );
        assert_eq!(
            serde_json::from_str::<TypoTolerance>(r#"false"#).unwrap(),
            TypoTolerance::Disabled
        );
        assert_eq!(
            serde_json::from_str::<TypoTolerance>(r#""min""#).unwrap(),
            TypoTolerance::Min
        );
        assert_eq!(
            serde_json::from_str::<TypoTolerance>(r#""strict""#).unwrap(),
            TypoTolerance::Strict
        );
        assert_eq!(
            serde_json::from_str::<TypoTolerance>(r#""unknown""#)
                .unwrap_err()
                .classify(),
            serde_json::error::Category::Data
        );
        assert_eq!(
            serde_json::from_str::<TypoTolerance>(r#""unknown""#)
                .unwrap_err()
                .to_string(),
            "expected \"min\" or \"strict\", got \"unknown\" at line 1 column 9"
        );
    }
}

/// [https://www.algolia.com/doc/api-reference/api-parameters/removeStopWords/](https://www.algolia.com/doc/api-reference/api-parameters/removeStopWords/)
pub type RemoveStopWords = IgnorePlurals;

#[derive(Clone, Debug, PartialEq, Hash)]
/// [https://www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/](https://www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/)
pub enum IgnorePlurals {
    #[allow(missing_docs)]
    Enabled,
    #[allow(missing_docs)]
    Disabled,
    #[allow(missing_docs)]
    Languages(Vec<String>),
}

struct IgnorePluralsVisitor;

impl<'de> Visitor<'de> for IgnorePluralsVisitor {
    type Value = IgnorePlurals;

    fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter.write_str("a bool or a list of ISO codes")
    }

    fn visit_bool<E>(self, value: bool) -> Result<Self::Value, E>
    where
        E: de::Error,
    {
        if value {
            Ok(IgnorePlurals::Enabled)
        } else {
            Ok(IgnorePlurals::Disabled)
        }
    }

    fn visit_seq<V>(self, mut seq: V) -> Result<Self::Value, V::Error>
    where
        V: SeqAccess<'de>,
    {
        let mut values = Vec::with_capacity(seq.size_hint().unwrap_or(0));
        while let Some(value) = seq.next_element()? {
            values.push(value);
        }
        Ok(IgnorePlurals::Languages(values))
    }
}

impl<'de> Deserialize<'de> for IgnorePlurals {
    fn deserialize<D>(deserializer: D) -> Result<IgnorePlurals, D::Error>
    where
        D: Deserializer<'de>,
    {
        deserializer.deserialize_any(IgnorePluralsVisitor)
    }
}

impl Serialize for IgnorePlurals {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match self {
            IgnorePlurals::Enabled => serializer.serialize_bool(true),
            IgnorePlurals::Disabled => serializer.serialize_bool(false),
            IgnorePlurals::Languages(values) => {
                let mut seq = serializer.serialize_seq(Some(values.len()))?;
                for e in values {
                    seq.serialize_element(e)?;
                }
                seq.end()
            }
        }
    }
}

#[cfg(test)]
mod ignore_plurals_tests {
    use super::*;
    use serde_json;

    #[test]
    fn test_serialize() {
        assert_eq!(
            serde_json::to_string(&IgnorePlurals::Enabled).unwrap(),
            r#"true"#
        );
        assert_eq!(
            serde_json::to_string(&IgnorePlurals::Disabled).unwrap(),
            r#"false"#
        );
        assert_eq!(
            serde_json::to_string(&IgnorePlurals::Languages(vec!["fr".to_string()])).unwrap(),
            r#"["fr"]"#
        );
    }

    #[test]
    fn test_deserialize() {
        assert_eq!(
            serde_json::from_str::<IgnorePlurals>(r#"true"#).unwrap(),
            IgnorePlurals::Enabled
        );
        assert_eq!(
            serde_json::from_str::<IgnorePlurals>(r#"false"#).unwrap(),
            IgnorePlurals::Disabled
        );
        assert_eq!(
            serde_json::from_str::<IgnorePlurals>(r#"["fr", "en"]"#).unwrap(),
            IgnorePlurals::Languages(vec!["fr".to_string(), "en".to_string()])
        );
        assert_eq!(
            serde_json::from_str::<IgnorePlurals>(r#""unknown""#)
                .unwrap_err()
                .classify(),
            serde_json::error::Category::Data
        );
        assert_eq!(
            serde_json::from_str::<IgnorePlurals>(r#""unknown""#)
                .unwrap_err()
                .to_string(),
            "invalid type: string \"unknown\", expected a bool or a list of ISO codes at line 1 column 9"
        );
    }
}

/// [https://www.algolia.com/doc/api-reference/api-parameters/queryType/](https://www.algolia.com/doc/api-reference/api-parameters/queryType/)
enum_str!(QueryType {
    PrefixLast("prefixLast"),
    PrefixAll("prefixAll"),
    PrefixNone("prefixNone"),
});

#[cfg(test)]
mod query_type_tests {
    use super::*;
    use serde_json;

    #[test]
    fn test_serialize() {
        assert_eq!(
            serde_json::to_string(&QueryType::PrefixLast).unwrap(),
            r#""prefixLast""#
        );
        assert_eq!(
            serde_json::to_string(&QueryType::PrefixAll).unwrap(),
            r#""prefixAll""#
        );
        assert_eq!(
            serde_json::to_string(&QueryType::PrefixNone).unwrap(),
            r#""prefixNone""#
        );
    }

    #[test]
    fn test_deserialize() {
        assert_eq!(
            serde_json::from_str::<QueryType>(r#""prefixLast""#).unwrap(),
            QueryType::PrefixLast
        );
        assert_eq!(
            serde_json::from_str::<QueryType>(r#""prefixAll""#).unwrap(),
            QueryType::PrefixAll
        );
        assert_eq!(
            serde_json::from_str::<QueryType>(r#""prefixNone""#).unwrap(),
            QueryType::PrefixNone
        );
        assert_eq!(
            serde_json::from_str::<QueryType>(r#""unknown""#)
                .unwrap_err()
                .classify(),
            serde_json::error::Category::Data
        );
        assert_eq!(
            serde_json::from_str::<QueryType>(r#""unknown""#)
                .unwrap_err()
                .to_string(),
            "invalid value: unknown QueryType variant: unknown, \
             expected a string for QueryType at line 1 column 9"
        );
    }
}

enum_str!(RemoveWordsIfNoResults {
    None("none"),
    LastWords("lastWords"),
    FirstWords("firstWords"),
    AllOptions("allOptions"),
});

enum_str!(ExactOnSingleWordQuery {
    Attribute("attribute"),
    None("none"),
    Word("word"),
});

enum_str!(AlternativesAsExact {
    IgnorePlurals("ignorePlurals"),
    SingleWordSynonym("singleWordSynonym"),
    MultiWordsSynonym("multiWordsSynonym"),
});

#[derive(Clone, Debug, Serialize_repr, Deserialize_repr, PartialEq, Hash)]
#[repr(u8)]
/// [https://www.algolia.com/doc/api-reference/api-parameters/distinct/](https://www.algolia.com/doc/api-reference/api-parameters/distinct/)
pub enum Distinct {
    #[allow(missing_docs)]
    Zero = 0,
    #[allow(missing_docs)]
    One = 1,
    #[allow(missing_docs)]
    Two = 2,
    #[allow(missing_docs)]
    Three = 3,
}

#[derive(Clone, Debug, Serialize_repr, Deserialize_repr, PartialEq, Hash)]
#[repr(u8)]
/// [https://www.algolia.com/doc/api-reference/api-parameters/minProximity/](https://www.algolia.com/doc/api-reference/api-parameters/minProximity/)
pub enum MinProximity {
    #[allow(missing_docs)]
    One = 1,
    #[allow(missing_docs)]
    Two = 2,
    #[allow(missing_docs)]
    Three = 3,
    #[allow(missing_docs)]
    Four = 4,
    #[allow(missing_docs)]
    Five = 5,
    #[allow(missing_docs)]
    Six = 6,
    #[allow(missing_docs)]
    Seven = 7,
}

#[derive(Clone, Builder, Debug, Default, Deserialize, Serialize)]
#[builder(default)]
#[serde(rename_all = "camelCase")]
/// Index settings.
pub struct IndexSettings {
    // attributes
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/searchableAttributes/](https://www.algolia.com/doc/api-reference/api-parameters/searchableAttributes/)
    pub searchable_attributes: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/)
    pub attributes_for_facetting: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/)
    pub unretrievable_attributes: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/attributesToRetrieve/](https://www.algolia.com/doc/api-reference/api-parameters/attributesToRetrieve/)
    pub attributes_to_retrieve: Option<Vec<String>>,

    // ranking
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/ranking/](https://www.algolia.com/doc/api-reference/api-parameters/ranking/)
    pub ranking: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/customRanking/](https://www.algolia.com/doc/api-reference/api-parameters/customRanking/)
    pub custom_ranking: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/replicas/](https://www.algolia.com/doc/api-reference/api-parameters/replicas/)
    pub replicas: Option<Vec<String>>,

    // faceting
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/maxValuesPerFacet/](https://www.algolia.com/doc/api-reference/api-parameters/maxValuesPerFacet/)
    pub max_values_per_facet: Option<u64>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/](https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/)
    pub sort_facet_values_by: Option<SortFacetValuesBy>,
    // highlighting-snippeting
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/attributesToHighlight/](https://www.algolia.com/doc/api-reference/api-parameters/attributesToHighlight/)
    pub attributes_to_highlight: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/attributesToSnippet/](https://www.algolia.com/doc/api-reference/api-parameters/attributesToSnippet/)
    pub attributes_to_snippet: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/highlightPreTag/](https://www.algolia.com/doc/api-reference/api-parameters/highlightPreTag/)
    pub highlight_pre_tag: Option<String>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/highlightPostTag/](https://www.algolia.com/doc/api-reference/api-parameters/highlightPostTag/)
    pub highlight_post_tag: Option<String>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/snippetEllipsisText/](https://www.algolia.com/doc/api-reference/api-parameters/snippetEllipsisText/)
    pub snippet_ellipsis_text: Option<String>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/restrictHighlightAndSnippetArrays/](https://www.algolia.com/doc/api-reference/api-parameters/restrictHighlightAndSnippetArrays/)
    pub restrict_highlight_and_snippet_arrays: Option<bool>,

    // pagination
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/hitsPerPage/](https://www.algolia.com/doc/api-reference/api-parameters/hitsPerPage/)
    pub hits_per_page: Option<u64>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/paginationLimitedTo/](https://www.algolia.com/doc/api-reference/api-parameters/paginationLimitedTo/)
    pub pagination_limited_to: Option<u64>,

    // typos
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "minWordSizefor1Typo")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/minWordSizefor1Typo/](https://www.algolia.com/doc/api-reference/api-parameters/minWordSizefor1Typo/)
    pub min_word_sizefor_1_typo: Option<u64>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "minWordSizefor2Typo")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/minWordSizefor2Typos/](https://www.algolia.com/doc/api-reference/api-parameters/minWordSizefor2Typos/)
    pub min_word_sizefor_2_typos: Option<u64>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/typoTolerance/](https://www.algolia.com/doc/api-reference/api-parameters/typoTolerance/)
    pub typo_tolerance: Option<TypoTolerance>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/allowTyposOnNumericTokens/](https://www.algolia.com/doc/api-reference/api-parameters/allowTyposOnNumericTokens/)
    pub allow_typos_on_numeric_tokens: Option<bool>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/disableTypoToleranceOnAttributes/](https://www.algolia.com/doc/api-reference/api-parameters/disableTypoToleranceOnAttributes/)
    pub disable_typo_tolerance_on_attributes: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/disableTypoToleranceOnWords/](https://www.algolia.com/doc/api-reference/api-parameters/disableTypoToleranceOnWords/)
    pub disable_typo_tolerance_on_words: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/separatorsToIndex/](https://www.algolia.com/doc/api-reference/api-parameters/separatorsToIndex/)
    pub separators_to_index: Option<String>,

    // languages
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/](https://www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/)
    pub ignore_plurals: Option<IgnorePlurals>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/removeStopWords/](https://www.algolia.com/doc/api-reference/api-parameters/removeStopWords/)
    pub remove_stop_words: Option<RemoveStopWords>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/camelCaseAttributes/](https://www.algolia.com/doc/api-reference/api-parameters/camelCaseAttributes/)
    pub camel_case_attributes: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/decompoundedAttributes/](https://www.algolia.com/doc/api-reference/api-parameters/decompoundedAttributes/)
    pub decompounded_attributes: Option<HashMap<String, Vec<String>>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/keepDiacriticsOnCharacters/](https://www.algolia.com/doc/api-reference/api-parameters/keepDiacriticsOnCharacters/)
    pub keep_diacritics_on_characters: Option<String>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/queryLanguages/](https://www.algolia.com/doc/api-reference/api-parameters/queryLanguages/)
    pub query_languages: Option<Vec<String>>,

    // query-strategy
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/queryType/](https://www.algolia.com/doc/api-reference/api-parameters/queryType/)
    pub query_type: Option<String>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/removeWordsIfNoResults/](https://www.algolia.com/doc/api-reference/api-parameters/removeWordsIfNoResults/)
    pub remove_words_if_no_results: Option<RemoveWordsIfNoResults>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/advancedSyntax/](https://www.algolia.com/doc/api-reference/api-parameters/advancedSyntax/)
    pub advanced_syntax: Option<bool>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/optionalWords/](https://www.algolia.com/doc/api-reference/api-parameters/optionalWords/)
    pub optional_words: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/disablePrefixOnAttributes/](https://www.algolia.com/doc/api-reference/api-parameters/disablePrefixOnAttributes/)
    pub disable_prefix_on_attributes: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/disableExactOnAttributes/](https://www.algolia.com/doc/api-reference/api-parameters/disableExactOnAttributes/)
    pub disable_exact_on_attributes: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/exactOnSingleWordQuery/](https://www.algolia.com/doc/api-reference/api-parameters/exactOnSingleWordQuery/)
    pub exact_on_single_word_query: Option<ExactOnSingleWordQuery>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/alternativesAsExact/](https://www.algolia.com/doc/api-reference/api-parameters/alternativesAsExact/)
    pub alternatives_as_exact: Option<HashSet<AlternativesAsExact>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/enableRules/](https://www.algolia.com/doc/api-reference/api-parameters/enableRules/)
    pub enable_rules: Option<bool>,

    // performance
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/numericAttributesForFiltering/](https://www.algolia.com/doc/api-reference/api-parameters/numericAttributesForFiltering/)
    pub numeric_attributes_for_filtering: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/allowCompressionOfIntegerArray/](https://www.algolia.com/doc/api-reference/api-parameters/allowCompressionOfIntegerArray/)
    pub allow_compression_of_integer_array: Option<bool>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    // advanced
    /// [https://www.algolia.com/doc/api-reference/api-parameters/attributeForDistinct/](https://www.algolia.com/doc/api-reference/api-parameters/attributeForDistinct/)
    pub attribute_for_distinct: Option<String>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/distinct/](https://www.algolia.com/doc/api-reference/api-parameters/distinct/)
    pub distinct: Option<Distinct>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/replaceSynonymsInHighlight/](https://www.algolia.com/doc/api-reference/api-parameters/replaceSynonymsInHighlight/)
    pub replace_synonyms_in_highlight: Option<bool>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/minProximity/](https://www.algolia.com/doc/api-reference/api-parameters/minProximity/)
    pub min_proximity: Option<MinProximity>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/responseFields/](https://www.algolia.com/doc/api-reference/api-parameters/responseFields/)
    pub response_fields: Option<Vec<String>>,
    #[builder(setter(into))]
    #[serde(skip_serializing_if = "Option::is_none")]
    /// [https://www.algolia.com/doc/api-reference/api-parameters/maxFacetHits/](https://www.algolia.com/doc/api-reference/api-parameters/maxFacetHits/)
    pub max_facet_hits: Option<u64>,
}