Skip to content

Commit dcb35e5

Browse files
Gary ConroyGary Conroy
authored andcommitted
fix(specs): Separators are non-alphanumeric characters
1 parent 3899bf3 commit dcb35e5

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

specs/common/schemas/IndexSettings.yml

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -212,12 +212,15 @@ baseIndexSettings:
212212
type: string
213213
example: +#
214214
description: |
215-
Controls which separators are indexed.
215+
Control which non-alphanumeric characters are indexed.
216+
217+
By default, Algolia ignores [non-alphanumeric 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) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`).
218+
To include such characters, define them with `separatorsToIndex`.
216219
217220
Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
218-
By default, separator characters aren't indexed.
221+
219222
With `separatorsToIndex`, Algolia treats separator characters as separate words.
220-
For example, a search for `C#` would report two matches.
223+
For example, in a search for "Disney+", Algolia considers "Disney" and "+" as two separate words.
221224
default: ''
222225
x-categories:
223226
- Typos
@@ -618,16 +621,22 @@ indexSettingsAsSearchParams:
618621
items:
619622
$ref: '#/alternativesAsExact'
620623
description: |
621-
Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.
624+
Determine which plurals and synonyms should be considered an exact matches.
625+
626+
By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching.
627+
For example:
628+
629+
- "swimsuit" and "swimsuits" are treated the same
630+
- "swimsuit" and "swimwear" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
622631
623632
- `ignorePlurals`.
624633
Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.
625634
626635
- `singleWordSynonym`.
627-
Single-word synonyms, such as "NY/NYC" are considered exact matches.
636+
Single-word synonyms, such as "NY" = "NYC", are considered exact matches.
628637
629638
- `multiWordsSynonym`.
630-
Multi-word synonyms, such as "NY/New York" are considered exact matches.
639+
Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
631640
default: [ignorePlurals, singleWordSynonym]
632641
x-categories:
633642
- Query strategy

0 commit comments

Comments
 (0)