sherpa-onnx C API 1.0
Public C API and C++ wrapper for sherpa-onnx
Loading...
Searching...
No Matches
SherpaOnnxOfflineModelConfig Struct Reference

Model configuration shared by offline ASR recognizers. More...

#include <c-api.h>

+ Collaboration diagram for SherpaOnnxOfflineModelConfig:

Public Attributes

SherpaOnnxOfflineTransducerModelConfig transducer
 
SherpaOnnxOfflineParaformerModelConfig paraformer
 
SherpaOnnxOfflineNemoEncDecCtcModelConfig nemo_ctc
 
SherpaOnnxOfflineWhisperModelConfig whisper
 
SherpaOnnxOfflineTdnnModelConfig tdnn
 
const char * tokens
 
int32_t num_threads
 
int32_t debug
 
const char * provider
 
const char * model_type
 
const char * modeling_unit
 
const char * bpe_vocab
 
const char * telespeech_ctc
 
SherpaOnnxOfflineSenseVoiceModelConfig sense_voice
 
SherpaOnnxOfflineMoonshineModelConfig moonshine
 
SherpaOnnxOfflineFireRedAsrModelConfig fire_red_asr
 
SherpaOnnxOfflineDolphinModelConfig dolphin
 
SherpaOnnxOfflineZipformerCtcModelConfig zipformer_ctc
 
SherpaOnnxOfflineCanaryModelConfig canary
 
SherpaOnnxOfflineWenetCtcModelConfig wenet_ctc
 
SherpaOnnxOfflineOmnilingualAsrCtcModelConfig omnilingual
 
SherpaOnnxOfflineMedAsrCtcModelConfig medasr
 
SherpaOnnxOfflineFunASRNanoModelConfig funasr_nano
 
SherpaOnnxOfflineFireRedAsrCtcModelConfig fire_red_asr_ctc
 
SherpaOnnxOfflineQwen3ASRModelConfig qwen3_asr
 
SherpaOnnxOfflineCohereTranscribeModelConfig cohere_transcribe
 

Detailed Description

Zero-initialize this struct before use, then fill in exactly the sub-config needed by the model family you want to run.

Exactly one model family should be configured for each recognizer. For example, set only one of transducer, paraformer, nemo_ctc, whisper, tdnn, sense_voice, moonshine, fire_red_asr, dolphin, zipformer_ctc, canary, cohere_transcribe, wenet_ctc, omnilingual, medasr, funasr_nano, fire_red_asr_ctc, or qwen3_asr.

If multiple model families are configured at the same time, the implementation will choose one of them, and which one is used is implementation-defined. Do not rely on any precedence rule.

Definition at line 1046 of file c-api.h.

Member Data Documentation

◆ bpe_vocab

const char* SherpaOnnxOfflineModelConfig::bpe_vocab

Path to the BPE vocabulary file when BPE is used.

Definition at line 1071 of file c-api.h.

◆ canary

SherpaOnnxOfflineCanaryModelConfig SherpaOnnxOfflineModelConfig::canary

Canary configuration.

Definition at line 1085 of file c-api.h.

◆ cohere_transcribe

SherpaOnnxOfflineCohereTranscribeModelConfig SherpaOnnxOfflineModelConfig::cohere_transcribe

Cohere Transcribe configuration.

Definition at line 1099 of file c-api.h.

◆ debug

int32_t SherpaOnnxOfflineModelConfig::debug

Non-zero to print debug information.

Definition at line 1063 of file c-api.h.

◆ dolphin

SherpaOnnxOfflineDolphinModelConfig SherpaOnnxOfflineModelConfig::dolphin

Dolphin configuration.

Definition at line 1081 of file c-api.h.

◆ fire_red_asr

SherpaOnnxOfflineFireRedAsrModelConfig SherpaOnnxOfflineModelConfig::fire_red_asr

FireRedAsr configuration.

Definition at line 1079 of file c-api.h.

◆ fire_red_asr_ctc

SherpaOnnxOfflineFireRedAsrCtcModelConfig SherpaOnnxOfflineModelConfig::fire_red_asr_ctc

