Configuration for streaming ASR. More...

#include <cxx-api.h>

Collaboration diagram for sherpa_onnx::cxx::OnlineRecognizerConfig:

Public Attributes
FeatureConfig	feat_config

OnlineModelConfig	model_config

std::string	decoding_method = "greedy_search"

int32_t	max_active_paths = 4

bool	enable_endpoint = false

float	rule1_min_trailing_silence = 2.4

float	rule2_min_trailing_silence = 1.2

float	rule3_min_utterance_length = 20

std::string	hotwords_file

float	hotwords_score = 1.5

OnlineCtcFstDecoderConfig	ctc_fst_decoder_config

std::string	rule_fsts

std::string	rule_fars

float	blank_penalty = 0

std::string	hotwords_buf

HomophoneReplacerConfig	hr

Detailed Description

Example:

OnlineRecognizerConfig config;
config.model_config.transducer.encoder =
    "./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/"
    "encoder-epoch-99-avg-1.int8.onnx";
config.model_config.transducer.decoder =
    "./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/"
    "decoder-epoch-99-avg-1.onnx";
config.model_config.transducer.joiner =
    "./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/"
    "joiner-epoch-99-avg-1.int8.onnx";
config.model_config.tokens =
    "./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/tokens.txt";
config.model_config.num_threads = 1;
config.hr.lexicon = "./lexicon.txt";
config.hr.rule_fsts = "./replace.fst";

Definition at line 199 of file cxx-api.h.

Member Data Documentation

◆ blank_penalty

float sherpa_onnx::cxx::OnlineRecognizerConfig::blank_penalty = 0

Optional blank penalty applied during decoding.

Definition at line 236 of file cxx-api.h.

◆ ctc_fst_decoder_config

OnlineCtcFstDecoderConfig sherpa_onnx::cxx::OnlineRecognizerConfig::ctc_fst_decoder_config

Optional CTC+FST decoder configuration.

Definition at line 230 of file cxx-api.h.

◆ decoding_method

std::string sherpa_onnx::cxx::OnlineRecognizerConfig::decoding_method = "greedy_search"

Decoding method such as "greedy_search" or "modified_beam_search".

Definition at line 206 of file cxx-api.h.

◆ enable_endpoint

bool sherpa_onnx::cxx::OnlineRecognizerConfig::enable_endpoint = false

Enable endpoint detection.

Definition at line 212 of file cxx-api.h.

◆ feat_config

FeatureConfig sherpa_onnx::cxx::OnlineRecognizerConfig::feat_config

Feature extraction configuration.

Definition at line 201 of file cxx-api.h.

◆ hotwords_buf

std::string sherpa_onnx::cxx::OnlineRecognizerConfig::hotwords_buf

Optional in-memory hotword definitions.

Definition at line 239 of file cxx-api.h.

◆ hotwords_file

std::string sherpa_onnx::cxx::OnlineRecognizerConfig::hotwords_file

Optional hotword file.

Definition at line 224 of file cxx-api.h.

◆ hotwords_score

float sherpa_onnx::cxx::OnlineRecognizerConfig::hotwords_score = 1.5

Hotword boost score.

Definition at line 227 of file cxx-api.h.

◆ hr

HomophoneReplacerConfig sherpa_onnx::cxx::OnlineRecognizerConfig::hr

Optional homophone replacement configuration.

Definition at line 241 of file cxx-api.h.

◆ max_active_paths

int32_t sherpa_onnx::cxx::OnlineRecognizerConfig::max_active_paths = 4

Maximum number of active paths for beam-search-style decoding.

Definition at line 209 of file cxx-api.h.

◆ model_config

OnlineModelConfig sherpa_onnx::cxx::OnlineRecognizerConfig::model_config

Acoustic model configuration.

Definition at line 203 of file cxx-api.h.

◆ rule1_min_trailing_silence

float sherpa_onnx::cxx::OnlineRecognizerConfig::rule1_min_trailing_silence = 2.4

Endpointing rule 1 trailing silence threshold in seconds.

Definition at line 215 of file cxx-api.h.

◆ rule2_min_trailing_silence

float sherpa_onnx::cxx::OnlineRecognizerConfig::rule2_min_trailing_silence = 1.2

Endpointing rule 2 trailing silence threshold in seconds.

Definition at line 218 of file cxx-api.h.

◆ rule3_min_utterance_length

float sherpa_onnx::cxx::OnlineRecognizerConfig::rule3_min_utterance_length = 20

Endpointing rule 3 minimum utterance length in seconds.

Definition at line 221 of file cxx-api.h.

◆ rule_fars

std::string sherpa_onnx::cxx::OnlineRecognizerConfig::rule_fars

Optional ITN rule FAR archive.

Definition at line 234 of file cxx-api.h.

◆ rule_fsts

std::string sherpa_onnx::cxx::OnlineRecognizerConfig::rule_fsts

Optional ITN rule FST archive.

Definition at line 232 of file cxx-api.h.

The documentation for this struct was generated from the following file:

c-api/cxx-api.h

Public Attributes