---
source_path: "api/setting-keys/index.md"
canonical_url: "https://doc.sensory.com/tnl/7.8/api/setting-keys/"
---

# Setting keys

Settings are strings used as keys in [Session](https://doc.sensory.com/tnl/7.8/api/inference.md#session) object function or method calls.

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

[Configuration](https://doc.sensory.com/tnl/7.8/api/setting-keys/configuration.md#configuration), [Runtime](https://doc.sensory.com/tnl/7.8/api/setting-keys/runtime.md#runtime), [Results](https://doc.sensory.com/tnl/7.8/api/setting-keys/results.md#results), [Events](https://doc.sensory.com/tnl/7.8/api/setting-keys/events.md#events), and [Iterators](https://doc.sensory.com/tnl/7.8/api/setting-keys/iterators.md#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](https://doc.sensory.com/tnl/7.8/api/setting-keys/values.md#values) and [Library information](https://doc.sensory.com/tnl/7.8/api/setting-keys/library-information.md#library-information) are short, flat lists and are not
grouped this way.

[Events](https://doc.sensory.com/tnl/7.8/api/setting-keys/events.md#events)

- Use [setHandler](https://doc.sensory.com/tnl/7.8/api/inference.md#sethandler) with event keys to register callback handlers for events.

[Iterators](https://doc.sensory.com/tnl/7.8/api/setting-keys/iterators.md#iterators)

- Use with [forEach](https://doc.sensory.com/tnl/7.8/api/inference.md#foreach) to loop over lists of values.

[Results](https://doc.sensory.com/tnl/7.8/api/setting-keys/results.md#results)

- Report the results of model [inference](https://doc.sensory.com/tnl/7.8/api/inference.md#inference).

[Runtime](https://doc.sensory.com/tnl/7.8/api/setting-keys/runtime.md#runtime)

- Inspect or alter the runtime state of [Session](https://doc.sensory.com/tnl/7.8/api/inference.md#session) instances.

[Configuration](https://doc.sensory.com/tnl/7.8/api/setting-keys/configuration.md#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](https://doc.sensory.com/tnl/7.8/api/setting-keys/values.md#values)

- String constants that define [task-types](https://doc.sensory.com/tnl/7.8/api/setting-keys/configuration.md#task-type) used with [require](https://doc.sensory.com/tnl/7.8/api/inference.md#require),
  or that identify template [slots](https://doc.sensory.com/tnl/7.8/api/setting-keys/configuration.md#slot).

[Library information](https://doc.sensory.com/tnl/7.8/api/setting-keys/library-information.md#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](https://doc.sensory.com/tnl/7.8/api/setting-keys/results.md#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

<!-- Reference definitions from includes/links.md -->
[THF Micro]: https://doc.sensory.com/thf-micro/ "THF Micro documentation"

<!-- Abbreviation definitions from includes/abbreviations.md -->
*[API]: Application Programming Interface
*[LVCSR]: Large Vocabulary Continuous Speech Recognition model, feed-forward neural net acoustic model with FST decoder
*[NLU]: Natural Language Understanding model
*[SLM]: Generative Small Language Model
*[STT]: Speech To Text: transformers with language model and CTC decoding
*[THF]: TrulyHandsfree, Sensory's wake word and command recognition technology
*[TNL]: TrulyNatural, Sensory's large-vocabulary speech recognition technology
*[VAD]: Voice Activity Detector