Interface STTV3Options

Options specific to saaras:v3 (recommended).

See

Sarvam STT API docs

interface STTV3Options {
    apiKey?: string;
    flushSignal?: boolean;
    highVadSensitivity?: boolean;
    languageCode?: string;
    mode?: string;
    model?: "saaras:v3";
    prompt?: string;
    streaming?: boolean;
    withTimestamps?: boolean;
}

Hierarchy

  • STTBaseOptions
    • STTV3Options

Properties

apiKey? flushSignal? highVadSensitivity? languageCode? mode? model? prompt? streaming? withTimestamps?

Properties

Optional apiKey

apiKey?: string

Sarvam API key. Defaults to $SARVAM_API_KEY

Optional flushSignal

flushSignal?: boolean

Enable flush signal events from server (WS only). Maps to flush_signal query param.

Optional highVadSensitivity

highVadSensitivity?: boolean

Increase VAD sensitivity (WS only). Maps to high_vad_sensitivity query param.

Optional languageCode

languageCode?: string

Language code (BCP-47). Default: 'en-IN'. Set to 'unknown' for auto-detection.

Optional mode

mode?: string

Transcription mode (v3 only). Default: 'transcribe'

Optional model

model?: "saaras:v3"

Optional prompt

prompt?: string

Conversation context to boost model accuracy

Optional streaming

streaming?: boolean

Whether to use native WebSocket streaming for stream(). Set to false to prefer non-streaming REST recognition (used by Agent via StreamAdapter + VAD). Default: true.

Optional withTimestamps

withTimestamps?: boolean

Return chunk-level timestamps in REST response

Settings

Member Visibility

Theme

On This Page

apiKeyflushSignalhighVadSensitivitylanguageCodemodemodelpromptstreamingwithTimestamps