anno-eval 0.10.0

Evaluation harnesses, datasets, and muxer-backed sampling for anno
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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
//! Backend Factory for Runtime Backend Creation
//!
//! This module provides a factory pattern for creating backend instances
//! from string names, enabling dynamic backend selection for evaluation.
//!
//! # Design Philosophy
//!
//! - **Feature-aware**: Only creates backends when features are enabled
//! - **Graceful degradation**: Returns errors for unavailable backends
//! - **Model defaults**: Uses sensible default models for each backend
//! - **Trait-based**: Returns trait objects for polymorphic usage

use anno::{Model, Result};

/// Factory for creating backend instances from names.
pub struct BackendFactory;

impl BackendFactory {
    /// Create a backend instance from a name.
    ///
    /// # Supported Backends
    ///
    /// ## Always Available
    /// - `pattern` / `RegexNER` - Pattern-based NER
    /// - `heuristic` / `HeuristicNER` - Heuristic NER
    /// - `stacked` / `StackedNER` - Stacked NER
    ///
    /// ## ONNX Feature Required
    /// - `bert_onnx` / `BertNEROnnx` - BERT ONNX NER
    /// - `gliner_onnx` / `GLiNEROnnx` - GLiNER ONNX (zero-shot)
    /// - `nuner` / `NuNER` - NuNER (zero-shot, token-based)
    /// - `w2ner` / `W2NER` - W2NER (discontinuous NER)
    /// - `gliner_multitask` / `GLiNERMultitaskOnnx` - GLiNERMultitask multi-task
    ///
    /// ## Candle Feature Required
    /// - `candle_ner` / `CandleNER` - Candle BERT NER
    /// - `gliner_candle` / `GLiNERCandle` - GLiNER Candle (zero-shot)
    /// - `gliner_multitask_candle` / `GLiNERMultitaskCandle` - GLiNERMultitask Candle
    ///
    /// ## Coreference
    /// - `coref_resolver` / `SimpleCorefResolver` - Simple coreference resolver
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// use anno_eval::eval::backend_factory::BackendFactory;
    ///
    /// let backend = BackendFactory::create("pattern")?;
    /// let entities = backend.extract_entities("Meeting on Jan 15", None)?;
    /// ```
    pub fn create(backend_name: &str) -> Result<Box<dyn Model>> {
        match backend_name.to_lowercase().as_str() {
            // Always available backends
            "pattern" | "patternner" | "regex" | "regexner" => Ok(Box::new(anno::RegexNER::new())),
            "heuristic" | "heuristicner" => Ok(Box::new(anno::HeuristicNER::new())),
            "stacked" | "stackedner" => Ok(Box::new(anno::StackedNER::default())),
            "crf" | "crfner" => Ok(Box::new(anno::backends::crf::CrfNER::new())),
            "hmm" | "hmmner" => Ok(Box::new(anno::backends::hmm::HmmNER::new())),
            "ensemble" | "ensemblener" => {
                use anno::backends::ensemble::EnsembleNER;
                Ok(Box::new(EnsembleNER::default()) as Box<dyn Model>)
            }
            "heuristic_crf" | "heuristic-crf" | "heuristiccrfner" => {
                use anno::backends::heuristic_crf::HeuristicCrfNER;
                Ok(Box::new(HeuristicCrfNER::new()) as Box<dyn Model>)
            }

            // ONNX backends
            #[cfg(feature = "onnx")]
            "bert_onnx" | "bertneronnx" => {
                use anno::backends::onnx::BertNEROnnx;
                use crate::DEFAULT_BERT_ONNX_MODEL;
                BertNEROnnx::new(DEFAULT_BERT_ONNX_MODEL)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        anno::Error::FeatureNotAvailable(format!(
                            "Failed to create BertNEROnnx: {}",
                            e
                        ))
                    })
            }
            #[cfg(not(feature = "onnx"))]
            "bert_onnx" | "bertneronnx" => Err(anno::Error::FeatureNotAvailable(
                "BertNEROnnx requires 'onnx' feature".to_string(),
            )),

