Invox Dictation SDK Version:

Dictionary Functions


Functions to manage the Invox Dictation Dictionary Repository. The dictionary allows users to add custom words to improve recognition.

User Dictionary

GetUserDictionary

FunctionDescriptionParametersReturns
INVOX.GetUserDictionary()Returns the user dictionary repository object.—Object
const userDict = INVOX.GetUserDictionary();

Repository methods

The repository returned by GetUserDictionary() exposes get, add, remove, and replace. Create words with INVOX.WordFactory and pass the existing word object when removing or replacing it.

const userDictionary = INVOX.GetUserDictionary();
const word = INVOX.WordFactory.create("myCustomWord", false);

await userDictionary.add(word);
const words = await userDictionary.get();
await userDictionary.remove(word);
await userDictionary.replace(word, INVOX.WordFactory.create("updatedWord", false));

Specialty Dictionary

GetSpecialtyDictionary

FunctionDescriptionParametersReturns
INVOX.GetSpecialtyDictionary()Returns the specialty dictionary repository object.—Object
const specialtyDict = INVOX.GetSpecialtyDictionary();

Repository method

The specialty dictionary is read-only and exposes get.

const specialtyDictionary = INVOX.GetSpecialtyDictionary();
const words = await specialtyDictionary.get();