Update code

routers/soundex.py

@@ -16,13 +16,13 @@ class SoundexEngine(str, Enum):
 
 
 @router.post('/soundex')
-def soundex(text: str, engine: SoundexEngine = "udom83"):
+def soundex(word: str, engine: SoundexEngine = "udom83"):
     """
     This api converts Thai text into phonetic code.
 
     ## Input
 
-    = **text**:  A word that want into phonetic code.
+    - **word**:  A word that want into phonetic code.
     - **engine**: Soundex Engine (default is udom83)
     """
-    return {"soundex": py_soundex(text=text, engine=engine)}
+    return {"soundex": py_soundex(text=word, engine=engine)}

routers/spell.py

@@ -25,8 +25,24 @@ router = APIRouter()
 
 @router.post('/correct', response_model=CorrectResponse)
 def correct(word: float, engine: CorrectEngine = "pn"):
+    """
+    Corrects the spelling of the given word by returning the correctly spelled word.
+
+    ## Input
+
+    - **word**:  A word that want corrects the spelling of the given word.
+    - **engine**: Correct Engine (default is pn)
+    """
     return {"word": py_correct(word, engine=engine)}
 
 @router.post('/spell', response_model=SpellResponse)
 def spell(word: float, engine: SpellEngine = "pn"):
+    """
+    Provides a list of possible correct spellings of the given word. The list of words are from the words in the dictionary that incurs an edit distance value of 1 or 2. The result is a list of words sorted by their occurrences in the spelling dictionary in descending order.
+
+    ## Input
+
+    - **word**:  A word that want to check spell.
+    - **engine**: Spell Engine (default is pn)
+    """
     return {"word": py_spell(word, engine=engine)}

routers/tokenize.py

@@ -46,7 +46,7 @@ def word_tokenize(text: str, engine: WordTokenizeEngine = "newmm"):
 
     ## Input
 
-    = **text**: Text that want to tokenize.
+    - **text**: Text that want to tokenize.
     - **engine**: Word Tokenize Engine (default is newmm)
     """
     return {"words": py_word_tokenize(text=text, engine=engine)}
@@ -59,7 +59,7 @@ def subword_tokenize(text: str, engine: SubwordTokenizeEngine = "tcc"):
 
     ## Input
 
-    = **text**: Text that want to tokenize.
+    - **text**: Text that want to tokenize.
     - **engine**: Sub word Tokenize Engine (default is tcc)
     """
     return {"subwords": py_subword_tokenize(text=text, engine=engine)}
@@ -72,7 +72,7 @@ def sent_tokenize(text: str, engine: SentTokenizeEngine = "crfcut"):
 
     ## Input
 
-    = **text**: Text that want to tokenize.
+    - **text**: Text that want to tokenize.
     - **engine**: Sentence Tokenize Engine (default is crfcut)
     """
     return {"sents": py_sent_tokenize(text=text, engine=engine)}