The check command was released in October 2019 as part of WebSpellChecker 5.5.4x. It combines all available check types (spelling and grammar) of text in a single command.
Command name: check |
https://your_host_name:443/virtual_directory/api? |
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 is available only when a spelling check is enabled. These parameters are marked yellow. |
# | Parameter | Possible values | Default value | Description | |
---|---|---|---|---|---|
1 | format |
| json | The parameter sets a response format for output data. | |
2 | callback |
| The parameter specifies a callback function name that will be used to manipulate the JSON data received from the server. Such an approach enables sharing of data, bypassing same-origin policy. It can be used only along with “format=json”. | ||
3 | text |
| The parameter defines a 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 plan text as well. Note, that you shouldn't use # and & symbols in the text. | ||
4 | tokens |
| The parameter defines a text separated into 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.
| ||
5 | lang | en_US | The parameter sets a short code of a language which will be used for check. | ||
6 | disable_spelling |
| false | The parameter regulates whether to check text for spelling errors. | |
7 | disable_grammar |
| false | The parameter regulates whether to check text for grammar and style problems. | |
8 | user_dictionary |
| The parameter specifies a user dictionary name which will be used during check spelling. | ||
9 | user_wordlist |
| The parameter provides the list of additional comma-separated words which will be used for spell checking. | ||
10 | custom_dictionary |
| The parameter specifies global custom dictionary IDs which can be used during check spelling.
| ||
11 | ignore_all_caps |
| 0 | The parameter regulates whether to ignore capitalized words or not. | |
12 | ignore_words_with_numbers |
| 0 | The parameter regulates whether to ignore words containing numbers or not. | |
13 | ignore_mixed_case |
| 0 | The parameter regulates whether to ignore words written with mixed case letters or not. | |
14 | ignore_domain_names |
| 0 | The parameter regulates whether to ignore domain names, web addresses or not. | |
15 | min_word_length |
| 3 | The parameter specifies 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. | |
16 | custom_punctuation |
| - | The parameter defines a list of characters that should be considered as delimiters during spelling check. | |
17 | short_answer |
| false | The parameter is responsible for shortening every static string JSON key name, like messages or type, down to its first character, like:
|
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:
Attribute | Type | Value | Description |
---|---|---|---|
type | string |
| |
offset | number | ||
length | number | ||
ud | boolean |
| |
suggestions | array of strings |
{ "result": [ { "matches": [ { "type": "spelling", "offset": X1, "length": Y1, "ud": true, "suggestions": ["..."] } ] } ] } |
{ "result": [ { "matches": [ { "type": "grammar", "offset": X2, "length": Y2, "rule": "...", "message": "...", "suggestions": ["..."] } ] } ] } |
http(s)://server_entry_point/?cmd=check&text=this sampl text demonstrates the work of the Web API service.&lang=en_US&format=json |
Parameters:
Command: check
Text: this sampl text demonstrates the work of the Web API service.
Language: en_US
Format: json
Request Response:
{ "result": [ { "matches": [ { "type": "spelling", "offset": 5, "length": 5, "suggestions": [ "sample", "sampled", "sampler", "samples", "ample", "amply", "scamp", "stamp" ] }, { "type": "grammar", "offset": 0, "length": 4, "rule": "UPPERCASE_SENTENCE_START", "message": "This sentence does not start with an uppercase letter", "suggestions": [ "This" ] } ] } ] } |
http(s)://server_entry_point/?cmd=check&text=this sampl text demonstrates the work of the Web API service.&lang=en_US&format=xml |
Parameters:
Request Response:
<result> <result> <matches> <matches> <type>spelling</type> <offset>5</offset> <length>5</length> <suggestions> <suggestions>sample</suggestions> <suggestions>sampled</suggestions> <suggestions>sampler</suggestions> <suggestions>samples</suggestions> <suggestions>ample</suggestions> <suggestions>amply</suggestions> <suggestions>scamp</suggestions> <suggestions>stamp</suggestions> </suggestions> </matches> <type>grammar</type> <offset>0</offset> <length>4</length> <rule>UPPERCASE_SENTENCE_START</rule> <message>This sentence does not start with an uppercase letter</message> <suggestions> <suggestions>This</suggestions> </suggestions> </matches> </result> </result> |
https://server_entry_point/?cmd=check&tokens=["this sampl text.", " It demonstrate the work of the Web API service."]&lang=en_US |
Parameters:
Command: check
Tokens: ["this sampl text.", " It demonstrate the work of the Web API service."]
Language: en_US
Format: json
Request Response:
{ "result": [ { "matches": [ { "type": "spelling", "offset": 5, "length": 5, "suggestions": [ "sample", "sampled", "sampler", "samples", "ample", "amply", "scamp", "stamp" ] }, { "type": "grammar", "offset": 0, "length": 4, "rule": "UPPERCASE_SENTENCE_START", "message": "This sentence does not start with an uppercase letter", "suggestions": [ "This" ] } ] }, { "matches": [ { "type": "grammar", "offset": 4, "length": 11, "rule": "IT_VBZ", "message": "Did you mean demonstrates?", "suggestions": [ "demonstrates" ] } ] } ] } |
https://server_entry_point/?cmd=check&tokens=["this sampl text.", " It demonstrate the work of the Web API service."]&lang=en_US&short_answer=true |
Parameters:
Command: check
Tokens: ["this sampl text.", " It demonstrate the work of the Web API service."]
Language: en_US
Format: json
Request Response:
{ "r": [ { "m": [ { "t": "spelling", "o": 5, "l": 5, "s": [ "sample", "sampled", "sampler", "samples", "ample", "amply", "scamp", "stamp" ] }, { "t": "grammar", "o": 0, "l": 4, "r": "UPPERCASE_SENTENCE_START", "m": "This sentence does not start with an uppercase letter", "s": [ "This" ] } ] }, { "m": [ { "t": "grammar", "o": 4, "l": 11, "r": "IT_VBZ", "m": "Did you mean demonstrates?", "s": [ "demonstrates" ] } ] } ] } |
Here we use the same request and parameters as described in example 1.1 but form it as a POST request.
https://server_entry_point/? |
cmd=check&text=this sampl text demonstrates the work of the Web API service.&lang=en_US&format=json |
Request Response:
{ "result": [ { "matches": [ { "type": "spelling", "offset": 5, "length": 5, "suggestions": [ "sample", "sampled", "sampler", "samples", "ample", "amply", "scamp", "stamp" ] }, { "type": "grammar", "offset": 0, "length": 4, "rule": "UPPERCASE_SENTENCE_START", "message": "This sentence does not start with an uppercase letter", "suggestions": [ "This" ] } ] } ] } |