diff --git a/specs/common/schemas/IndexSettings.yml b/specs/common/schemas/IndexSettings.yml index 898a0f9c89..396c7b69e1 100644 --- a/specs/common/schemas/IndexSettings.yml +++ b/specs/common/schemas/IndexSettings.yml @@ -212,12 +212,15 @@ baseIndexSettings: type: string example: +# description: | - Controls which separators are indexed. + Control which non-alphanumeric characters are indexed. + + 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 (`(`,`)`). + To include such characters, define them with `separatorsToIndex`. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. - By default, separator characters aren't indexed. + With `separatorsToIndex`, Algolia treats separator characters as separate words. - For example, a search for `C#` would report two matches. + For example, in a search for "Disney+", Algolia considers "Disney" and "+" as two separate words. default: '' x-categories: - Typos