Merge #480

480: Add support for typo tolerance customization r=bidoubiwa a=omid

It's coming after #351 PR.
I fixed the comments of the other PR here.

fixes #260 

Co-authored-by: vishalsodani <[email protected]>
Co-authored-by: Omid Rad <[email protected]>
Co-authored-by: Omid Rad <[email protected]>

Author: 3 people

.code-samples.meilisearch.yaml

@@ -293,6 +293,17 @@ update_settings_1: |-
   synonyms.insert(String::from("wolverine"), vec!["xmen", "logan"]);
   synonyms.insert(String::from("logan"), vec!["wolverine"]);
 
+  let min_word_size_for_typos = MinWordSizeForTypos {
+    one_typo: Some(4),
+    two_typos; Some(12)
+  }
+  let typo_tolerance = TypoToleranceSettings {
+    enabled: Some(true),
+    disable_on_attributes: Some(vec!["title".to_string()]),
+    disable_on_words: Some(vec![])
+    min_word_size_for_typos: Some(min_word_size_for_typos),
+  };
+
   let settings = Settings::new()
     .with_ranking_rules([
       "words",
@@ -325,7 +336,8 @@ update_settings_1: |-
       "title",
       "release_date"
     ])
-    .with_synonyms(synonyms);
+    .with_synonyms(synonyms)
+    .with_typo_tolerance(typo_tolerance);
 
   let task: TaskInfo = client
     .index("movies")
@@ -381,6 +393,48 @@ reset_pagination_settings_1: |-
     .reset_pagination()
     .await
     .unwrap();
+getting_started_typo_tolerance: |-
+  let min_word_size_for_typos = MinWordSizeForTypos {
+    one_typo: Some(5),
+    two_typos: Some(4)
+  }
+  let typo_tolerance = TypoToleranceSettings {
+    enabled: Some(true),
+    disable_on_attributes: Some(vec![]),
+    disable_on_words: Some(vec!["title".to_string()]),
+    min_word_size_for_typos: Some(min_word_size_for_typos),
+  };
+
+  let task: TaskInfo = client
+    .index("movies")
+    .set_typo_tolerance(&typo_tolerance)
+    .await
+    .unwrap();
+get_typo_tolerance_1: |-
+  let typo_tolerance: TypoToleranceSettings = client
+    .index("books")
+    .get_typo_tolerance()
+    .await
+    .unwrap();
+update_typo_tolerance_1: |-
+  let typo_tolerance = TypoToleranceSettings {
+    enabled: Some(false),
+    disable_on_attributes: None,
+    disable_on_words: None,
+    min_word_size_for_typos: None,
+  };
+
+  let task: TaskInfo = client
+    .index("books")
+    .set_typo_tolerance(&typo_tolerance)
+    .await
+    .unwrap();
+reset_typo_tolerance_1: |-
+  let task: TaskInfo = client
+    .index("books")
+    .reset_typo_tolerance()
+    .await
+    .unwrap();
 get_stop_words_1: |-
   let stop_words: Vec<String> = client
     .index("movies")
@@ -783,6 +837,90 @@ settings_guide_filterable_attributes_1: |-
     .set_settings(&settings)
     .await
     .unwrap();
+settings_guide_typo_tolerance_1: |-
+  let min_word_size_for_typos = MinWordSizeForTypos {
+    one_typo: Some(5),
+    two_typos: Some(12)
+  }
+  let typo_tolerance = TypoToleranceSettings {
+    enabled: Some(true),
+    disable_on_attributes: None,
+    disable_on_words: Some(vec!["title".to_string()]),
+    min_word_size_for_typos: Some(min_word_size_for_typos),
+  };
+
+  let settings = Settings::new()
+    .with_typo_tolerance(&typo_tolerance);
+
+  let task: TaskInfo = client
+    .index("movies")
+    .set_settings(&settings)
+    .await
+    .unwrap();
+typo_tolerance_guide_1: |-
+  let typo_tolerance = TypoToleranceSettings {
+    enabled: Some(false),
+    disable_on_attributes: None,
+    disable_on_words: None,
+    min_word_size_for_typos: None,
+  };
+
+  let task: TaskInfo = client
+    .index("movies")
+    .set_typo_tolerance(&typo_tolerance)
+    .await
+    .unwrap();
+typo_tolerance_guide_2: |-
+  let min_word_size_for_typos = MinWordSizeForTypos {
+    one_typo: Some(5),
+    two_typos: Some(12)
+  }
+  let typo_tolerance = TypoToleranceSettings {
+    enabled: Some(true),
+    disable_on_attributes: Some(vec!["title".to_string()]),
+    disable_on_words: None,
+    min_word_size_for_typos: None,
+  };
+
+  let task: TaskInfo = client
+    .index("movies")
+    .set_typo_tolerance(&typo_tolerance)
+    .await
+    .unwrap();
+typo_tolerance_guide_3: |-
+  let min_word_size_for_typos = MinWordSizeForTypos {
+    one_typo: Some(5),
+    two_typos: Some(12)
+  }
+  let typo_tolerance = TypoToleranceSettings {
+    enabled: Some(true),
+    disable_on_attributes: None,
+    disable_on_words: Some(vec!["shrek".to_string()]),
+    min_word_size_for_typos: Some(min_word_size_for_typos),
+  };
+  
+  let task: TaskInfo = client
+    .index("movies")
+    .set_typo_tolerance(&typo_tolerance)
+    .await
+    .unwrap();
+typo_tolerance_guide_4: |-
+  let min_word_size_for_typos = MinWordSizeForTypos {
+    one_typo: Some(4),
+    two_typos: Some(12)
+  };
+  let typo_tolerance = TypoToleranceSettings {
+    enabled: Some(true),
+    disable_on_attributes: Some(vec![]),
+    disable_on_words: Some(vec!["title".to_string()]),
+    min_word_size_for_typos: Some(min_word_size_for_typos),
+  };
+
+  let task: TaskInfo = client
+    .index("movies")
+    .set_typo_tolerance(&typo_tolerance)
+    .await
+    .unwrap();
 add_movies_json_1: |-
   use meilisearch_sdk::{
     indexes::*,