Settings Files

This page describes all of the settings files. Read the YAML page before reading this page. While reading this page, you should look at the default settings files, to help understand how the settings are structured.

General Settings

General application settings are found in the config\settings.yaml file found in the application directory. This file has the following settings:

Setting	Type	Description
`licenseKey`	String	The license key for the Utterly Voice Application. See Setup.
`microphoneThreshold`	Number	Microphone utterance threshold. See Setup.
`utteranceGapMilliseconds`	Number	Minimum duration of silence that defines the gap between utterances. See Setup.
`recognizer`	String	The recognizer to use for speech recognition. See Recognizers.
`googleV1RecognizerConfig`	Map Collection	Settings specific for the Google Speech-to-Text V1 recognizer. See Recognizers.
`voskRecognizerConfig`	Map Collection	Settings specific for the Vosk recognizer. See Recognizers.
`deepgramRecognizerConfig`	Map Collection	Settings specific for the Deepgram recognizer. See Recognizers.
`argumentCompletion`	String	Some commands accept the remainder of the utterance as arguments. If you would like to complete the command arguments, so you can keep speaking without pause, say this word after the final argument. For example, if this field is set to "stop", saying "title hello world stop test" results in "Hello World test".
`caseChangeUpper`	String	Some commands accept utterance arguments that initialize or change case for utterance arguments that follow it. For example, if this field is set to "upper", saying "snake upper hello world" results in "HELLO_WORLD".
`caseChangeLower`	String	Some commands accept utterance arguments that initialize or change case for utterance arguments that follow it. For example, if this field is set to "lower", saying "upper hello lower world" results in "Hw".

Number Settings

Number settings are found in the config\numbers.yaml file found in the application directory. See the Numbers page for a description of these settings.

Mode Settings

Mode settings files are found in the config\modes directory found in the application directory. Each mode has its own settings file. To add a mode to your settings, simply create a mode YAML file and put it in this directory. You can name these files anything you like, but use a file suffix of .yaml. A mode has the following settings:

Setting	Type	Description
`name`	String	The name of the mode. Choose a name that is easy to recognize, so you can easily use the "activate mode" and "deactivate mode" commands.
`alternates`	List Collection	An optional list of additional string phrases that will match this mode name when using the "activate mode" or "deactivate mode" commands. This is helpful when a recognizer consistently fails to recognize a mode name.
`description`	String	A description of the mode. This text will appear in the content when you say "open help".
`initiallyActive`	Boolean	If true, this mode will be automatically active when the application starts.
`exclusive`	Boolean	If true, this mode is an exclusive mode.
`biases`	List Collection	You can use this optional setting to control recognition bias for certain phrases while the mode is active. See Bias.
`commands`	List Collection	The list of commands that are available when the mode is active. See Commands below.

Commands

Every mode has a list of commands. Each command has the following settings:

Setting	Type	Description
`name`	String	The spoken name for the command.
`description`	String	The command description. This text will appear in the content when you say "open help".
`biasFactor`	Number	This is used to control recognition bias for this command name. See Bias.
`alternates`	List Collection	A list of additional string phrases that will trigger this command. This is helpful when a recognizer consistently fails to recognize a command name.
`functions`	List Collection	This is a list of functions that should be called for this command. Functions define the actions that are taken for this command. See Functions.
`spaceLeft`	Boolean	When the auto-spacing interpreter state is on, and this optional field is set to true, Utterly Voice will insert a space character on the left of any text typed by this command. This does not apply if the command is the first thing in the utterance. The default value of this field is false.
`spaceRight`	Boolean	This is similar to spaceLeft, except it adds space on the right side of the command output. This does not apply if the command is the last thing in the utterance. If there is a another command immediately after this command in the utterance, the spaceLeft value of the other command overrides this spaceRight value. In addition, auto-spacing never inserts two space characters between consecutive command outputs. The default value of this field is false.

❮ YAML Bias ❯