5.00 HOW TO EDIT HEARSAY GOLD COMMANDS The Hearsay Editor is a utility program which is used to define, edit, train, load and save Hearsay Gold Vocabularies. It can also be used to erase the Hearsay Gold Library. The Hearsay Editor program is included on the Hearsay Gold system disk under the names REDT.EXE and RE.EXE. When EDITING it is wise to do so prior to loading your application into memory. However most editing features can be accomplished with your application program already loaded. CAUTION should be taken when adding new commands. Unless enough memory was set aside in the Library using MKLIB for the new commands, they may not be able to be saved while your application is loaded & the system may crash when exiting the Editor or the vocabularies in the Library may be lost. CAUTION: Adding commands from within an application and not reserving enough Library space may crash the system due to memory conflicts. 5.01 HOW TO LOAD VOCABULARIES INTO THE HEARSAY EDITOR After entering the Hearsay Editor, the load option provides for loading a vocabulary into the Edit Area for update or training. The vocabulary may be loaded into the Edit Area from a file or from the Library. When the load is complete, the new vocabulary in the Edit Area will be displayed in a layered format in the center of the screen. After selecting L (LOAD) from the Main Menu the following options are available: CANCEL - Is selected to abort the Load and return to the Main Menu. FILE - Loads a vocabulary into the Edit Area from a disk file. MEMORY - Loads the active vocabulary in the Library into the Edit Area. If there are no vocabularies in the Library, the Memory Option is unaccessible. LOADING FROM A FILE: The user is prompted to enter a vocabulary name. If the file is not in your personalized directory, (ie. that was created in SETUP)), or in any of the subdirectories defined in the current PATH, a drive or path should be specified & precede the filename. No file extension (Such as .EXE, .VOC, or .TXT) should be used. Hearsay Gold automatically appends an extension of .VOC to a filename. If the specified file is not found in your personalized or the specified directory, Hearsay Editor will print a "BAD FILENAME, VOCABULARY NOT LOADED" at the bottom of the display, and is accompanied by a beeping sound. This message means either that the name given is incorrect or the desired vocabulary file is not in your personalized directory or in the specified directory as described above. If the name was entered incorrectly, select LOAD and try again. If the name was entered correctly, try entering the drive and directory along with the vocabulary name in case the curent drive or directory is not what you think it is. For example to load a vocabulary file named MENU.VOC located on drive B in a sub-directory named ACCOUNTS of a directory named HEARSAY enter the following filename: B:\HEARSAY\ACCOUNTS\MENU NOTE: If the specified vocabulary file is found but has been corrupted, the message "BAD FILE FORMAT" is output at the bottom of the screen & a beep is heard. The probable cause of this message is a disk drive failure or a bad disk. This error can also occur by attempting to load a file which was not produced by the Hearsay Editor program. LOADING FROM MEMORY When Memory is selected the currently active vocabulary is loaded in the Edit Area. To load a vocabulary that is stored in the Library into the Edit Area you must make the desired vocabulary the current active vocabulary by bringing up the Control Window, selecting LIBRARY, and then selecting the desired vocabulary from the Library list. Then, remove the windows from the screen by pressing the "HOT KEY". TO LOAD A VOCABULARY WITHOUT AN APPLICATION LOADED: STEP ACTION 1. Type CD\HEARSAY 2. Type XXX or XXXE 3. If XXX was loaded: Type REDT or Type MKLIBXX (Where XX specifies the amount of memory to be allocated for the Library in K bytes). Then type RE. If XXXE was loaded: Bring up the Control Window by pressing the "HOT KEY" two times and move the cursor to EDITOR and press [ENTER]. 4. You will now be in the Hearsay editor. Select LOAD by moving the cursor to LOAD and pressing [ENTER], or by pressing "L". 5. Select FILE or MEMORY in the same manner as described above. 6. If FILE was selected you will be prompted in the lower left hand corner to enter the filename, type the name, [ENTER]. If MEMORY was selected the active vocabulary will be loaded. NOTE: If there is a vocabulary currently loaded, you will now be prompted for a confirmation. If you select the OVERWRITE option the currently loaded vocabulary in the Edit Area will be erased. Alternative to loading a file after entering the Hearsay Editor you may do so at the time you load the Editor at Step 3 by specifying the vocabulary name you wish to load into the Editor without any parameters (ie. /L or /EL). STEP ACTION 1. Type CD\HEARSAY 2. Type XXX or XXXE 3. Type REDT VOCABULARY NAME or Type MKLIBXX as described above then Type RE VOCABULARY NAME To load a vocabulary while your application program is loaded you may load a vocabulary into the Hearsay Editor in the following ways: IF THE RECOGNITION DRIVER XXX WAS LOADED: NOTE: Your application program must have the ability to exit to DOS in order to load the Hearsay Editor from XXX. STEP ACTION 1. Exit to DOS 2. CD\HEARSAY 3. Type RE To load a file while in the Editor see "TO LOAD FROM FILE" or "TO LOAD FROM MEMORY" below. Alternatively, at step 3, you may enter the filename of the Vocabulary you wish to load into the Editor along with the RE command. For example at STEP 3 type: RE FILENAME IF THE RECOGNITION DRIVER XXXE WAS LOADED: STEP ACTION 1. Make the vocabulary to edit the active vocabulary by bringing up the Control Window and selecting the desired vocabulary. 2. Select EDITOR from the Control Window and press [ENTER]. After selecting EDITOR the active Vocabulary will automatically be loaded into the Edit Area. To load a different file while in the Editor see "To Load From File" below. 5.02 HOW TO USE THE HEARSAY EDITOR As described in an earlier section the Hearsay Editor has two main areas, the Main Menu and the Edit Area. THE MAIN MENU The Main Menu provides access to all of the functions of the Hearsay Editor program. The Main Menu options appear across the top row of the screen display. To select an option, highlight it by pressing the space bar, direction keys, or by moving the mouse if one is in use. Then the desired option is highlighted, press the [ENTER] key. Options may also be selected in most cases by typing the letter of the command. THE EDIT AREA The center of the screen is referred to as the Edit Area. The vocabulary in the Edit Area is displayed in a layered window format. This vocabulary is modified in the Editor program, and may later be saved in a disk file, the Library, or made the active vocabulary. Also, if desired it may be erased. Modification of the vocabulary under edit will not cause a change in disk vocabulary of the same name unless a file operation is selected. THE ACTIVE VOCABULARY AND THE EDIT VOCABULARY In order to use the editing features of the Hearsay Editor program, it is important to understand the relationship between the current active vocabulary, & the vocabulary in the Editor program. The active vocabulary is the vocabulary which is currently being used by the Hearsay Recognition software. It can always be viewed by pressing the "HOT KEY" & bringing up the Vocabulary Window. Commands in this vocabulary are the ones that are currently being recognized. If you are in the Editor program, and wish to load the active vocabulary into the the Edit Area, you can do this via the LOAD, MEMORY option as described in Section 5.01. NOTE: The active vocabulary and the vocabulary under edit do not need to be the same vocabulary. When loading a vocabulary into the editor from a FILE, the vocabularies will be different. The vocabulary in the Edit Area is always displayed in the center of the screen. If this area is blank, there is not a vocabulary selected for edit. NOTE: Hearsay will ONLY recognize and execute the commands in its active vocabulary. The edit vocabulary can be used for recognition only after exiting the EDITOR program and making the Edit Vocabulary the active Vocabulary. TO SAVE THE LIBRARY In order to use Vocabularies that were loaded from within the Hearsay Editor they must be SAVED to the Library either by selecting the SAVE LIBRARY function or by exiting the Editor by selecting the QUIT operation. Upon exit from the Editor program a Vocabulary under edit is automatically SAVED to the Library if there is enough memory & is made the active vocabulary. If REDT was used to load the Editor, Library space will automatically be added. If RE was loaded then the XX in MKLIBXX operation specifies the amount of memory space in K bytes. If this limit is exceeded the vocabulary will not be loaded into the Library. If there is no space in the Library a message "NO SPACE IN LIBRARY, VOCABULARY NOT SAVED" will appear & the vocabulary is stored temporarily in the Edit Area. Once a vocabulary becomes active from the Library the EDIT Vocabulary in the Edit Area is lost. NOTE: If the Edit Vocabulary is not desired to make the active vocabulary, the Edit Area should be cleared using the ERASE option of the EDIT command in the Main Menu. This is explained in Section 5.03. 5.03 HOW TO EDIT One of the most common things you will be doing with the Hearsay Gold system, once you have become accustomed to using it, will probably be adding and editing commands to existing vocabularies. After loading your vocabulary, use the Hearsay Editor's EDIT features described below. TO EDIT: When the Hearsay Editor is loaded, select the EDIT option from the Main Menu. There are four options in the EDIT menu. They are: CANCEL VOCABULARY PARAMETERS ERASE 1. CANCEL - Returns you to Hearsay Editor without editing the vocabulary. To choose Cancel, press [ENTER]. 2. VOCABULARY - Retrains, edits the vocabulary names and command keystroke sequences. Commands may also deleted or added using this option. To choose Vocabulary, press V (VOCABULARY) or highlight it and press [ENTER]. NOTE: If the "Enter or Select" message is on screen, you can return to the Main Menu by pressing the [ESC] key or by selecting any command [by pressing the [ENTER] key], and selecting the QUIT EDIT option from the VOCABULARY Menu. TO ADD A WORD: You may now add a new command by typing its name when prompted with "Select or Enter Command Name " in the lower left portion of the screen. STEP ACTION 1. Type in the name of the new vocabulary name ending with the [ENTER] key. The name may be edited with the INS, DEL, BACKSPACE and cursor keys. 2. Hearsay will prompt you to say the name two times. At this point you can press the [SPACE BAR] to pause recognition [ENTER] to skip or [ESC] to exit. 3. Hearsay Gold will prompt you to enter the keystroke sequence. Editing is possible with the use of the [NUM LOCK] key. 4. Press [SCROLL-LOCK] to and the keystroke sequence. The new vocabulary word is installed. If we wish to enter other new words, simply repeat steps 1 through 4 as often as necessary. TO EDIT A WORD; Move the cursor and highlight the desired word and press [ENTER]. The vocabulary name will appear in the highlighted area at the bottom of the screen. The VOCABULARY EDIT menu will appear under the EDIT command box on the upper right of the screen. At the bottom left corner of your screen, above the highlighted line the keystrokes currently assigned to the selected Vocabulary name are defined. THE VOCABULARY EDIT OPTIONS AVAILABLE ARE; A. SELECT OR ADD B. TRAIN COMMAND C. CHANGE NAME D. EDIT COMMAND E. DELETE F QUIT EDIT A. SELECT OR ADD allows you to return to the EDIT Area in order to enter a new command into your vocabulary or select an existing command for modification. B. TRAIN COMMAND-allows you to retrain the VOICE TEMPLATE. Select TRAIN COMMAND by either pressing "T" or moving the cursor to TRAIN COMMAND and pressing [ENTER]. Say the word two times. At this point you can Press the [Space Bar] to Pause recognition, [ENTER] to skip this command bringing you back to the Edit Area, or [ESC] to return to the Edit Area. C. CHANGE NAME - allows the name of the currently selected Vocabularly name to be changed. Select "C" or highlight CHANGE NAME and press [ENTER]. The message "Enter New Command Name" will appear in the highlighted line and the cursor will be positioned after the message. Notice that the old vocabulary name is printed by the program. If you you wish, you may type over the name that now appears on the line, deleting any extra characters with the [DEL] key. If you wish to clear the line and start over, press the [ESC] key. The cursor keys move the cursor on the line without changing the characters on the line. The [BACKSPACE] key deletes the character to the left of the cursor position. To insert characters, press the [INS] key, move the cursor to the location where the new characters are to be inserted, & type the new chracters. Pressing the [INS] key a second time turns the insert mode off. With the insert mode off, the new characters typed will overwrite the old characters. Type the new name and press the [ENTER] key. NOTE: It is not necessary to move the cursor to the end of the line before you press [ENTER]. Since this is a new, name you will be prompted to say the name two times. A vocabulary word must be trained after the name has been changed or added. D. EDIT COMMAND - allows the keystroke sequence associated with the Vocabulary name selected to be changed. Select EDIT COMMAND by either typing "E". or moving the highlight bar with the cursor to EDIT COMMAND & pressing [ENTER]. The bottom left hand corner of the screen will display the current Keystroke Commands for that word, and the Highlight Area will prompt you to "TYPE THE COMMAND KEYSTROKES". Type in the new Command Keystroke Sequence, ending with the [SCROLL-LOCK] key. Use [NUM-LOCK] key as a backspace, if you make a typing error. NOTE: All other keys on the keyboard are legal keystrokes. Keystroke sequences may be up to 80 characters. E. DELETE - removes the selected Vocabulary word from the vocabulary file. Select DELETE by either pressing "D" or moving the highlight over DELETE, & press [ENTER]. The command will be immediately deleted. F. QUIT EDIT - Exits the Vocabulary Edit Menu and returns to the Main Menu. Press "Q" or move the highlight with the cursor over QUIT EDIT and press [ENTER]. If the Edit submenu is not on the screen you may select an arbitrary command by pressing [ENTER] then proceed to QUIT EDIT. A more convenient way to exit is to press the [ESC] key. NOTE: Editing the vocabulary will change only the copy of the vocabulary loaded into the Edit Area. When exiting the Editor, Hearsay will automatically save the file to the Library if there is space allocated for it. The disk file containing the vocabulary data is changed only if the SAVE FILE option is selected after exiting EDIT mode as described in Section 2.04. 3. PARAMETERS Used to customize several Hearsay Gold system parameters for optimum performance with individual application packages and environments. There are 7 different edit options in this menu. These options allow editing of the mouse mode, scale factors, and recognition thresholds. Customizing these parameters for particular applications are then stored with the particular vocabulary that you specify. When saved to the file these custom parameters will be loaded along with the vocabulary. To Edit the parameters, select E (EDIT) then select P (PARAMETERS). THE OPTIONS ARE: A. MOUSE CONTROL B. SPEECH RATE C. REJECTION D. DELAY COUNT E. NOISE LEVEL F. WINDOW KEY G. QUIT EDIT A. MOUSE CONTROL - The transparent mouse option should be set to "N" for "NO" unless the vocabulary is to be used with a program that does not have a mouse driver installed. Selecting "Y" for "YES" will enable the Hearsay Gold transparent mouse software. It is not necessary to set this parameter to "NO" if you do not have a mouse. If the transparent mouse mode is selected, you are prompted for horizontal and vertical scale factors. The default values (Horizontal-14, Vertical-17) are appropriate for programs (Such as word processors) that move a single character per depression of the cursor. When a mouse is used with programs such as spreadsheets where the direction keys cause movement of more than one character or line, the scale factors should be larger. We recommend that you experiment with the scale factors to find what settings are most comfortable for you. See Appendix A for detailed information on using a MOUSE. B. SPEECH RATE - Is a parameter that specifies the minimum delay or pause between commands. Hearsay will start processing a voice command when it finds the end of the word by detecting a pause or stop in speech. The SPEECH RATE specifies the time Hearsay should wait for another voice command when a pause is detected. For two or three commands the dafault setting of 17 is acceptable. For short words or numbers a setting of 8 speeds up the analysis process. Again, experiment with your own vocabularies to determine the best settings for your applications. C. REJECTION - These rejection parameters are used to customize the operation of the voice recognizer. In general it is poor practice to modify them except in cases where unsatisfactory performance is delivered by the default parameters. They are provided to accomodate unusual or unforseen environments and to provide a means for the experienced user to optimize recognition performance. The following is an explanation of these parameters. If you plan to modify them in your applications be prepared to some spend time testing and adjusting. Upon selecting REJECTION the bottom left portion of the screen will read "Separation Threshold (Default is 96) > 96". The SEPARATION THRESHOLD governs how sure Hearsay Gold needs to be that the word it heard COULD NOT have been any of the other words in the vocabulary except the one it has chosen. If a vocabulary is chosen with words that sound similiar to each other (Not a very good practice), Hearsay Gold will usually refuse to choose between the words, and beep. Some people will have more trouble with this "Rejection" than others. A lower threshold decreases a probability of making a mistake, but increases the number of words which will be rejected. A higher threshold will reduce the number of words rejected, but in some cases will cause an increase in the number of errors made. The separation threshold is an integer between 0 and 100. If you wish to keep the SEPARATION THRESHOLD at 96 (Default), press [ENTER]. The screen will now read: "Rejection Threshold (Default is 60) > 60". The REJECTION THRESHOLD is used to reject words that are outside of the currently programmed Hearsay Gold vocabulary. A low value will increase the rejection of outside words while a high value will reduce the chances of the system rejecting them. A side effect of setting the rejection threshold low is an increased probability of rejection of valid words. The rejection threshold is an integer between 0 and 100. A value of 100 will provide no rejection of outside words. NOTE: A better setting has been found to be 50 rather than the default of 60. To change type 50, [ENTER]. D. DELAY COUNT - If you select the DELAY COUNT option the bottom left hand portion of the screen will read "Recognizer Delay Count (Default is 20) >". The RECOGNIZER DELAY parameter is now automatically calculated. CAUTION: For normal operation please set to -1 by typing -1, [ENTER]. NOTE: This parameter is provided to enhance system performance with certain older screen oriented programs. If the DELAY parameter is set too low and the recognizer is active, the screen may occasionaly "Freeze" until a key is pressed. If this problem is encountered, increase the value of the parameter. If you have Linked Vocabularies, set the Delay Count the same in each of the vocabularies you have linked. E. NOISE LEVEL - This was set during SET UP. Since level setting routine is automatic you should not change the setting from this option. However, to do so select a four digit numeric level XXXX and press [ENTER]. DO NOT SELECT H,M or L. These options are no longer available. NOTE: A level setting entered from this operation is not saved even if a save file operation is performed. It can only be changed from SET UP (See Section 1) or manually from the DOS command line (See section 6). F. WINDOW KEY - Is used to changed the default Window Key (Grey +) to a different key. Upon selecting the WINDOW key option the bottom portion of the screen will read "Press New Menu Key or Enter to Keep Current Key". Press a new key to change the default setting or [ENTER] to keep the current default setting. NOTE: This is not permanently saved to the vocabulary. It is only changed until the system is unloaded. To permanently save see Section 6.00. G. QUIT EDIT - Moving the cursor over the QUIT EDIT option, and pressing [ENTER] will allow you to exit from the Menu Editor. NOTE: If problems are encountered using the system, check to make sure that the parameters have not been altered inadvertently. REMEMBER: Always try the default parameters first! 4. ERASE - Clears the vocabulary currently loaded in the Edit Area. It should be selected prior to the creation of a new vocabulary. To Erase Select E (EDIT) then E (ERASE) again. WARNING! Selection of this option will cause the loss of any training or changes to the vocabulary which have not been saved by prior execution of the SAVE command. WHEN QUITING THE EDITOR: Any changes made to the edited copy of the vocabulary will not affect the active vocabulary until you QUIT the menu program. When quitting the Editor the vocabulary in the Edit Area will be automatically SAVED to the Library if there is room in memory. Additionally this vocabulary will become the active vocabulary. If this is not a desired option, you must ERASE the Edit Area before quitting. Make sure to save the current Edit Vocabulary using the SAVE COMMAND if you have made updates, or have retrained and are loading a new vocabulary or erasing.