Skip to content

Commit 48fde1e

Browse files
committed
fix(specs): Separators are non-alphanumeric characters (generated)
algolia/api-clients-automation#3978 Co-authored-by: algolia-bot <[email protected]>
1 parent fa164a9 commit 48fde1e

File tree

7 files changed

+42
-21
lines changed

7 files changed

+42
-21
lines changed

src/main/scala/algoliasearch/recommend/BaseIndexSettings.scala

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,12 @@ import algoliasearch.recommend.SupportedLanguage._
106106
* specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
107107
* `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
108108
* @param separatorsToIndex
109-
* Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
110-
* characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
111-
* treats separator characters as separate words. For example, a search for `C#` would report two matches.
109+
* Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric
110+
* characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
111+
* like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
112+
* `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
113+
* With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for
114+
* \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
112115
* @param searchableAttributes
113116
* Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and
114117
* the

src/main/scala/algoliasearch/recommend/FallbackParams.scala

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,9 +201,12 @@ import algoliasearch.recommend.SupportedLanguage._
201201
* specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
202202
* `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
203203
* @param separatorsToIndex
204-
* Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
205-
* characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
206-
* treats separator characters as separate words. For example, a search for `C#` would report two matches.
204+
* Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric
205+
* characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
206+
* like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
207+
* `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
208+
* With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for
209+
* \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
207210
* @param searchableAttributes
208211
* Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and
209212
* the

src/main/scala/algoliasearch/recommend/RecommendIndexSettings.scala

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,12 @@ import algoliasearch.recommend.SupportedLanguage._
111111
* specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
112112
* `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
113113
* @param separatorsToIndex
114-
* Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
115-
* characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
116-
* treats separator characters as separate words. For example, a search for `C#` would report two matches.
114+
* Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric
115+
* characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
116+
* like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
117+
* `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
118+
* With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for
119+
* \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
117120
* @param searchableAttributes
118121
* Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and
119122
* the

src/main/scala/algoliasearch/recommend/RecommendSearchParams.scala

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,9 +201,12 @@ import algoliasearch.recommend.SupportedLanguage._
201201
* specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
202202
* `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
203203
* @param separatorsToIndex
204-
* Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
205-
* characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
206-
* treats separator characters as separate words. For example, a search for `C#` would report two matches.
204+
* Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric
205+
* characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
206+
* like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
207+
* `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
208+
* With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for
209+
* \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
207210
* @param searchableAttributes
208211
* Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and
209212
* the

src/main/scala/algoliasearch/search/BaseIndexSettings.scala

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,12 @@ import algoliasearch.search.SupportedLanguage._
110110
* specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
111111
* `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
112112
* @param separatorsToIndex
113-
* Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
114-
* characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
115-
* treats separator characters as separate words. For example, a search for `C#` would report two matches.
113+
* Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric
114+
* characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
115+
* like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
116+
* `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
117+
* With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for
118+
* \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
116119
* @param searchableAttributes
117120
* Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and
118121
* the

src/main/scala/algoliasearch/search/IndexSettings.scala

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,12 @@ import algoliasearch.search.SupportedLanguage._
116116
* specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
117117
* `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
118118
* @param separatorsToIndex
119-
* Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
120-
* characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
121-
* treats separator characters as separate words. For example, a search for `C#` would report two matches.
119+
* Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric
120+
* characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
121+
* like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
122+
* `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
123+
* With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for
124+
* \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
122125
* @param searchableAttributes
123126
* Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and
124127
* the

src/main/scala/algoliasearch/search/SettingsResponse.scala

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,12 @@ import algoliasearch.search.SupportedLanguage._
116116
* specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
117117
* `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
118118
* @param separatorsToIndex
119-
* Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
120-
* characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia
121-
* treats separator characters as separate words. For example, a search for `C#` would report two matches.
119+
* Control which non-alphanumeric characters are indexed. By default, Algolia ignores [non-alphanumeric
120+
* characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters)
121+
* like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with
122+
* `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
123+
* With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for
124+
* \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
122125
* @param searchableAttributes
123126
* Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and
124127
* the

0 commit comments

Comments
 (0)