            #[cfg(feature = "onnx")]
            "gliner" => {
                // First-class alias: prefer ONNX when available.
                use anno::backends::gliner_onnx::GLiNEROnnx;
                use crate::DEFAULT_GLINER_MODEL;
                GLiNEROnnx::new(DEFAULT_GLINER_MODEL)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        anno::Error::FeatureNotAvailable(format!(
                            "Failed to create GLiNER (onnx): {}",
                            e
                        ))
                    })
            }
            #[cfg(all(not(feature = "onnx"), feature = "candle"))]
            "gliner" => {
                // Fallback alias: Candle implementation when ONNX isn't enabled.
                use anno::backends::gliner_candle::GLiNERCandle;
                use crate::DEFAULT_GLINER_CANDLE_MODEL;
                GLiNERCandle::from_pretrained(DEFAULT_GLINER_CANDLE_MODEL)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        anno::Error::FeatureNotAvailable(format!(
                            "Failed to create GLiNER (candle): {}",
                            e
                        ))
                    })
            }
            #[cfg(all(not(feature = "onnx"), not(feature = "candle")))]
            "gliner" => Err(crate::Error::FeatureNotAvailable(
                "GLiNER requires 'onnx' (preferred) or 'candle' feature".to_string(),
            )),

            #[cfg(feature = "onnx")]
            "gliner_onnx" | "glineronnx" => {
                use crate::backends::gliner_onnx::GLiNEROnnx;
                use crate::DEFAULT_GLINER_MODEL;
                GLiNEROnnx::new(DEFAULT_GLINER_MODEL)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::FeatureNotAvailable(format!(
                            "Failed to create GLiNEROnnx: {}",
                            e
                        ))
                    })
            }
            #[cfg(not(feature = "onnx"))]
            "gliner_onnx" | "glineronnx" => Err(crate::Error::FeatureNotAvailable(
                "GLiNEROnnx requires 'onnx' feature".to_string(),
            )),

            // B2NER (COLING 2025, unified NER training on 54 datasets)
            // Note: only LLM-scale models (7B/20B) available on HuggingFace.
            // Requires LLM backend, not ONNX. Pending encoder-scale release.
            "b2ner" => Err(crate::Error::FeatureNotAvailable(
                "B2NER only has LLM-scale models (7B/20B) on HuggingFace. \
                 Encoder-scale ONNX weights pending release."
                    .to_string(),
            )),

            // GLiNER PII Edge (60+ PII categories, zero-shot)
            #[cfg(feature = "onnx")]
            "gliner_pii" | "pii_ml" => {
                use crate::backends::gliner_onnx::GLiNEROnnx;
                GLiNEROnnx::new(anno::models::GLINER_PII)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::FeatureNotAvailable(format!(
                            "GLiNER PII Edge model unavailable: {}",
                            e
                        ))
                    })
            }
            #[cfg(not(feature = "onnx"))]
            "gliner_pii" | "pii_ml" => Err(crate::Error::FeatureNotAvailable(
                "GLiNER PII requires 'onnx' feature".to_string(),
            )),

            // GLiNER-RelEx (joint NER + relation extraction, zero-shot)
            #[cfg(feature = "onnx")]
            "gliner_relex" | "relex" => {
                use crate::backends::gliner_onnx::GLiNEROnnx;
                GLiNEROnnx::new(anno::models::GLINER_RELEX)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::FeatureNotAvailable(format!(
                            "GLiNER-RelEx model unavailable: {}\n\n\
                             Export: uv run scripts/export_glirel_onnx.py",
                            e
                        ))
                    })
            }
            #[cfg(not(feature = "onnx"))]
            "gliner_relex" | "relex" => Err(crate::Error::FeatureNotAvailable(
                "GLiNER-RelEx requires 'onnx' feature".to_string(),
            )),

            #[cfg(feature = "onnx")]
            "nuner" | "nunerzero" => {
                use crate::backends::nuner::NuNER;
                use crate::DEFAULT_NUNER_MODEL;
                NuNER::from_pretrained(DEFAULT_NUNER_MODEL)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::FeatureNotAvailable(format!("Failed to create NuNER: {}", e))
                    })
            }
            #[cfg(not(feature = "onnx"))]
            "nuner" | "nunerzero" => Err(crate::Error::FeatureNotAvailable(
                "NuNER requires 'onnx' feature".to_string(),
            )),

            #[cfg(feature = "onnx")]
            "nuner_4k" | "nunerzero4k" => {
                use crate::backends::nuner::NuNER;
                NuNER::from_pretrained("numind/NuNER_Zero-4k")
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::FeatureNotAvailable(format!(
                            "Failed to create NuNER 4k: {}",
                            e
                        ))
                    })
            }
            #[cfg(not(feature = "onnx"))]
            "nuner_4k" | "nunerzero4k" => Err(crate::Error::FeatureNotAvailable(
                "NuNER 4k requires 'onnx' feature".to_string(),
            )),

            #[cfg(feature = "onnx")]
            "w2ner" => {
                use crate::backends::w2ner::W2NER;
                use crate::DEFAULT_W2NER_MODEL;
                // Allow override via environment variable for custom/exported models
                let model_path = std::env::var("W2NER_MODEL_PATH")
                    .unwrap_or_else(|_| DEFAULT_W2NER_MODEL.to_string());
                W2NER::from_pretrained(&model_path)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::FeatureNotAvailable(format!(
                            "W2NER model unavailable: {}\n\n\
                             Options:\n\
                             1. Set W2NER_MODEL_PATH to a local model directory\n\
                             2. Export your own: uv run scripts/export_w2ner_to_onnx.py\n\
                             3. For HF models, set HF_TOKEN and request access",
                            e
                        ))
                    })
            }
            #[cfg(not(feature = "onnx"))]
            "w2ner" => Err(crate::Error::FeatureNotAvailable(
                "W2NER requires 'onnx' feature".to_string(),
            )),

            #[cfg(feature = "onnx")]
            "gliner_multitask" | "gliner_multitask_onnx" => {
                use crate::backends::gliner_multitask::GLiNERMultitaskOnnx;
                use crate::DEFAULT_GLINER_MULTITASK_MODEL;
                GLiNERMultitaskOnnx::from_pretrained(DEFAULT_GLINER_MULTITASK_MODEL)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::FeatureNotAvailable(format!(
                            "Failed to create GLiNER multi-task (ONNX): {}",
                            e
                        ))
                    })
            }
            #[cfg(not(feature = "onnx"))]
            "gliner_multitask" | "gliner_multitask_onnx" => Err(crate::Error::FeatureNotAvailable(
                "GLiNER multi-task (ONNX) requires 'onnx' feature".to_string(),
            )),

            // Candle backends
            #[cfg(feature = "candle")]
            "candle_ner" | "candlener" => {
                use crate::backends::candle::CandleNER;
                use crate::DEFAULT_CANDLE_MODEL;
                CandleNER::from_pretrained(DEFAULT_CANDLE_MODEL)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::FeatureNotAvailable(format!(
                            "CandleNER model unavailable: {}",
                            e
                        ))
                    })
            }
            #[cfg(not(feature = "candle"))]
            "candle_ner" | "candlener" => Err(crate::Error::FeatureNotAvailable(
                "CandleNER requires 'candle' feature".to_string(),
            )),

            #[cfg(feature = "candle")]
            "gliner_candle" | "glinercandle" => {
                use crate::backends::gliner_candle::GLiNERCandle;
                use crate::DEFAULT_GLINER_CANDLE_MODEL;
                GLiNERCandle::from_pretrained(DEFAULT_GLINER_CANDLE_MODEL)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::FeatureNotAvailable(format!(
                            "GLiNERCandle model unavailable: {}",
                            e
                        ))
                    })
            }
            #[cfg(not(feature = "candle"))]
            "gliner_candle" | "glinercandle" => Err(crate::Error::FeatureNotAvailable(
                "GLiNERCandle requires 'candle' feature".to_string(),
            )),

            #[cfg(all(feature = "candle", feature = "onnx"))]
            "gliner_multitask_candle" => {
                use crate::backends::gliner_multitask::GLiNERMultitaskCandle;
                use crate::DEFAULT_GLINER_MULTITASK_MODEL;
                GLiNERMultitaskCandle::from_pretrained(DEFAULT_GLINER_MULTITASK_MODEL)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::FeatureNotAvailable(format!(
                            "Failed to create GLiNER multi-task (Candle): {}",
                            e
                        ))
                    })
            }
            #[cfg(not(all(feature = "candle", feature = "onnx")))]
            "gliner_multitask_candle" => Err(crate::Error::FeatureNotAvailable(
                "GLiNER multi-task (Candle) requires both 'candle' and 'onnx' features".to_string(),
            )),

            // TPLinker (ONNX neural with `onnx` feature, heuristic fallback otherwise)
            "tplinker" | "tplink" => {
                use anno::backends::tplinker::TPLinker;
                Ok(Box::new(TPLinker::new()?) as Box<dyn Model>)
            }

            // Poly-Encoder GLiNER (requires onnx)
            #[cfg(feature = "onnx")]
            "gliner_poly" | "gliner-poly" | "poly_gliner" => {
                use anno::backends::gliner_poly::GLiNERPoly;
                use anno::DEFAULT_GLINER_POLY_MODEL;
                GLiNERPoly::new(DEFAULT_GLINER_POLY_MODEL)
                    .map(|m| Box::new(m) as Box<dyn anno::Model>)
                    .map_err(|e| crate::Error::model_init(e.to_string()))
            }
            #[cfg(not(feature = "onnx"))]
            "gliner_poly" | "gliner-poly" | "poly_gliner" => Err(crate::Error::FeatureNotAvailable(
                "GLiNERPoly requires 'onnx' feature".to_string(),
            )),

            // DeBERTa-v3 NER (requires onnx) -- uses BertNEROnnx (same ONNX interface)
            #[cfg(feature = "onnx")]
            "deberta_v3" | "deberta-v3" | "deberta" => {
                use anno::backends::onnx::BertNEROnnx;
                let Ok(model_path) = std::env::var("DEBERTA_MODEL_PATH") else {
                    return Err(crate::Error::FeatureNotAvailable(
                        "DeBERTa-v3 backend requires a local ONNX export. Set DEBERTA_MODEL_PATH (e.g. after running `uv run scripts/export_deberta_ner_to_onnx.py`)."
                            .to_string(),
                    ));
                };
                BertNEROnnx::new(&model_path)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::Retrieval(format!(
                            "DeBERTa-v3 model unavailable: {e}\n\n\
                             Options:\n\
                             1. Export your own: uv run scripts/export_deberta_ner_to_onnx.py\n\
                             2. Set DEBERTA_MODEL_PATH to a local model directory\n\
                             3. Use --model bert-onnx or --model candle-ner instead",
                        ))
                    })
            }
            #[cfg(not(feature = "onnx"))]
            "deberta_v3" | "deberta-v3" | "deberta" => Err(crate::Error::FeatureNotAvailable(
                "DeBERTa-v3 NER requires 'onnx' feature".to_string(),
            )),

            // ALBERT NER (requires onnx) -- uses BertNEROnnx (same ONNX interface)
            #[cfg(feature = "onnx")]
            "albert" | "albert_ner" => {
                use anno::backends::onnx::BertNEROnnx;
                let Ok(model_path) = std::env::var("ALBERT_MODEL_PATH") else {
                    return Err(crate::Error::FeatureNotAvailable(
                        "ALBERT backend requires a local ONNX export. Set ALBERT_MODEL_PATH to a local model directory containing ONNX weights."
                            .to_string(),
                    ));
                };
                BertNEROnnx::new(&model_path)
                    .map(|m| Box::new(m) as Box<dyn Model>)
                    .map_err(|e| {
                        crate::Error::Retrieval(format!(
                            "ALBERT model unavailable: {e}\n\n\
                             Options:\n\
                             1. Export your own ONNX model\n\
                             2. Set ALBERT_MODEL_PATH to a local model directory\n\
                             3. Use --model bert-onnx or --model candle-ner instead",
                        ))
                    })
            }
            #[cfg(not(feature = "onnx"))]
            "albert" | "albert_ner" => Err(crate::Error::FeatureNotAvailable(
                "ALBERT NER requires 'onnx' feature".to_string(),
            )),

            // UniversalNER (LLM-backed zero-shot, requires `llm` feature + API key)
            "universal_ner" | "universal-ner" | "universalner" => {
                use anno::backends::universal_ner::UniversalNER;
                let m = UniversalNER::new()?;
                if !m.is_available() {
                    return Err(crate::Error::FeatureNotAvailable(
                        "UniversalNER requires the `llm` feature and a non-empty API key. Set one of: OPENAI_API_KEY, ANTHROPIC_API_KEY, OPENROUTER_API_KEY, GEMINI_API_KEY, or UNIVERSAL_NER_API_KEY."
                            .to_string(),
                    ));
                }
                Ok(Box::new(m) as Box<dyn Model>)
            }

            // Unknown backend
            _ => Err(crate::Error::InvalidInput(format!(
                "Unknown backend: '{}'. Available: pattern, heuristic, stacked, crf, hmm, ensemble, heuristic_crf, tplinker{}",
                backend_name,
                if cfg!(feature = "onnx") {
                    ", bert_onnx, gliner_onnx, nuner, w2ner, gliner_multitask"
                } else {
                    ""
                }
            ))),
        }
    }

    /// List all available backends (based on enabled features).
    #[must_use]
    pub fn available_backends() -> Vec<&'static str> {
        #[allow(unused_mut)] // mut needed for extend/push calls
        let mut backends = vec![
            "pattern",
            "heuristic",
            "stacked",
            "crf",
            "hmm",
            "ensemble",
            "heuristic_crf",
            "tplinker",
        ];

        // UniversalNER requires the optional `llm` feature plus a non-empty API key.
        // If either is missing, treat it as unavailable to avoid “Feature not available”
        // failures in the matrix harness.
        if cfg!(feature = "llm") {
            anno::env::load_dotenv();
            if anno::env::has_llm_api_key() || std::env::var("UNIVERSAL_NER_API_KEY").is_ok() {
                backends.push("universal_ner");
            }
        }

        #[cfg(feature = "onnx")]
        {
            backends.extend(&[
                "bert_onnx",
                "gliner",
                "gliner_onnx",
                "nuner",
                "nuner_4k",
                "b2ner",
                "w2ner",
                "gliner_multitask",
                "gliner_pii",
                "gliner_relex",
                "gliner_poly",
            ]);

            // Optional backends that require explicit local ONNX exports.
            if std::env::var("DEBERTA_MODEL_PATH").is_ok() {
                backends.push("deberta_v3");
            }
            if std::env::var("ALBERT_MODEL_PATH").is_ok() {
                backends.push("albert");
            }
        }

        #[cfg(feature = "candle")]
        {
            backends.extend(&["candle_ner", "gliner_candle"]);
            // `gliner` is also available as an alias when candle is enabled
            // (and onnx is not required).
            if !cfg!(feature = "onnx") {
                backends.push("gliner");
            }
        }

        #[cfg(all(feature = "candle", feature = "onnx"))]
        {
            backends.push("gliner_multitask_candle");
        }

        backends
    }

    /// List all available coreference resolvers.
    ///
    /// Coreference resolvers are *not* `Model`s, so they are kept separate from
    /// [`Self::available_backends`]. They are used by `TaskEvaluator` for coref-family tasks.
    #[must_use]
    pub fn available_coref_resolvers() -> Vec<&'static str> {
        vec!["coref_resolver", "mention_ranking"]
    }

    /// Check if a backend is available (feature-enabled).
    #[must_use]
    pub fn is_available(backend_name: &str) -> bool {
        Self::available_backends().contains(&backend_name.to_lowercase().as_str())
    }
}

