CorrectError API options (disable_/enable_): complete reference
Bareun's spell check API (CorrectError of RevisionService) lets you finely switch correction behavior on and off through RevisionConfig.
This page summarizes every RevisionConfig option, its meaning, and its default in one table.
Request structure
CorrectErrorRequest has the following fields.
| Field | Description |
|---|---|
document | The text to correct (content, language) |
encoding_type | Encoding of position offsets (NONE/UTF8/UTF16/UTF32) |
custom_dict_names | Names of the custom dictionaries to apply (the dictionary specified first takes priority) |
config | Correction behavior options (RevisionConfig) |
The 12 RevisionConfig options
All options are booleans, and the default is false. In other words, in the default state all correction features are on,
disable_* switches turn things off, and enable_* switches turn on additional features.
| Option | Meaning | Default |
|---|---|---|
disable_split_sentence | Disable sentence splitting | false |
disable_caret_spacing | Disable applying the compound noun split dictionary | false |
disable_vx_spacing | Disable word spacing for auxiliary predicates | false |
treat_as_title | Treat the text as a title | false |
enable_limited_punctuation | Use restricted punctuation | false |
disable_confusion | Disable the confusable words model | false |
enable_cleanup_whitespace | Enable whitespace cleanup | false |
disable_typo_correction | Disable typo correction | false |
enable_sentence_check | Enable sentence-level checking | false |
enable_public_term_refine | Enable public-sector term refinement suggestions (confirmation blocks) | false |
enable_contested_fix | Enable fixes that rely on style guidelines (e.g., 되세요, redundant meaning, overuse of the plural '-들') | false |
disable_bias_check | Disable confirmation blocks for derogatory expressions | false |
The difference between disable_* and enable_*
A disable_* option is a switch that turns off a correction that is on by default (turning it on means that correction is not done).
An enable_* option is a switch that turns on an additional feature that is off by default (it works only when turned on).
Both default to false, so if you leave config empty, the standard corrections (sentence splitting, word spacing, typos, confusable words, and so on) all run.
What changes when you turn an option off?
graph TD
A[CorrectError request] --> B{config option};
B -- disable_typo_correction --> C[Frequency-based typo correction off];
B -- disable_confusion --> D[Confusable word correction off];
B -- disable_caret_spacing --> E[Compound noun splitting off];
B -- disable_vx_spacing --> F[Auxiliary predicate spacing off];
B -- enable_cleanup_whitespace --> G[Remove unnecessary whitespace];
B -- enable_sentence_check --> H[Add sentence-level checks];
B -- enable_public_term_refine --> I[Public-sector term refinement suggestions];
B -- enable_contested_fix --> J[Guideline-based fixes];
B -- disable_bias_check --> K[Derogatory expression confirmation off];
- If a particular correction changes the original text in a way you did not intend, turn it off with the corresponding
disable_*. - If you need extra checks, turn on
enable_sentence_check(sentence level) orenable_cleanup_whitespace(whitespace cleanup). - Example sentences and confirmation block explanations for the sentence-level and public-sector language options are in Sentence-level and public-sector language correction.
Usage example
{
"document": { "content": "벼르고 벼러 왔던 그다음 날", "language": "ko_KR" },
"encoding_type": "UTF8",
"config": {
"disable_typo_correction": false,
"disable_confusion": false,
"enable_cleanup_whitespace": true
}
}
All defaults are false
The default of every option is false, so if you do not specify config, the standard corrections run as is.
To pick and choose behavior, specify only the options you need.
Frequently asked questions
Q. What are the defaults of the RevisionConfig options?
All 12 options are booleans and default to false. So if you leave config empty, all the standard correction features run, including sentence splitting, word spacing, typo correction, and confusable word correction.
Q. How do I turn off only typo correction or confusable word correction?
Set disable_typo_correction to true to turn off frequency-based typo correction, and set disable_confusion to true to turn off
confusable word correction.
Q. How do I turn on sentence-level checking?
Set enable_sentence_check to true to add sentence-level checking. The default is false, so it works only when turned on,
and it enables corrections that look at the whole sentence, such as subject-predicate agreement and translationese-style passives.