FireRedAsr CTC configuration.

Definition at line 1095 of file c-api.h.

◆ funasr_nano

SherpaOnnxOfflineFunASRNanoModelConfig SherpaOnnxOfflineModelConfig::funasr_nano

FunASR Nano configuration.

Definition at line 1093 of file c-api.h.

◆ medasr

SherpaOnnxOfflineMedAsrCtcModelConfig SherpaOnnxOfflineModelConfig::medasr

MedASR configuration.

Definition at line 1091 of file c-api.h.

◆ model_type

const char* SherpaOnnxOfflineModelConfig::model_type

Optional explicit model type override.

Definition at line 1067 of file c-api.h.

◆ modeling_unit

const char* SherpaOnnxOfflineModelConfig::modeling_unit

Modeling unit, such as "cjkchar", "bpe", or "cjkchar+bpe".

Definition at line 1069 of file c-api.h.

◆ moonshine

SherpaOnnxOfflineMoonshineModelConfig SherpaOnnxOfflineModelConfig::moonshine

Moonshine configuration.

Definition at line 1077 of file c-api.h.

◆ nemo_ctc

SherpaOnnxOfflineNemoEncDecCtcModelConfig SherpaOnnxOfflineModelConfig::nemo_ctc

Non-streaming NeMo CTC model files.

Definition at line 1052 of file c-api.h.

◆ num_threads

int32_t SherpaOnnxOfflineModelConfig::num_threads

Number of backend threads.

Definition at line 1061 of file c-api.h.

◆ omnilingual

SherpaOnnxOfflineOmnilingualAsrCtcModelConfig SherpaOnnxOfflineModelConfig::omnilingual

Omnilingual CTC configuration.

Definition at line 1089 of file c-api.h.

◆ paraformer

SherpaOnnxOfflineParaformerModelConfig SherpaOnnxOfflineModelConfig::paraformer

Non-streaming Paraformer model files.

Definition at line 1050 of file c-api.h.

◆ provider

const char* SherpaOnnxOfflineModelConfig::provider

Execution provider, for example "cpu" or "cuda".

Definition at line 1065 of file c-api.h.

◆ qwen3_asr

SherpaOnnxOfflineQwen3ASRModelConfig SherpaOnnxOfflineModelConfig::qwen3_asr

Qwen3-ASR configuration.

Definition at line 1097 of file c-api.h.

◆ sense_voice

SherpaOnnxOfflineSenseVoiceModelConfig SherpaOnnxOfflineModelConfig::sense_voice

SenseVoice configuration.

Definition at line 1075 of file c-api.h.

◆ tdnn

SherpaOnnxOfflineTdnnModelConfig SherpaOnnxOfflineModelConfig::tdnn

TDNN model files.

Definition at line 1056 of file c-api.h.

◆ telespeech_ctc

const char* SherpaOnnxOfflineModelConfig::telespeech_ctc

Path to the TeleSpeech CTC model.

Definition at line 1073 of file c-api.h.

◆ tokens

const char* SherpaOnnxOfflineModelConfig::tokens

Path to the tokens file.

Definition at line 1059 of file c-api.h.

◆ transducer

SherpaOnnxOfflineTransducerModelConfig SherpaOnnxOfflineModelConfig::transducer

Non-streaming transducer model files.

Definition at line 1048 of file c-api.h.

◆ wenet_ctc

SherpaOnnxOfflineWenetCtcModelConfig SherpaOnnxOfflineModelConfig::wenet_ctc

WeNet CTC configuration.

Definition at line 1087 of file c-api.h.

◆ whisper

SherpaOnnxOfflineWhisperModelConfig SherpaOnnxOfflineModelConfig::whisper

Whisper model files and options.

Definition at line 1054 of file c-api.h.

◆ zipformer_ctc

SherpaOnnxOfflineZipformerCtcModelConfig SherpaOnnxOfflineModelConfig::zipformer_ctc

Zipformer CTC configuration.

Definition at line 1083 of file c-api.h.


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