/// Helper to create a coreference resolver from a name.
///
/// Note: Coreference resolvers don't implement `Model`, so this is separate.
pub fn create_coref_resolver(
    name: &str,
) -> Result<Box<dyn crate::eval::coref_resolver::CoreferenceResolver>> {
    match name.to_lowercase().as_str() {
        "coref_resolver" | "simplecorefresolver" | "simple" => {
            use crate::eval::coref_resolver::{CorefConfig, SimpleCorefResolver};
            Ok(Box::new(SimpleCorefResolver::new(CorefConfig::default())))
        }
        "mention_ranking" | "mention-ranking" | "mentionranking" => {
            use anno::backends::coref::mention_ranking::MentionRankingCoref;
            Ok(Box::new(MentionRankingCoref::new()))
        }
        _ => Err(crate::Error::InvalidInput(format!(
            "Unknown coreference resolver: '{}'. Available: coref_resolver, mention_ranking",
            name
        ))),
    }
}

/// Create a text-based coreference backend (CorefBackend trait).
///
/// Unlike `create_coref_resolver` which takes pre-extracted entities,
/// `CorefBackend` operates on raw text and returns mention clusters directly.
/// This is the interface used by neural coref models (FCoref, MentionRanking).
pub fn create_coref_backend(name: &str) -> Result<Box<dyn anno::CorefBackend>> {
    match name.to_lowercase().as_str() {
        "mention_ranking" | "mention-ranking" | "mentionranking" => {
            use anno::backends::coref::mention_ranking::MentionRankingCoref;
            Ok(Box::new(MentionRankingCoref::new()))
        }
        #[cfg(feature = "onnx")]
        "fcoref" | "f-coref" | "fastcoref" => {
            use anno::backends::coref::fcoref::FCoref;
            let model_path = std::env::var("FCOREF_MODEL_PATH").ok();
            let fcoref = if let Some(path) = model_path {
                FCoref::from_path(&path)?
            } else {
                FCoref::from_pretrained("biu-nlp/f-coref")?
            };
            Ok(Box::new(fcoref))
        }
        #[cfg(not(feature = "onnx"))]
        "fcoref" | "f-coref" | "fastcoref" => Err(crate::Error::FeatureNotAvailable(
            "FCoref requires 'onnx' feature. Export: uv run scripts/export_fcoref.py".to_string(),
        )),
        _ => Err(crate::Error::InvalidInput(format!(
            "Unknown coref backend: '{}'. Available: mention_ranking, fcoref",
            name
        ))),
    }
}

