asr-core 0.0.2

Unified streaming, offline, and cloud speech-to-text engine for Rust
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
// Imports follow the gates of the tests that need them, so builds with
// only cloud or no backend features compile without unused warnings.
#[cfg(any(
    feature = "backend-sherpa",
    feature = "backend-dashscope",
    feature = "backend-openai-http",
    feature = "backend-openai-realtime"
))]
use super::*;

#[cfg(all(feature = "backend-sherpa", not(feature = "punct-sherpa")))]
use crate::backends::model_layout::fixtures::dir;
#[cfg(feature = "backend-sherpa")]
use crate::backends::model_layout::fixtures::transducer_dir;
#[cfg(all(feature = "backend-sherpa", feature = "vad-silero"))]
use crate::backends::model_layout::fixtures::{flat_dir, funasr_dir, qwen3_dir};

#[cfg(feature = "backend-sherpa")]
#[test]
fn validate_checks_streaming_and_punct_paths() {
    // Streaming requires the transducer layout (encoder/decoder/joiner).
    let (_guard, streaming_path) = transducer_dir("a 1\n");
    let mut config = crate::StreamingConfig::new(&streaming_path);
    assert!(validate(&EngineConfig::Streaming(config.clone())).is_ok());

    // Punctuation pointing at the transducer directory must fail: the
    // punct layout is model*.onnx only, and encoder/decoder/joiner do
    // not match it. (A flat ASR directory, in contrast, *is* a valid
    // punct layout — use `detect` to keep the two apart.)
    #[cfg(feature = "punct-sherpa")]
    {
        config.punctuation = Some(crate::PunctConfig::new(&streaming_path));
        let error = validate(&EngineConfig::Streaming(config.clone())).unwrap_err();
        assert_eq!(error.kind, ErrorKind::InvalidModel);
        // Shared precheck must keep the stage the load path has always
        // reported for this failure (`punct::create`).
        assert_eq!(error.stage, "punctuation");
        assert_precheck_matches_prepare(EngineConfig::Streaming(config));
    }
    #[cfg(not(feature = "punct-sherpa"))]
    {
        // Mirrors Engine::prepare: punctuation is compiled out.
        let (punct_guard, punct_path) = dir(&["model.int8.onnx"]);
        config.punctuation = Some(crate::PunctConfig::new(&punct_path));
        let error = validate(&EngineConfig::Streaming(config)).unwrap_err();
        assert_eq!(error.kind, ErrorKind::UnsupportedCapability);
        drop(punct_guard);
    }
}

/// The whole point of the shared validators: a configuration the
/// precheck accepts must not fail `Engine::prepare` on a cheap check.
#[cfg(feature = "backend-sherpa")]
#[test]
fn validate_applies_the_same_hotword_bias_rules_as_prepare() {
    let (_guard, path) = transducer_dir("a 1\n");
    let mut bias = crate::TransducerBiasConfig::new(vec![crate::BiasPhrase::new("张三")]);
    bias.default_score = f32::NAN;
    let mut config = crate::StreamingConfig::new(&path);
    config.bias = Some(bias);
    let error = validate(&EngineConfig::Streaming(config)).unwrap_err();
    assert_eq!(error.kind, ErrorKind::InvalidInput);
    assert!(error.message.contains("finite"), "{error}");
}

#[cfg(all(feature = "backend-sherpa", feature = "vad-silero"))]
#[test]
fn validate_applies_the_same_vad_parameter_rules_as_prepare() {
    // The TempDir must stay bound for the whole test: it owns the
    // directory the files live in.
    let (_guard, path) = flat_dir("foo 1\n<|zh|> 2\n");
    let vad_path = path.join("silero_vad.onnx");
    std::fs::write(&vad_path, [0u8; 8]).unwrap();
    let mut vad = crate::VadConfig::new(&vad_path);
    vad.threshold = f32::NAN;
    let config = crate::OfflineConfig::new(&path, crate::OfflineFamily::SenseVoice, vad);
    let error = validate(&EngineConfig::Offline(config)).unwrap_err();
    assert_eq!(error.kind, ErrorKind::InvalidInput);
    assert!(error.message.contains("VAD"), "{error}");
}

