Skip to main content

Recognition parameter list

These parameters can only be set while the recognizer is not running.

This is not an exhaustive list of parameters available in Whisper. Only the most important ones are exposed here. If necessary, this list will be updated.

Set Recognition Parameters​

Sets the parameters for speech recognition. If you want to change only specific parameters, consider using the individual setter functions.

Set Streaming Defaults​

Sets the default parameters suitable for streaming speech recognition.

Set Non Streaming Defaults​

Sets the default parameters suitable for non-streaming speech recognition.

Set Num Of Threads​

Sets the number of threads to use for speech recognition. Set this value to 0 to use the number of cores.

Set Language​

Sets the language to use for speech recognition. Must be supported by the selected language model in the Editor settings.

Setting the language to Auto will decrease the recognition accuracy and performance.

Set Translate To English​

Sets whether to translate the recognized words to English. If true, the language model must be multilingual.

Set Step Size​

Sets the step size in milliseconds. Determines how often to send audio data for recognition. The default value is 5000 ms (5 seconds).

Set No Context​

Sets whether to use past transcription (if any) as initial prompt for the decoder.

Set Single Segment​

Sets whether to force single segment output (useful for streaming).

Set Max Tokens​

Sets the maximum number of tokens per text segment. Use 0 for no limit.

Set Speed Up​

Sets whether to speed up the recognition by 2x using Phase Vocoder. Set it as false to improve the quality of the output.

Set Audio Context Size​

Sets the size of the audio context. Set it as 0 to improve the quality of the output.

Set Temperature To Increase​

Sets the temperature to increase when falling back when the decoding fails to meet either of the thresholds below.

Set Entropy Threshold​

Sets the entropy threshold. If the compression ratio is higher than this value, treat the decoding as failed. Similar to OpenAI's "compression_ratio_threshold"

Set Suppress Blank​

Sets whether to suppress blanks showing up in outputs.

Set Suppress Non Speech Tokens​

Sets whether to suppress non speech tokens showing up in outputs.

Set Beam Size​

Set the number of beams in beam search. Only applicable when temperature is zero.

Set Initial Prompt​

Sets the initial prompt for the first window. This can be used to provide context for the recognition to make it more likely to predict the words correctly, e.g. custom vocabularies or proper nouns.