Skip to content

Fix/alternatives as exact #3977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Fix/alternatives as exact #3977

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d9c5bb
fix(specs): alternativesAsExact is plurals and synonyms
Oct 15, 2024
61212d8
fix(specs): Separators are non-alphanumeric characters
Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions specs/common/schemas/IndexSettings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -618,16 +621,22 @@ indexSettingsAsSearchParams:
items:
$ref: '#/alternativesAsExact'
description: |
Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.
Determine which plurals and synonyms should be considered an exact matches.

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.
For example:

- "swimsuit" and "swimsuits" are treated the same
- "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)).

- `ignorePlurals`.
Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.

- `singleWordSynonym`.
Single-word synonyms, such as "NY/NYC" are considered exact matches.
Single-word synonyms, such as "NY" = "NYC", are considered exact matches.

- `multiWordsSynonym`.
Multi-word synonyms, such as "NY/New York" are considered exact matches.
Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
default: [ignorePlurals, singleWordSynonym]
x-categories:
- Query strategy
Expand Down
Loading