/// List available coref backends (text-based CorefBackend).
pub fn available_coref_backends() -> Vec<&'static str> {
    #[allow(unused_mut)]
    let mut backends = vec!["mention_ranking"];
    #[cfg(feature = "onnx")]
    {
        backends.push("fcoref");
    }
    backends
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn known_backends_construct_with_expected_name_prefix() {
        // Stacked reports a composite name like "stacked(regex+heuristic)", so
        // match against a prefix per backend rather than exact-equality.
        let cases = [
            ("pattern", "regex"),
            ("heuristic", "heuristic"),
            ("stacked", "stacked"),
        ];
        for (alias, expected_prefix) in cases {
            let model = BackendFactory::create(alias).unwrap();
            let name = model.name();
            assert!(
                name.starts_with(expected_prefix),
                "for alias {alias:?}: expected prefix {expected_prefix:?}, got {name:?}"
            );
        }
    }

    #[test]
    fn test_unknown_backend() {
        let backend = BackendFactory::create("nonexistent");
        assert!(backend.is_err());
    }

    #[test]
    fn test_available_backends() {
        let backends = BackendFactory::available_backends();
        assert!(backends.contains(&"pattern"));
        assert!(backends.contains(&"heuristic"));
        assert!(backends.contains(&"stacked"));
    }
}

#[cfg(test)]
mod additional_tests {
    use super::*;

    #[test]
    fn test_backend_factory_pattern_returns_regex_only() {
        let model = BackendFactory::create("pattern").unwrap();
        println!("Model name: {}", model.name());
        assert_eq!(model.name(), "regex", "pattern should return RegexNER");

        let entities = model
            .extract_entities("John Smith went to Paris", None)
            .unwrap();
        println!("Entities: {:?}", entities);

        // Should NOT have PER or LOC
        for e in &entities {
            assert!(
                !matches!(e.entity_type, crate::EntityType::Person),
                "Unexpected Person entity: {:?}",
                e
            );
            assert!(
                !matches!(e.entity_type, crate::EntityType::Location),
                "Unexpected Location entity: {:?}",
                e
            );
        }
    }
}