#[cfg(all(feature = "backend-sherpa", feature = "vad-silero"))]
#[test]
fn validate_offline_enforces_family_contradiction_and_vad_presence() {
    let (_guard, path) = flat_dir("foo 1\n<|zh|> 2\n");
    let vad_path = path.join("silero_vad.onnx");
    std::fs::write(&vad_path, [0u8; 8]).unwrap();
    let vad = crate::VadConfig::new(&vad_path);

    let config = crate::OfflineConfig::new(&path, crate::OfflineFamily::SenseVoice, vad.clone());
    assert!(validate(&EngineConfig::Offline(config)).is_ok());

    // SenseVoice markers are one-way evidence: configuring Paraformer on
    // a marked directory must be rejected before any model load.
    let config = crate::OfflineConfig::new(&path, crate::OfflineFamily::Paraformer, vad.clone());
    let error = validate(&EngineConfig::Offline(config)).unwrap_err();
    assert_eq!(error.kind, ErrorKind::InvalidModel);
    assert!(error.message.contains("SenseVoice"), "{error}");

    // Missing VAD file fails cheaply.
    let config = crate::OfflineConfig::new(&path, crate::OfflineFamily::SenseVoice, {
        let mut vad = vad;
        vad.model = path.join("missing.onnx");
        vad
    });
    let error = validate(&EngineConfig::Offline(config)).unwrap_err();
    assert_eq!(error.kind, ErrorKind::InvalidModel);
}

/// num_threads is a pure value check that fires before any filesystem
/// access; the fixtures are complete valid layouts so a bad thread count is
/// the only thing wrong with each config.
#[cfg(feature = "backend-sherpa")]
#[test]
fn validate_rejects_out_of_range_num_threads() {
    let (_guard, path) = transducer_dir("a 1\n");
    for bad in [0usize, crate::MAX_NUM_THREADS + 1] {
        let mut config = crate::StreamingConfig::new(&path);
        config.num_threads = bad;
        let error = validate(&EngineConfig::Streaming(config.clone())).unwrap_err();
        assert_eq!(
            error.kind,
            ErrorKind::InvalidInput,
            "streaming {bad}: {error}"
        );
        assert!(error.message.contains("num_threads"), "{error}");
        assert_precheck_matches_prepare(EngineConfig::Streaming(config));
    }
    #[cfg(feature = "vad-silero")]
    {
        let (_guard, path) = flat_dir("foo 1\n<|zh|> 2\n");
        let vad_path = path.join("silero_vad.onnx");
        std::fs::write(&vad_path, [0u8; 8]).unwrap();
        for bad in [0usize, crate::MAX_NUM_THREADS + 1] {
            let mut config = crate::OfflineConfig::new(
                &path,
                crate::OfflineFamily::SenseVoice,
                crate::VadConfig::new(&vad_path),
            );
            config.num_threads = bad;
            let error = validate(&EngineConfig::Offline(config.clone())).unwrap_err();
            assert_eq!(
                error.kind,
                ErrorKind::InvalidInput,
                "offline {bad}: {error}"
            );
            assert!(error.message.contains("num_threads"), "{error}");
            assert_precheck_matches_prepare(EngineConfig::Offline(config));
        }
    }
}

#[cfg(feature = "backend-dashscope")]
#[test]
fn validate_delegates_cloud_parameter_checks() {
    let config = EngineConfig::DashScope(crate::DashScopeConfig::new(
        "http://localhost/v1",
        "model",
        crate::Secret::new("k"),
    ));
    let error = validate(&config).unwrap_err();
    assert_eq!(error.kind, ErrorKind::InvalidInput);
}

#[cfg(feature = "backend-dashscope")]
#[test]
fn validate_rejects_invalid_dashscope_endpoints_and_parameters() {
    let endpoint = validate(&EngineConfig::DashScope(crate::DashScopeConfig::new(
        "not a url",
        "model",
        crate::Secret::new("k"),
    )))
    .unwrap_err();
    assert_eq!(endpoint.kind, ErrorKind::InvalidInput);
    assert_eq!(endpoint.stage, "configuration");

    let parameters = validate(&EngineConfig::DashScope(crate::DashScopeConfig::new(
        "ws://localhost/v1",
        " ",
        crate::Secret::new("k"),
    )))
    .unwrap_err();
    assert_eq!(parameters.kind, ErrorKind::InvalidInput);
    assert_eq!(parameters.stage, "configuration");
    assert_eq!(parameters.message, "model is required");
}

