Interface STTV2Options

Options specific to saarika:v2.5. saarika:v2.5 will be deprecated soon — prefer STTV3Options with saaras:v3 for new integrations. All v2.5 language codes are also supported by v3.

See

Sarvam STT API docs

interface STTV2Options {
    apiKey?: string;
    flushSignal?: boolean;
    highVadSensitivity?: boolean;
    languageCode?: string;
    model: "saarika:v2.5";
    streaming?: boolean;
    withTimestamps?: boolean;
}

Hierarchy

  • STTBaseOptions
    • STTV2Options

Properties

apiKey? flushSignal? highVadSensitivity? languageCode? model 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.

model

model: "saarika:v2.5"

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

apiKeyflushSignalhighVadSensitivitylanguageCodemodelstreamingwithTimestamps