Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Small updates

Starting the WebSpellChecker Server With package version 5.6.3.0, we added the ability to enable n-gram data sets to sets in the grammar engine to detect errors with words that are often confused, like their and there. This option is available for the English. The n-gram data sets are available for the group of English dialects, German, French, Spanish, and Dutch languages. 

Due to a considerable increase in minimal hardware requirements and a moderate increase in quality, n-grams are not included by default in the standard packages. However, if you still prefer to make use of this option, this guide will help you to setup n-grams for your on-premises installation.

Tip
  • The n-gram data sets are available for the group of English dialects, German, French, Spanish, and Dutch languages
  • Overall, improvement in the grammar checking accuracy is fairly low (from 0.3% to 1.8%). The result depends a lot on the size of the n-gram data set. The larger the data set, the better the result.
  • There is a side effect to having larger data sets. The larger the data, the slower the response time and higher the requirements for hardware (specifically the SSD).

1. Download and unzip n-gram data sets

Contact our support team to get the links to download the latest n-gram data sets for required language(s). . To enable n-gram data sets, you need to perform the steps described in this guide.

Note

N-gram data sets take 2.4-14.3 GB space depending on the chosen language. Please make sure you have a fast SSD.

...

2. Stop AppServer

Before It is recommended to stop AppServer before making any changes to the AppServerX.xml file, it is recommended to stop AppServer.

...

3. Specify path to n-gram data sets in AppServer configuration file

  • Open the AppServerX.xml configuration file for editing. 
Info

The default path to the AppServerX.xml file: <WebSpellChecker_Installation_Path>/AppServer/AppServerX.xml

  • Find section with the PathToNgramData parameter which is responsible for enabling and configuration of n-gram data sets:. PathToNgramData.
Code Block
languagexml
themeEmacs
titleAppServerX.xml
<!-- Path to n-gram data sets. Can be used to improve grammar quality. -->
<!-- <PathToNgramData></PathToNgramData>-->

...

Code Block
languagexml
themeEmacs
titleAppServerX.xml
<Language Id="en_US">
	<Alias>en</Alias>
	<Alias>am</Alias>
	<GrammarCheckProviderOptions>en-US</GrammarCheckProviderOptions>
	<EnableNgramData>true</EnableNgramData>
	<ThesaurusEnabled>true</ThesaurusEnabled>
		<SpellEngineOptions>
		<Locale>am</Locale>
		<SpellCheckProvider>ssce</SpellCheckProvider>
		<Dictionary FullPath="ssceam2.clx">
			<ForSuggest>no</ForSuggest>
		</Dictionary>
		<Dictionary FullPath="ssceam2s.clx">
			<ForSuggest>yes</ForSuggest>
		</Dictionary>
		<Dictionary FullPath="sscema2.clx"/>
		<Dictionary FullPath="keywords.clx"/>
		<Dictionary FullPath="ssceam.tlx"/>
	</SpellEngineOptions>
</Language>

...

4. Start AppServer

As soon as you made the nesessary actions to enable n-gram data sets in AppServerX.xml, start AppServer for the changes to take effect.

...