#[cfg(feature = "backend-openai-http")]
#[test]
fn validate_rejects_invalid_openai_http_parameters() {
    let api_root = validate(&EngineConfig::OpenAiHttp(crate::OpenAiHttpConfig::new(
        "not a url",
        "model",
        crate::Secret::new("k"),
    )))
    .unwrap_err();
    assert_eq!(api_root.kind, ErrorKind::InvalidInput);

    let api_key = validate(&EngineConfig::OpenAiHttp(crate::OpenAiHttpConfig::new(
        "https://localhost/v1",
        "model",
        crate::Secret::new("  "),
    )))
    .unwrap_err();
    assert_eq!(api_key.kind, ErrorKind::InvalidInput);
    assert_eq!(api_key.message, "OpenAI HTTP requires an API key");
}

#[cfg(feature = "backend-openai-realtime")]
#[test]
fn validate_rejects_invalid_openai_realtime_endpoints_and_parameters() {
    let endpoint = validate(&EngineConfig::OpenAiRealtime(
        crate::OpenAiRealtimeConfig::new("not a url", "model", crate::Secret::new("k")),
    ))
    .unwrap_err();
    assert_eq!(endpoint.kind, ErrorKind::InvalidInput);
    assert_eq!(endpoint.stage, "configuration");

    let api_key = validate(&EngineConfig::OpenAiRealtime(
        crate::OpenAiRealtimeConfig::new("ws://localhost/v1", "model", crate::Secret::new("")),
    ))
    .unwrap_err();
    assert_eq!(api_key.kind, ErrorKind::InvalidInput);
    assert_eq!(api_key.message, "OpenAI Realtime requires an API key");
}

/// 防漂移哨兵:对每个非法配置,`utils::precheck::validate` 与
/// `Engine::prepare` 必须同时失败且 kind/stage/message 一致。两者共享
/// 同一份 canonical pre-native 校验入口;loader 后半段仍会重复执行部分
/// 廉价校验,新增这类校验时须同步进共享 precheck。precheck 若漏检
/// (返回 Ok),下面的 `unwrap_err` 会当场 panic。
#[cfg(feature = "backend-sherpa")]
fn assert_precheck_matches_prepare(config: EngineConfig) {
    let precheck = validate(&config).unwrap_err();
    let prepare = crate::Engine::prepare(config, crate::EngineOptions::default()).unwrap_err();
    assert_eq!(precheck.kind, prepare.kind, "{precheck} vs {prepare}");
    assert_eq!(precheck.stage, prepare.stage, "{precheck} vs {prepare}");
    assert_eq!(precheck.message, prepare.message, "{precheck} vs {prepare}");
}

#[cfg(feature = "backend-sherpa")]
#[test]
fn precheck_fails_exactly_where_prepare_fails_for_streaming_bias() {
    // modeling_unit 'bpe' without a bpe.vocab in the model directory:
    // rejected through resolve_modeling_unit, before native init.
    let (_guard, path) = transducer_dir("a 1\n");
    let mut bias = crate::TransducerBiasConfig::new(Vec::new());
    bias.modeling_unit = Some("bpe".into());
    let mut config = crate::StreamingConfig::new(&path);
    config.bias = Some(bias);
    let error = validate(&EngineConfig::Streaming(config.clone())).unwrap_err();
    assert_eq!(error.kind, ErrorKind::InvalidModel);
    assert!(error.message.contains("bpe.vocab"), "{error}");
    assert_precheck_matches_prepare(EngineConfig::Streaming(config));

    // A bias phrase whose characters the model tokens do not know.
    let (_guard, path) = transducer_dir("语 1\n音 2\n");
    let bias = crate::TransducerBiasConfig::new(vec![crate::BiasPhrase::new("语音识别")]);
    let mut config = crate::StreamingConfig::new(&path);
    config.bias = Some(bias);
    let error = validate(&EngineConfig::Streaming(config.clone())).unwrap_err();
    assert_eq!(error.kind, ErrorKind::InvalidModel);
    assert!(
        error.message.contains("missing from the model tokens"),
        "{error}"
    );
    assert_precheck_matches_prepare(EngineConfig::Streaming(config));
}

