fix(specs): Typo tolernace on words (#3968) (generated) [skip ci]

Co-authored-by: gazconroy <gazconroyster@gmail.com> Co-authored-by: Gary Conroy <gary.conroy@LON-M3P-GConroy.local> Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
algolia · Oct 14, 2024 · 542b24e · 542b24e
1 parent cd98290
commit 542b24e
Show file tree

Hide file tree

Showing 65 changed files with 105 additions and 112 deletions.
diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/FallbackParams.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/FallbackParams.cs
@@ -267,9 +267,9 @@ public FallbackParams()
   public List<string> UnretrievableAttributes { get; set; }
 
   /// <summary>
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
   /// </summary>
-  /// <value>Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
+  /// <value>Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
   [JsonPropertyName("disableTypoToleranceOnWords")]
   public List<string> DisableTypoToleranceOnWords { get; set; }
 

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendSearchParams.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendSearchParams.cs
@@ -267,9 +267,9 @@ public RecommendSearchParams()
   public List<string> UnretrievableAttributes { get; set; }
 
   /// <summary>
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
   /// </summary>
-  /// <value>Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
+  /// <value>Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
   [JsonPropertyName("disableTypoToleranceOnWords")]
   public List<string> DisableTypoToleranceOnWords { get; set; }
 

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/IndexSettings.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/IndexSettings.cs
@@ -76,9 +76,9 @@ public IndexSettings()
   public List<string> UnretrievableAttributes { get; set; }
 
   /// <summary>
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
   /// </summary>
-  /// <value>Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
+  /// <value>Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
   [JsonPropertyName("disableTypoToleranceOnWords")]
   public List<string> DisableTypoToleranceOnWords { get; set; }
 

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SettingsResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SettingsResponse.cs
@@ -76,9 +76,9 @@ public SettingsResponse()
   public List<string> UnretrievableAttributes { get; set; }
 
   /// <summary>
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. 
   /// </summary>
-  /// <value>Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
+  /// <value>Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words. </value>
   [JsonPropertyName("disableTypoToleranceOnWords")]
   public List<string> DisableTypoToleranceOnWords { get; set; }
 

diff --git a/...s/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/base_index_settings.dart b/...s/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/base_index_settings.dart
@@ -46,7 +46,7 @@ final class BaseIndexSettings {
   @JsonKey(name: r'unretrievableAttributes')
   final List<String>? unretrievableAttributes;
 
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
   @JsonKey(name: r'disableTypoToleranceOnWords')
   final List<String>? disableTypoToleranceOnWords;
 

diff --git a/clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/fallback_params.dart b/clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/fallback_params.dart
@@ -255,7 +255,7 @@ final class FallbackParams {
   @JsonKey(name: r'unretrievableAttributes')
   final List<String>? unretrievableAttributes;
 
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
   @JsonKey(name: r'disableTypoToleranceOnWords')
   final List<String>? disableTypoToleranceOnWords;
 

diff --git a/clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/index_settings.dart b/clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/index_settings.dart
@@ -98,7 +98,7 @@ final class IndexSettings {
   @JsonKey(name: r'unretrievableAttributes')
   final List<String>? unretrievableAttributes;
 
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
   @JsonKey(name: r'disableTypoToleranceOnWords')
   final List<String>? disableTypoToleranceOnWords;
 

diff --git a/...oliasearch-client-dart/packages/algoliasearch/lib/src/model/recommend_index_settings.dart b/...oliasearch-client-dart/packages/algoliasearch/lib/src/model/recommend_index_settings.dart
@@ -91,7 +91,7 @@ final class RecommendIndexSettings {
   @JsonKey(name: r'unretrievableAttributes')
   final List<String>? unretrievableAttributes;
 
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
   @JsonKey(name: r'disableTypoToleranceOnWords')
   final List<String>? disableTypoToleranceOnWords;
 

diff --git a/...goliasearch-client-dart/packages/algoliasearch/lib/src/model/recommend_search_params.dart b/...goliasearch-client-dart/packages/algoliasearch/lib/src/model/recommend_search_params.dart
@@ -255,7 +255,7 @@ final class RecommendSearchParams {
   @JsonKey(name: r'unretrievableAttributes')
   final List<String>? unretrievableAttributes;
 
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
   @JsonKey(name: r'disableTypoToleranceOnWords')
   final List<String>? disableTypoToleranceOnWords;
 

diff --git a/...nts/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/settings_response.dart b/...nts/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/settings_response.dart
@@ -99,7 +99,7 @@ final class SettingsResponse {
   @JsonKey(name: r'unretrievableAttributes')
   final List<String>? unretrievableAttributes;
 
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
   @JsonKey(name: r'disableTypoToleranceOnWords')
   final List<String>? disableTypoToleranceOnWords;
 

diff --git a/...lgoliasearch-client-dart/packages/client_recommend/lib/src/model/base_index_settings.dart b/...lgoliasearch-client-dart/packages/client_recommend/lib/src/model/base_index_settings.dart
@@ -46,7 +46,7 @@ final class BaseIndexSettings {
   @JsonKey(name: r'unretrievableAttributes')
   final List<String>? unretrievableAttributes;
 
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
   @JsonKey(name: r'disableTypoToleranceOnWords')
   final List<String>? disableTypoToleranceOnWords;
 

diff --git a/...ts/algoliasearch-client-dart/packages/client_recommend/lib/src/model/fallback_params.dart b/...ts/algoliasearch-client-dart/packages/client_recommend/lib/src/model/fallback_params.dart
@@ -255,7 +255,7 @@ final class FallbackParams {
   @JsonKey(name: r'unretrievableAttributes')
   final List<String>? unretrievableAttributes;
 
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
   @JsonKey(name: r'disableTypoToleranceOnWords')
   final List<String>? disableTypoToleranceOnWords;
 

diff --git a/...asearch-client-dart/packages/client_recommend/lib/src/model/recommend_index_settings.dart b/...asearch-client-dart/packages/client_recommend/lib/src/model/recommend_index_settings.dart
@@ -91,7 +91,7 @@ final class RecommendIndexSettings {
   @JsonKey(name: r'unretrievableAttributes')
   final List<String>? unretrievableAttributes;
 
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
   @JsonKey(name: r'disableTypoToleranceOnWords')
   final List<String>? disableTypoToleranceOnWords;
 

diff --git a/...iasearch-client-dart/packages/client_recommend/lib/src/model/recommend_search_params.dart b/...iasearch-client-dart/packages/client_recommend/lib/src/model/recommend_search_params.dart
@@ -255,7 +255,7 @@ final class RecommendSearchParams {
   @JsonKey(name: r'unretrievableAttributes')
   final List<String>? unretrievableAttributes;
 
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
   @JsonKey(name: r'disableTypoToleranceOnWords')
   final List<String>? disableTypoToleranceOnWords;
 

diff --git a/...s/algoliasearch-client-dart/packages/client_search/lib/src/model/base_index_settings.dart b/...s/algoliasearch-client-dart/packages/client_search/lib/src/model/base_index_settings.dart
@@ -46,7 +46,7 @@ final class BaseIndexSettings {
   @JsonKey(name: r'unretrievableAttributes')
   final List<String>? unretrievableAttributes;
 
-  /// Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+  /// Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
   @JsonKey(name: r'disableTypoToleranceOnWords')
   final List<String>? disableTypoToleranceOnWords;