Documentation Index

Fetch the complete documentation index at: https://docs.simular.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Class: SttModel

Defined in: index.d.ts:962 A speech-to-text model that can transcribe audio.

​

Constructors

​

Constructor

new SttModel(): SttModel

​

Returns

SttModel

​

Accessors

​

name

​

Get Signature

get name(): string

Defined in: index.d.ts:992 The wire-level model identifier sent in the request body.

Returns

string

​

Methods

​

transcribe()

transcribe(audio): string

Defined in: index.d.ts:994 Transcribe a single audio chunk and return the recognised text.

​

Parameters

audio

SamplesBuffer

​

Returns

string

---

​

availableAliases()

static availableAliases(): string[]

Defined in: index.d.ts:990 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()

static byAlias(alias): SttModel

Defined in: index.d.ts:974 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

alias

string

​

Returns

SttModel

---

​

default()

static default(): SttModel

Defined in: index.d.ts:968 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

---

​

whisperLargeV3()

static whisperLargeV3(): SttModel

Defined in: index.d.ts:984 Whisper Large V3 — highest accuracy. Convenience shim for the bundled whisper_large_v3 alias.

​

Returns

SttModel

---

​

whisperLargeV3Turbo()

static whisperLargeV3Turbo(): SttModel

Defined in: index.d.ts:979 Whisper Large V3 Turbo — fast, slightly less accurate. Convenience shim for the bundled whisper_large_v3_turbo alias.

​

Returns

SttModel