#[cfg(all(feature = "backend-sherpa", feature = "vad-silero"))]
#[test]
fn precheck_fails_exactly_where_prepare_fails_for_offline_family_rules() {
    let vad_dir = tempfile::tempdir().unwrap();
    let vad_path = vad_dir.path().join("silero_vad.onnx");
    std::fs::write(&vad_path, [0u8; 8]).unwrap();
    let vad = crate::VadConfig::new(&vad_path);

    // Capability rules reject before any filesystem access, so a bare
    // directory is enough for these fixtures.
    let bare = tempfile::tempdir().unwrap();
    let with_bias = || crate::TransducerBiasConfig::new(vec![crate::BiasPhrase::new("张三")]);
    let with_hints = || crate::SpeechHints::new(vec!["张三".into()]);
    macro_rules! case {
        ($name:literal, $family:expr, $kind:expr, $message:literal, $field:ident, $value:expr) => {{
            let mut config = crate::OfflineConfig::new(bare.path(), $family, vad.clone());
            config.$field = $value;
            let error = validate(&EngineConfig::Offline(config.clone())).unwrap_err();
            assert_eq!(error.kind, $kind, "{}: {error}", $name);
            assert!(error.message.contains($message), "{}: {error}", $name);
            assert_precheck_matches_prepare(EngineConfig::Offline(config));
        }};
    }
    case!(
        "sensevoice bias",
        crate::OfflineFamily::SenseVoice,
        ErrorKind::UnsupportedCapability,
        "does not support speech hints or transducer bias",
        transducer_bias,
        Some(with_bias())
    );
    case!(
        "sensevoice prompt hints",
        crate::OfflineFamily::SenseVoice,
        ErrorKind::UnsupportedCapability,
        "does not support speech hints or transducer bias",
        prompt_hints,
        Some(with_hints())
    );
    case!(
        "sensevoice language",
        crate::OfflineFamily::SenseVoice,
        ErrorKind::InvalidInput,
        "unsupported SenseVoice language",
        language,
        Some("fr".into())
    );
    case!(
        "paraformer language",
        crate::OfflineFamily::Paraformer,
        ErrorKind::InvalidInput,
        "Paraformer does not accept a language override",
        language,
        Some("zh".into())
    );
    case!(
        "transducer language",
        crate::OfflineFamily::Transducer,
        ErrorKind::InvalidInput,
        "Transducer does not accept a language override",
        language,
        Some("zh".into())
    );
    case!(
        "transducer prompt hints",
        crate::OfflineFamily::Transducer,
        ErrorKind::UnsupportedCapability,
        "does not support engine-level prompt hints",
        prompt_hints,
        Some(with_hints())
    );
    case!(
        "qwen3 bias",
        crate::OfflineFamily::Qwen3Asr,
        ErrorKind::UnsupportedCapability,
        "does not support transducer bias",
        transducer_bias,
        Some(with_bias())
    );
    case!(
        "qwen3 language",
        crate::OfflineFamily::Qwen3Asr,
        ErrorKind::InvalidInput,
        "does not accept a language override",
        language,
        Some("zh".into())
    );
    case!(
        "funasr bias",
        crate::OfflineFamily::FunAsrNano,
        ErrorKind::UnsupportedCapability,
        "does not support transducer bias",
        transducer_bias,
        Some(with_bias())
    );
    case!(
        "funasr language",
        crate::OfflineFamily::FunAsrNano,
        ErrorKind::InvalidInput,
        "does not accept a language override",
        language,
        Some("zh".into())
    );
    case!(
        "fire-red aed bias",
        crate::OfflineFamily::FireRedAsrAed,
        ErrorKind::UnsupportedCapability,
        "does not support speech hints or transducer bias",
        transducer_bias,
        Some(with_bias())
    );
    case!(
        "fire-red aed prompt hints",
        crate::OfflineFamily::FireRedAsrAed,
        ErrorKind::UnsupportedCapability,
        "does not support speech hints or transducer bias",
        prompt_hints,
        Some(with_hints())
    );
    case!(
        "fire-red aed language",
        crate::OfflineFamily::FireRedAsrAed,
        ErrorKind::InvalidInput,
        "does not accept a language override",
        language,
        Some("zh".into())
    );
    case!(
        "fire-red ctc bias",
        crate::OfflineFamily::FireRedAsrCtc,
        ErrorKind::UnsupportedCapability,
        "does not support speech hints or transducer bias",
        transducer_bias,
        Some(with_bias())
    );
    case!(
        "fire-red ctc prompt hints",
        crate::OfflineFamily::FireRedAsrCtc,
        ErrorKind::UnsupportedCapability,
        "does not support speech hints or transducer bias",
        prompt_hints,
        Some(with_hints())
    );
    case!(
        "fire-red ctc language",
        crate::OfflineFamily::FireRedAsrCtc,
        ErrorKind::InvalidInput,
        "does not accept a language override",
        language,
        Some("zh".into())
    );

    // Layout rules fire after capability rules on a bare directory:
    // the finders reject before native init and both engines agree.
    for (name, family, missing) in [
        (
            "fire-red aed layout",
            crate::OfflineFamily::FireRedAsrAed,
            "missing encoder*.onnx",
        ),
        (
            "fire-red ctc layout",
            crate::OfflineFamily::FireRedAsrCtc,
            "missing model*.onnx",
        ),
    ] {
        let config = crate::OfflineConfig::new(bare.path(), family, vad.clone());
        let error = validate(&EngineConfig::Offline(config.clone())).unwrap_err();
        assert_eq!(error.kind, ErrorKind::InvalidModel, "{name}: {error}");
        assert!(error.message.contains(missing), "{name}: {error}");
        assert_precheck_matches_prepare(EngineConfig::Offline(config));
    }

    // CTC 与 SenseVoice/Paraformer 共享矛盾守卫:带 <|zh|> 标记的 tokens
    // 配成 FireRedAsrCtc 必须被 validate(而非仅 prepare)拒绝。
    let (marked_guard, marked_path) = flat_dir("foo 1\n<|zh|> 2\n");
    let config = crate::OfflineConfig::new(
        &marked_path,
        crate::OfflineFamily::FireRedAsrCtc,
        vad.clone(),
    );
    let error = validate(&EngineConfig::Offline(config.clone())).unwrap_err();
    assert_eq!(error.kind, ErrorKind::InvalidModel);
    assert!(
        error.message.contains("SenseVoice language markers"),
        "{error}"
    );
    assert_precheck_matches_prepare(EngineConfig::Offline(config));
    drop(marked_guard);

    // 无标记的完整 flat 目录配成 FireRedAsrCtc 应当通过预检(防误拒)。
    let (flat_guard, flat_path) = flat_dir("foo 1\nbar 2\n");
    let config =
        crate::OfflineConfig::new(&flat_path, crate::OfflineFamily::FireRedAsrCtc, vad.clone());
    validate(&EngineConfig::Offline(config)).unwrap();
    drop(flat_guard);

    // Prompt rendering rules fire after the family layout resolves, so
    // these fixtures must be complete directories.
    let (qwen3_guard, qwen3_path) = qwen3_dir();
    let mut config =
        crate::OfflineConfig::new(&qwen3_path, crate::OfflineFamily::Qwen3Asr, vad.clone());
    config.prompt_hints = Some(crate::SpeechHints::new(vec!["张三,李四".into()]));
    let error = validate(&EngineConfig::Offline(config.clone())).unwrap_err();
    assert_eq!(error.kind, ErrorKind::InvalidInput);
    assert!(error.message.contains("','"), "{error}");
    assert_precheck_matches_prepare(EngineConfig::Offline(config));
    drop(qwen3_guard);

    let (funasr_guard, funasr_path) = funasr_dir();
    let mut config = crate::OfflineConfig::new(&funasr_path, crate::OfflineFamily::FunAsrNano, vad);
    config.prompt_hints = Some(crate::SpeechHints::new(vec!["沪;语".into()]));
    let error = validate(&EngineConfig::Offline(config.clone())).unwrap_err();
    assert_eq!(error.kind, ErrorKind::InvalidInput);
    assert!(error.message.contains(';'), "{error}");
    assert_precheck_matches_prepare(EngineConfig::Offline(config));
    drop(funasr_guard);
}

