Spell Check API v2

From Memsource
Jump to: navigation, search

Check

action: api/v2/spellCheck/check
    token                    string
    lang                     lang
    text                     list(string)
    referenceText            list(string)                     O
    zeroLengthSeparator      string                           O

response: JSON
   [
     {
       "text":"hello",
       "misspelledWords":[]
     },
     {
       "text":"World",
       "misspelledWords":[]
     },
     {
       "text":"foox hella",
       "misspelledWords":[
         {
           "word":"foox",
           "offset":0
         },
         {
           "word":"hella",
           "offset":5
         }
       ]
     }
   ]

error codes
    LanguageNotSupported

Check By Task

action: api/v2/spellCheck/checkByTask
    token                    string
    task                     task
    lang                     lang
    text                     list(string)
    referenceText            list(string)                     O
    zeroLengthSeparator      string                           O

response: see spellCheck/check

Suggest

action: api/v2/spellCheck/suggest
    token                    string
    lang                     lang
    word                     list(string)
    referenceText            list(string)                     O

response: JSON
   [
     {
       "word":"hella",
       "suggestions":[
         {
           "word":"hello",
           "distance":1
         },
         {
           "word":"Vella",
           "distance":1
         },
         {
           "word":"hells",
           "distance":1
         },
         {
           "word":"Sella",
           "distance":1
         },
         {
           "word":"hell",
           "distance":1
         },
         {
           "word":"Bella",
           "distance":1
         },
         {
           "word":"Mella",
           "distance":1
         },
         {
           "word":"hell a",
           "distance":1
         },
         {
           "word":"Della",
           "distance":1
         },
         {
           "word":"fella",
           "distance":1
         },
         {
           "word":"Heall",
           "distance":3
         }
       ]
     },
     {
       "word":"Warld",
       "suggestions":[
         {
           "word":"Wared",
           "distance":1
         },
         {
           "word":"Ward",
           "distance":1
         },
         {
           "word":"Wald",
           "distance":1
         },
         {
           "word":"World",
           "distance":1
         },
         {
           "word":"Warlord",
           "distance":2
         }
       ]
     }
   ]

Add Word

action: api/v2/spellCheck/addWord
    token                    string
    lang                     lang
    word                     string

response: empty