Spell Check

Check and correct spelling errors in a text.

Params

text · string · required

The text to check.

language_code · string · default: "en"

The language code of the target language to translate to. All supported language codes can be found here.

Header

x-api-key · string · required

Your JigsawStack API key

Response

success · boolean

Indicates whether the call was successful.

_usage · object

Usage information for the API call.

Show _usage

input_tokens · number

Number of input tokens processed.

output_tokens · number

Number of output tokens generated.

inference_time_tokens · number

Number of tokens processed during inference time.

total_tokens · number

Total number of tokens used (input + output).

misspellings_found · boolean

Whether any misspellings were found in the text.

misspellings · array

Array of misspelling objects found in the text.

Show Misspelling Object Properties

word · string | null

The misspelled word found in the text.

startIndex · number

The starting index position of the misspelled word in the text.

endIndex · number

The ending index position of the misspelled word in the text.

expected · string[]

Array of suggested correct spellings for the misspelled word.

auto_corrected · boolean

Whether the word was automatically corrected.

auto_correct_text · string

The auto corrected text.

If no misspellings were found, the original text is returned.

Javascript

import { JigsawStack } from "jigsawstack";

const jigsaw = JigsawStack({ apiKey: "your-api-key" });

const response = await jigsaw.validate.spellcheck({
  "text": "This sentense has a speling mistake."
})

Response

{
  "success": true,
  "misspellings_found": true,
  "misspellings": [
        {
              "word": "sentense",
              "startIndex": 5,
              "endIndex": 13,
              "expected": [
                    "sentence"
              ],
              "auto_corrected": true
        },
        {
              "word": "speling",
              "startIndex": 20,
              "endIndex": 27,
              "expected": [
                    "spelling",
                    "spewing",
                    "spieling"
              ],
              "auto_corrected": true
        }
  ],
  "auto_correct_text": "This sentence has a spelling mistake.",
  "_usage": {
        "input_tokens": 13,
        "output_tokens": 83,
        "inference_time_tokens": 1095,
        "total_tokens": 1191
  }
}