Interface STTOptions

interface STTOptions {
    apiKey?: string;
    baseUrl: string;
    bufferSizeMs: number;
    domain?: string;
    encoding: STTEncoding;
    endOfTurnConfidenceThreshold?: number;
    formatTurns?: boolean;
    keytermsPrompt?: string[];
    languageDetection?: boolean;
    maxSpeakers?: number;
    maxTurnSilence?: number;
    minTurnSilence?: number;
    prompt?: string;
    sampleRate: number;
    speakerLabels?: boolean;
    speechModel: STTModels;
    vadThreshold?: number;
}

Properties

apiKey? baseUrl bufferSizeMs domain? encoding endOfTurnConfidenceThreshold? formatTurns? keytermsPrompt? languageDetection? maxSpeakers? maxTurnSilence? minTurnSilence? prompt? sampleRate speakerLabels? speechModel vadThreshold?

Properties

Optional apiKey

apiKey?: string

baseUrl

baseUrl: string

bufferSizeMs

bufferSizeMs: number

How large each chunk of audio is before being sent to AssemblyAI, in milliseconds. Corresponds to Python's buffer_size_seconds (seconds there, ms here per this repo's time-unit convention).

Optional domain

domain?: string

encoding

encoding: STTEncoding

Optional endOfTurnConfidenceThreshold

endOfTurnConfidenceThreshold?: number

Optional formatTurns

formatTurns?: boolean

Optional keytermsPrompt

keytermsPrompt?: string[]

Optional languageDetection

languageDetection?: boolean

Optional maxSpeakers

maxSpeakers?: number

Optional maxTurnSilence

maxTurnSilence?: number

Maximum silence (ms) before end-of-turn is forced regardless of confidence.

Optional minTurnSilence

minTurnSilence?: number

Minimum silence (ms) before a confident end-of-turn is finalized.

Optional prompt

prompt?: string

Only supported with the u3-rt-pro model.

sampleRate

sampleRate: number

Optional speakerLabels

speakerLabels?: boolean

Enable speaker diarization. Note: AssemblyAI will return per-word speaker labels, but the JS framework's stt.SpeechData type does not yet expose a speakerId field (unlike the Python framework), so the labels are not currently surfaced on emitted events. Setting this to true still has effect server-side. Once the base SpeechData interface gains speaker support, #processStreamEvent should forward data.words[].speaker too.

speechModel

speechModel: STTModels

Optional vadThreshold

vadThreshold?: number

Settings

Member Visibility

Theme

On This Page

apiKeybaseUrlbufferSizeMsdomainencodingendOfTurnConfidenceThresholdformatTurnskeytermsPromptlanguageDetectionmaxSpeakersmaxTurnSilenceminTurnSilencepromptsampleRatespeakerLabelsspeechModelvadThreshold