Setting keys¶

Settings are strings used as keys in Session object function or method calls.

There are different categories of keys, defined by how they are used.

Configuration, Runtime, Results, Events, and Iterators are organized by concern (for example, Audio I/O or Wake word & command set). Within each group, entries are listed alphabetically. A setting that applies to more than one concern is documented once under its primary group; other groups link to that entry.

Values and Library information are short, flat lists and are not grouped this way.

Events: Use setHandler with event keys to register callback handlers for events.
Iterators: Use with forEach to loop over lists of values.
Results: Report the results of model inference.
Runtime: Inspect or alter the runtime state of Session instances.
Configuration: Change or fine-tune model behavior. Values for these keys persist in model files. You can modify these settings with the -s option in the command-line utilities.
Values: String constants that define task-types used with require, or that identify template slots.
Library information: Information about the library, rather than any specific model.

Concern groups (Configuration, Runtime, Results, Events, Iterators)

The same group names appear on every grouped page; a page omits groups that have no entries. Groups used in this reference:

Audio I/O — streams and the audio history buffer
VAD & endpointing — voice activity detection and silence handling
Wake word & command set — operating point, listen window, thresholds
LVCSR & STT — decoder tuning, grammar streams, STT vocabulary, transcription profile
Alignment & timing — sample/millisecond offsets (Results only)
NLU & SLM — intents, entities, and SLM controls
Templates & slots — slot identifiers and template loop/include behavior
Enrollment & adaptation — enrollment flow and adaptation
Push / pull execution — push buffers, duration limits, flush behavior
THF Micro DSP — export streams, target port, and conversion results for THF Micro embedded deployments
Logging & diagnostics — debug logging and profiling
Identity & metadata — task/model identity and licensing