#[cfg(feature = "backend-sherpa")]
#[test]
fn incompatible_providers_fail_before_model_access() {
    let providers = [
        #[cfg(not(any(target_os = "linux", target_os = "windows")))]
        crate::ExecutionProvider::Cuda,
        #[cfg(not(target_vendor = "apple"))]
        crate::ExecutionProvider::CoreMl,
    ];
    for provider in providers {
        let mut config = crate::StreamingConfig::new("/nonexistent-model");
        config.provider = provider;
        let config = EngineConfig::Streaming(config);
        let error = validate(&config).unwrap_err();
        assert_eq!(error.kind, ErrorKind::UnsupportedCapability);
        assert!(error.message.contains(provider.as_str()));
        assert_precheck_matches_prepare(config);
        #[cfg(feature = "vad-silero")]
        {
            let mut config = crate::OfflineConfig::new(
                "/nonexistent-model",
                crate::OfflineFamily::SenseVoice,
                crate::VadConfig::new("/nonexistent-vad"),
            );
            config.provider = provider;
            let config = EngineConfig::Offline(config);
            let error = validate(&config).unwrap_err();
            assert_eq!(error.kind, ErrorKind::UnsupportedCapability);
            assert!(error.message.contains(provider.as_str()));
            assert_precheck_matches_prepare(config);
        }
    }
}