Interface STTOptions

interface STTOptions {
    apiKey?: string;
    baseUrl: string;
    detectLanguage: boolean;
    diarize: boolean;
    dictation: boolean;
    endpointing: number;
    fillerWords: boolean;
    interimResults: boolean;
    keyterm: string[];
    keywords: [string, number][];
    language?: string;
    mipOptOut: boolean;
    model: STTModels;
    noDelay: boolean;
    numChannels: number;
    numerals: boolean;
    profanityFilter: boolean;
    punctuate: boolean;
    redact: string | string[];
    sampleRate: number;
    smartFormat: boolean;
}

Properties

apiKey? baseUrl detectLanguage diarize dictation endpointing fillerWords interimResults keyterm keywords language? mipOptOut model noDelay numChannels numerals profanityFilter punctuate redact sampleRate smartFormat

Properties

Optional apiKey

apiKey?: string

baseUrl

baseUrl: string

detectLanguage

detectLanguage: boolean

diarize

diarize: boolean

dictation

dictation: boolean

endpointing

endpointing: number

fillerWords

fillerWords: boolean

interimResults

interimResults: boolean

keyterm

keyterm: string[]

keywords

keywords: [string, number][]

Optional language

language?: string

mipOptOut

mipOptOut: boolean

model

model: STTModels

noDelay

noDelay: boolean

numChannels

numChannels: number

numerals

numerals: boolean

profanityFilter

profanityFilter: boolean

punctuate

punctuate: boolean

redact

redact: string | string[]

Redact sensitive information from the transcription. Accepts a single value or list of values. Supported values: "pci", "numbers", "ssn", "true" (redact all). See https://developers.deepgram.com/docs/redaction for details.

sampleRate

sampleRate: number

smartFormat

smartFormat: boolean

Settings

Member Visibility

Theme

On This Page

apiKeybaseUrldetectLanguagediarizedictationendpointingfillerWordsinterimResultskeytermkeywordslanguagemipOptOutmodelnoDelaynumChannelsnumeralsprofanityFilterpunctuateredactsampleRatesmartFormat