Check kits

Configure which engines run for a language, and which kit is the default.

A check kit is a named proofreading profile.

It defines:

• which engines run for a language

• engine options (locale, dictionaries, models)

• engine priority when results overlap

Check kits are configured per language in AppServerX.xml.

Where check kits are used

• On-premise / self-hosted: the language default check kit can be modified in the configuration.

• API / client override: you can override the default per request with the check_kit parameter.

Related:

• Check API

Default check kit behavior

Most languages ship with a single predefined kit.

Some languages ship with multiple kits.

• The usual default is lt_hs.

• If AI is installed for a language, the ai_lt_hs1 kit is typically enabled and set as default.

The default kit is defined inside the language node.

It is not a global setting.

Check kit inheritance

A check kit can inherit from another one with Parent="...".

• Parent kit settings are copied first.

• Child kit settings override the parent.

Example:

• ai_lt_hs1 inherits from lt_hs

• ai_lt_hs0 inherits from ai_lt_hs1 and disables Hunspell suggestions

Engine priority

Engines have a Priority attribute.

Higher number means higher priority.

Related:

• Engines prioritization while using AI-check kit while proofreading

Change the default check kit for a language (self-hosted)

You do it in AppServerX.xml.

You then restart AppServer.

Keep exactly one kit with Default="true" per language.

Make sure the chosen kit is Enabled="true".

1

Back up AppServerX.xml

Make a copy of AppServerX.xml before editing.

2

Edit AppServerX.xml

Open AppServerX.xml.

Find the target language:

<Language Id="en_US" Enabled="true">
  ...
  <SupportedCheckKits>
    ...
  </SupportedCheckKits>
  ...
</Language>

Inside <SupportedCheckKits>, set Default="true" on the kit you want.

Remove Default="true" from the previous default kit.

Example: switch default from lt_hs to ai_lt_hs1

<SupportedCheckKits>
  <CheckKit Name="lt_hs" Enabled="true">
    ...
  </CheckKit>

  <CheckKit Name="ai_lt_hs1" Default="true" Enabled="true" Parent="lt_hs">
    ...
  </CheckKit>
</SupportedCheckKits>

Example: switch default back to lt_hs

<SupportedCheckKits>
  <CheckKit Name="lt_hs" Default="true" Enabled="true">
    ...
  </CheckKit>

  <CheckKit Name="ai_lt_hs1" Enabled="true" Parent="lt_hs">
    ...
  </CheckKit>
</SupportedCheckKits>

If the XML becomes invalid, AppServer may fail to start.

If that happens, check AppServer logs for the exact parse error.

3

Restart AppServer

Restart AppServer to apply changes in AppServerX.xml.

To restart: stop the application, then start it again.

Use Main AppServer commands.

Related:

• Status API

• AI engine setup