Interface SpeechmaticsOptions

interface SpeechmaticsOptions {
    additional_vocab?: Record<string, unknown>[];
    audio_filtering_config?: Record<string, unknown>;
    diarization?: string;
    domain?: string;
    enable_entities?: boolean;
    enable_partials?: boolean;
    end_of_utterance_silence_trigger?: number;
    max_delay?: number;
    max_delay_mode?: string;
    max_speakers?: number;
    output_locale?: string;
    prefer_current_speaker?: boolean;
    punctuation_overrides?: Record<string, unknown>;
    speaker_sensitivity?: number;
    transcript_filtering_config?: Record<string, unknown>;
}

Properties

additional_vocab? audio_filtering_config? diarization? domain? enable_entities? enable_partials? end_of_utterance_silence_trigger? max_delay? max_delay_mode? max_speakers? output_locale? prefer_current_speaker? punctuation_overrides? speaker_sensitivity? transcript_filtering_config?

Properties

Optional additional_vocab

additional_vocab?: Record<string, unknown>[]

Additional vocabulary entries for custom dictionary support. RT only.

Optional audio_filtering_config

audio_filtering_config?: Record<string, unknown>

Audio filtering configuration. RT only.

Optional diarization

diarization?: string

Enable diarization for modes other than "none".

Optional domain

domain?: string

Domain to use, for example "finance".

Optional enable_entities

enable_entities?: boolean

Enable entity recognition. RT only.

Optional enable_partials

enable_partials?: boolean

Enable partial results. Default: true, overridden by the gateway.

Optional end_of_utterance_silence_trigger

end_of_utterance_silence_trigger?: number

Seconds of silence before finalizing an utterance. RT only.

Optional max_delay

max_delay?: number

Maximum delay in seconds. Valid range is 0.7-4.0. Default: 1.0. RT only.

Optional max_delay_mode

max_delay_mode?: string

Maximum delay mode. RT only.

Optional max_speakers

max_speakers?: number

Maximum number of speakers to detect.

Optional output_locale

output_locale?: string

BCP-47 locale for output formatting.

Optional prefer_current_speaker

prefer_current_speaker?: boolean

Prefer grouping nearby words as the current speaker.

Optional punctuation_overrides

punctuation_overrides?: Record<string, unknown>

Punctuation override configuration.

Optional speaker_sensitivity

speaker_sensitivity?: number

Speaker diarization sensitivity. Valid range is 0.0-1.0.

Optional transcript_filtering_config

transcript_filtering_config?: Record<string, unknown>

Transcript filtering configuration. RT only.

Settings

Member Visibility

Theme

On This Page

additional_vocabaudio_filtering_configdiarizationdomainenable_entitiesenable_partialsend_of_utterance_silence_triggermax_delaymax_delay_modemax_speakersoutput_localeprefer_current_speakerpunctuation_overridesspeaker_sensitivitytranscript_filtering_config