NativeSTTConfig

Configuration options for the NativeSTT provider.

Defined in: src/providers/stt/native/NativeSTT.ts:96

Configuration options for the NativeSTT provider.

Remarks

Extends STTProviderConfig with settings specific to the browser’s SpeechRecognition API.

Example

const config: NativeSTTConfig = {
  language: 'en-US',
  continuous: true,
  interimResults: true,
  maxAlternatives: 1,
  startTimeout: 5000,
};

Extends

STTProviderConfig

Properties

Property	Type	Default value	Description	Inherited from	Defined in
`apiKey?`	`string`	`undefined`	API key or authentication token for the provider. Remarks For client-side usage, consider using a proxy server to keep API keys secure. The SDK provides Express, Next.js, and Node adapters for this purpose.	`STTProviderConfig`.`apiKey`	src/core/types/providers.ts:67
`continuous?`	`boolean`	`true`	Enable continuous recognition so the browser keeps listening after each utterance ends.	-	src/providers/stt/native/NativeSTT.ts:102
`debug?`	`boolean`	`false`	Whether to enable debug logging for this provider. Remarks When `true`, the provider emits detailed internal logs. This is separate from the SDK-level LoggingConfig.	`STTProviderConfig`.`debug`	src/core/types/providers.ts:86
`endpoint?`	`string`	`undefined`	Custom endpoint URL to override the provider’s default API endpoint. Remarks Useful for self-hosted instances, proxy servers, or development environments.	`STTProviderConfig`.`endpoint`	src/core/types/providers.ts:75
`interimResults?`	`boolean`	`undefined`	Whether to enable interim (partial) transcription results. Remarks When `true`, the provider emits results as the user speaks, before the utterance is complete. Only applicable to live/WebSocket providers.	`STTProviderConfig`.`interimResults`	src/core/types/providers.ts:352
`keywords?`	`string`[]	`undefined`	Custom vocabulary or keyword phrases to boost recognition accuracy. Remarks Useful for domain-specific terminology, product names, or proper nouns that the model might not recognize well by default.	`STTProviderConfig`.`keywords`	src/core/types/providers.ts:366
`language?`	`string`	`undefined`	Language code for transcription. Remarks Uses BCP 47 language tags (e.g., `'en-US'`, `'es-ES'`, `'fr-FR'`). The supported languages depend on the provider and model.	`STTProviderConfig`.`language`	src/core/types/providers.ts:335
`maxAlternatives?`	`number`	`1`	Maximum number of alternative transcriptions the browser should return per recognition result.	-	src/providers/stt/native/NativeSTT.ts:108
`model?`	`string`	`undefined`	Model to use for transcription. Remarks Provider-specific model identifier (e.g., `'nova-3'` for Deepgram).	`STTProviderConfig`.`model`	src/core/types/providers.ts:343
`punctuation?`	`boolean`	`undefined`	Whether to enable automatic punctuation in transcription results.	`STTProviderConfig`.`punctuation`	src/core/types/providers.ts:357
`startTimeout?`	`number`	`5000`	Maximum milliseconds to wait for the recognition `start` event after calling start(). If the browser does not fire `onstart` within this window, connect() rejects.	-	src/providers/stt/native/NativeSTT.ts:114
`timeout?`	`number`	`undefined`	Request timeout in milliseconds. Remarks Applies to HTTP requests (REST providers) and connection establishment (WebSocket providers). Set to `0` for no timeout.	`STTProviderConfig`.`timeout`	src/core/types/providers.ts:95