Manage Dictionaries

After you have created and configured the dictionary file, you can use the TypeAheadManage action to modify the dictionary file. This action ensures that you do not have to restart the server when you want to update the dictionary.

Add Values

To add values to the dictionary, send a TypeAheadManage action with:

  • Mode set to Dictionary.

  • ManageMode set to Add.

  • Text set to a list of the word,score pairs that you want to add to the dictionary. Separate each pair with a semicolon. The score value is optional. If you do not add a score, the term is added with a score of zero. If you include a score, the minimum allowed score value is -230, and the maximum allowed score is 230-1.

For example:

action=TypeAheadManage&Mode=Dictionary&ManageMode=Add&Text=goal,25;gothic,5

You can also upload the changes to the dictionary in a file. The file must contain the words and scores that you want to add to the dictionary. It must have the same format as the dictionary file (see Create a Dictionary File). You upload the file by using the ManageFile parameter.

Modify Values

To modify the values in the dictionary, send a TypeAheadManage action with:

  • Mode set to Dictionary.

  • ManageMode set to Edit.

  • Text set to a list of the word,score pairs that you want to modify in the dictionary. Separate each pair with a semicolon. The score value is optional. If you do not specify a score, the existing score for the term is replaced with the default value of zero. If you include a score, the minimum allowed score value is -230, and the maximum allowed score is 230-1.

For example:

action=TypeAheadManage&Mode=Dictionary&ManageMode=Edit&Text=government,15;golf

You can also upload the changes to the dictionary in a file. The file must contain the words and scores that you want to modify in the dictionary. It must have the same format as the dictionary file (see Create a Dictionary File). You upload the file by using the ManageFile parameter.

Remove Values

To remove values to the dictionary, send a TypeAheadManage action with:

  • Mode set to Dictionary.

  • ManageMode set to Remove.

  • Text set to a list of the word,score pairs that you want to remove from the dictionary. Separate each pair with a semicolon. The score value is optional. If you include a score, the minimum allowed score value is -230, and the maximum allowed score is 230-1.

For example:

action=TypeAheadManage&Mode=Dictionary&ManageMode=Remove&Text=gold;golfer

You can also upload the changes to the dictionary in a file. The file must contain the words that you want to remove from the dictionary. It must have the same format as the dictionary file (see Create a Dictionary File). You upload the file by using the ManageFile parameter.

Save Changes to the Dictionary

When you have finished making modifications to the dictionary file, you must send another TypeAheadManage action to save those changes to disk. If you do not persist the changes, QMS continues to use your updated values for the dictionary, but if you restart the server, the changes are lost.

To save dictionary changes to disk, send a TypeAheadManage action with:

For example:

action=TypeAheadManage&Mode=Dictionary&ManageMode=Persist