Skip to main content

Constructor

Returns

SttModel

Properties

string
required
The wire-level model identifier sent in the request body.

Methods

availableAliases()

Every STT model alias accepted by byAlias on this machine, deduplicated and sorted alphabetically. Use to discover what aliases the loaded config (bundled defaults plus any user provider files) advertises.

Returns

string[]

byAlias()

Resolve a model alias against the loaded config (e.g. "whisper_large_v3_turbo", "whisper_large_v3", or any alias declared by a user provider). Throws if the alias is unknown.

Parameters

string
required

Returns

SttModel

checkAuth()

Check that the API key works. Throws if it doesn’t. Call right after creating the model so a bad key fails fast, before any UI automation has had a chance to steal focus:

default()

First STT model advertised by the first STT provider in the loaded config. Throws if no provider in the loaded config advertises an STT service.

Returns

SttModel

transcribe()

Transcribe a single audio chunk and return the recognised text.

Parameters

SamplesBuffer
required

Returns

string

whisperLargeV3()

Whisper Large V3 — highest accuracy. Convenience shim for the bundled whisper_large_v3 alias.

Returns

SttModel

whisperLargeV3Turbo()

Whisper Large V3 Turbo — fast, slightly less accurate. Convenience shim for the bundled whisper_large_v3_turbo alias.

Returns

SttModel