spelling.suggestion_sources

Background

This option defines the sources of spelling suggestions such as annotations, document titles and the corpus lexicon. The default is to use annotations, document titles and the corpus lexicon.

Sources

Sources are specified using the following character codes, as a comma separated list within square brackets:

  • @: Use the annotation index

  • %: Use un-fielded words from the lexicon

  • [METADATA_CLASS]: Use words from the given metadata classes. If no fields are listed, [@,%] is assumed.

Setting the key

Set this configuration key in the search package or data source configuration.

Use the configuration key editor to add or edit the spelling.suggestion_sources key, and set the value. This can be set to any valid List<String> value.

Default value

By default, spelling suggestions are sources from the annotation index, un-fielded words from the lexicon and the t metadata class (all document title metadata).

spelling.suggestion_sources=[@,t,%]

Examples

Change to only use the corpus lexicon only:

spelling.suggestion_sources=[%]

Include some custom metadata fields:

spelling.suggestion_sources=[@,t,s,a]