The check command is available since the release of WebSpellChecker 5.5.4x in October 2019. It combines all available check types (spelling and grammar) of text in a single command. Command name: check Here is a list of all possible parameters and values that can be used with the check command. The list of parameters can be used and available only when spelling check is enabled. These parameters are marked with yellow color. A piece of text which will be sent for check. The text has to be in the UTF-8 encoding. Any found tags in the text will be interpreted as plain text as well. A piece of text separated in tokens that will be sent for check. The text should be presented as an array of strings. Right now each string is a token which equals one sentence. You can use either tokens or text at a time in a request. However, using text is more common. A user dictionary name which will be used during spell checking. The list of additional comma-separated words which will be used for spell checking. Ignore capitalized words. Ignore words containing numbers. Ignore words written with mixed case letters. Ignore domain names, web addresses. The minimal number of letters in the word which will be checked for spelling. E.g. if 3 is specified, the words with 2 letters and less will be ignored. A list of characters that should be considered as delimiters during spelling check. Shorten every static string JSON key name, like messages or type down to its first character, for example: A special service ID value (activation key) that has to be passed to a request query. It's obtained upon subscription to the Cloud services (paid or trial). Applicable only for the Cloud version. [] false The result is an array of objects which contains matches, where matches is also an array of objects consisting of attribute-value pairs. The table below represents the following attribute-value pairs: True if a misspelled word is present in a user dictionary. This attribute-value pair is used to indicate the application not to underline the word in UI. # Parameter Possible Values Default Value Description 1 format json The response format for output data. 2 callback A callback function name that will be used to manipulate with the JSON data received from the server. Such approach enables sharing of data bypassing same-origin policy. It can be used only along with “format=json”. 3 text 4 tokens 5 lang en_US A short code of a language which will be used for check. 6 disable_spelling false Disable the check text for spelling errors. 7 disable_grammar false Disable the check text for grammar and style problems. 8 user_dictionary 9 user_wordlist 10 custom_dictionary 11 ignore_all_caps 0 12 ignore_words_with_numbers 0 13 ignore_mixed_case 0 14 ignore_domain_names 0 15 min_word_length 3 16 custom_punctuation - 17 short_answer false 18 customerid 19 auto_lang_priorities {"en":"en_US", "es":"es_ES"} Priority of language dialect for auto-detected language code. For example, of auto-detect returns "en", then American English will be used as a language for check. 20 disable_style_guide false Disabling style guide functionality starting WebSpellChecker v.5.29.0.0 21 disabled_rules [] Disabling specific grammar rules IDs starting WebSpellChecker v.5.29.0.0 22 disabled_categories Disabling specific grammar rules categories starting WebSpellChecker v.5.29.0.0 23 enforce_ai To replace the classic algorithmic engines with an AI-powered engine starting WebSpellChecker v.5.25.0.0. It only works along with American, British, Canadian and Australian English. Response Structure
Attribute Type Value Description type string Type of the problem found. offset number Start position of a problem found in a sentence/text; start position value here equals '0'’. length number The length of offset from the beginning of the error; offset here is the beginning of error related to sentence/text plus the length of the error. ud boolean suggestions array of strings Suggested corrections for spelling, grammar or style problem. rule string A short description of the problem by rule; available only for type 'grammar'. message string Description of the problem; available only for type 'grammar'. {
"result": [
{
"matches": [
{
"type": "spelling",
"offset": X1,
"length": Y1,
"ud": true,
"suggestions": ["..."]
}
]
}
]
}
{
"result": [
{
"matches": [
{
"type": "grammar",
"offset": X2,
"length": Y2,
"rule": "...",
"message": "...",
"suggestions": ["..."]
}
]
}
]
}
Avoid using # and & symbols in the text.
Type: Spelling
Type: Grammar
