On this page
Search API Spellcheck
The Search API Spellcheck module offers spell-checked suggestions for variants of the current search query. This feature is sometimes known as Did You Mean (DYM), or Suggesters.
This guide was tested with Search API Spellcheck version 4.0.1, but may work with earlier or later versions of the module as well.
At time-of-writing, Search API Spellcheck version 4 only supports a search UI built with Views. If you use a different search UI, consider contributing support!
Installing
Install as you would normally install a contributed Drupal module.
Configure
To start, you'll need to add a field to your Index with the data type set to Elasticsearch Spellcheck.
This will invalidate the content of the index, forcing you to re-index.
You will then need to add either a Search API Spellcheck "Did You Mean" or a Search API Spellcheck "Suggestions" views area plugin to your search view's Header, Footer, or No results behavior.
The default settings appear to work as a good starting point.
Help improve this page
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion
