parla-clean 0.1.0

Deterministic post-processing for Brazilian Portuguese speech transcription: filler removal, vocabulary variant correction, ASR deduplication
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
//! Avaliação word-level do pipeline (Ferguson et al. 2015 — ver ADR-0009).
//!
//! Corpus de ouro versionado + métricas P/R/F1 em nível de palavra:
//! para cada caso, `reference_removed` = palavras do input ausentes do
//! gold (o que a limpeza DEVERIA remover); `got_removed` = palavras do
//! input ausentes do output (o que o pipeline removeu). Cruzando os dois:
//! TP = removeu o certo, FP = removeu o que deveria ficar, FN = deixou o
//! que deveria remover. Casos marcados como guarda (gold == input) exigem
//! FP = 0 — é onde "em dúvida, não mexe" é medido.
//!
//! As métricas saem AGREGADAS e POR TAG (categoria): um caso pode ter
//! várias tags ("filler", "guarda", "variante", "dedupe", "normaliza",
//! "link", "unicode", "numero", "punct") — cada tag agrega os casos que a
//! carregam, permitindo localizar em qual categoria uma regressão caiu.
//!
//! Roda em `cargo test --lib`; o mesmo harness serve de gate de CI quando
//! o projeto for publicado (ADR-0010).

use std::collections::HashMap;

use super::CleanConfig;

/// Caso de avaliação: entrada, saída esperada (gold), vocabulário e tags
/// para segmentar as métricas por categoria.
pub struct GoldenCase {
    pub input: &'static str,
    pub expected: &'static str,
    pub vocab: &'static [&'static str],
    pub tags: &'static [&'static str],
}

/// Métricas de uma categoria (ou agregadas — palavra = run de
/// letras/números, lowercase).
#[derive(Debug, Clone, Copy, Default, PartialEq)]
pub struct Metrics {
    pub tp: usize,
    pub fp: usize,
    pub fn_: usize,
    pub cases: usize,
    pub exact: usize,
}

impl Metrics {
    pub fn precision(&self) -> f64 {
        let d = (self.tp + self.fp) as f64;
        if d == 0.0 { 1.0 } else { self.tp as f64 / d }
    }

    pub fn recall(&self) -> f64 {
        let d = (self.tp + self.fn_) as f64;
        if d == 0.0 { 1.0 } else { self.tp as f64 / d }
    }

    pub fn f1(&self) -> f64 {
        let (p, r) = (self.precision(), self.recall());
        if p + r == 0.0 { 0.0 } else { 2.0 * p * r / (p + r) }
    }
}

/// Resultado de uma avaliação: agregado + por categoria (tag).
#[derive(Debug, Clone, PartialEq)]
pub struct EvalReport {
    pub total: Metrics,
    pub per_tag: HashMap<&'static str, Metrics>,
}

/// Roda o pipeline (config padrão) sobre o corpus.
pub fn evaluate(cases: &[GoldenCase]) -> EvalReport {
    let mut total = Metrics::default();
    let mut per_tag: HashMap<&'static str, Metrics> = HashMap::new();
    let default_vocab: Vec<String> = Vec::new();
    for case in cases {
        let vocab: Vec<String> = if case.vocab.is_empty() {
            default_vocab.clone()
        } else {
            case.vocab.iter().map(|s| s.to_string()).collect()
        };
        let got = super::clean_text_with(case.input, &vocab, &CleanConfig::default()).text;
        accumulate(&mut total, case.input, case.expected, &got);
        for tag in case.tags {
            accumulate(per_tag.entry(tag).or_default(), case.input, case.expected, &got);
        }
    }
    EvalReport { total, per_tag }
}

/// Acumula um caso em `m` (exato + TP/FP/FN word-level).
fn accumulate(m: &mut Metrics, input: &str, expected: &str, got: &str) {
    m.cases += 1;
    if got == expected {
        m.exact += 1;
    }
    let ref_removed = words_removed(input, expected);
    let got_removed = words_removed(input, got);
    for w in &ref_removed {
        if got_removed.contains(w) {
            m.tp += 1;
        } else {
            m.fn_ += 1;
        }
    }
    for w in &got_removed {
        if !ref_removed.contains(w) {
            m.fp += 1;
        }
    }
}

/// Palavras (multiset, lowercase) presentes em `a` e ausentes em `b`.
fn words_removed(a: &str, b: &str) -> Vec<String> {
    let wa = words(a);
    let wb = words(b);
    let mut out: Vec<String> = Vec::new();
    for w in wa {
        if !wb.contains(&w) {
            out.push(w);
        }
    }
    out
}

/// Palavras de conteúdo de um texto: separa em QUALQUER não-alfanumérico
/// (espaço ou pontuação), lowercase — "A2.@Eét" → "a2" + "eét".
fn words(s: &str) -> Vec<String> {
    s.split(|c: char| !c.is_alphanumeric())
        .filter(|w| !w.is_empty())
        .map(|w| w.to_lowercase())
        .collect()
}

/// Corpus de ouro — regressões reais da v1 + casos novos da v2 (ADR-0010).
/// Tags: filler / guarda / variante / dedupe / normaliza / unicode / link.
pub const GOLDEN_CORPUS: &[GoldenCase] = &[
    // ---- muletas ----
    GoldenCase {
        input: "tipo, o Sam Altman usa o Claude Code",
        expected: "O Sam Altman usa o Claude Code",
        vocab: &[],
        tags: &["filler"],
    },
    GoldenCase {
        input: "tipo assim, eu acho que a gente deveria melhorar isso né",
        expected: "Eu acho que a gente deveria melhorar isso.",
        vocab: &[],
        tags: &["filler"],
    },
    GoldenCase {
        input: "eu acho que, tipo, a gente vai",
        expected: "Eu acho que a gente vai",
        vocab: &[],
        tags: &["filler"],
    },
    GoldenCase {
        input: "a gente precisa disso né?",
        expected: "A gente precisa disso?",
        vocab: &[],
        tags: &["filler", "punct"],
    },
    GoldenCase {
        input: "isso vai dar certo, né não?",
        expected: "Isso vai dar certo?",
        vocab: &[],
        tags: &["filler", "punct"],
    },
    GoldenCase {
        input: "o projeto está bom, sabe?",
        expected: "O projeto está bom.",
        vocab: &[],
        tags: &["filler", "punct"],
    },
    GoldenCase {
        input: "vamos, então, começar",
        expected: "Vamos começar",
        vocab: &[],
        tags: &["filler"],
    },
    GoldenCase {
        input: "olha, isso aqui é importante",
        expected: "Isso aqui é importante",
        vocab: &[],
        tags: &["filler"],
    },
    GoldenCase {
        input: "a reunião é dia 15, tipo, às 14h30 né",
        expected: "A reunião é dia 15 às 14h30.",
        vocab: &[],
        tags: &["filler", "numero"],
    },
    // ---- guardas ("em dúvida, não mexe") ----
    GoldenCase {
        input: "que tipo de pessoa é essa",
        expected: "Que tipo de pessoa é essa",
        vocab: &[],
        tags: &["guarda"],
    },
    GoldenCase {
        input: "assim como o João disse",
        expected: "Assim como o João disse",
        vocab: &[],
        tags: &["guarda"],
    },
    GoldenCase {
        input: "estudei, então passei",
        expected: "Estudei, então passei",
        vocab: &[],
        tags: &["guarda"],
    },
    GoldenCase {
        input: "você sabe o que eu quero dizer",
        expected: "Você sabe o que eu quero dizer",
        vocab: &[],
        tags: &["guarda"],
    },
    GoldenCase {
        input: "tá bom, vamos nessa",
        expected: "Tá bom, vamos nessa",
        vocab: &[],
        tags: &["guarda"],
    },
    GoldenCase {
        input: "olha isso aqui",
        expected: "Olha isso aqui",
        vocab: &[],
        tags: &["guarda"],
    },
    GoldenCase {
        input: "muito muito bom",
        expected: "Muito muito bom",
        vocab: &[],
        tags: &["guarda"],
    },
    GoldenCase {
        input: "não, não, não quero",
        expected: "Não, não, não quero",
        vocab: &[],
        tags: &["guarda"],
    },
    // ---- variantes do vocabulário ----
    GoldenCase {
        input: "o sematlman usa o cloud code",
        expected: "O Sam Altman usa o Claude Code",
        vocab: &["Sam Altman", "Claude Code"],
        tags: &["variante"],
    },
    GoldenCase {
        input: "sam usa github e openai",
        expected: "Sam usa GitHub e OpenAI",
        vocab: &["GitHub", "ChatGPT", "OpenAI", "Anthropic"],
        tags: &["variante"],
    },
    GoldenCase {
        input: "moro em são paulo e falo com o josé",
        expected: "Moro em São Paulo e falo com o José",
        vocab: &["José", "São Paulo"],
        tags: &["variante", "unicode"],
    },
    GoldenCase {
        input: "o sematlman",
        expected: "O sematlman",
        vocab: &["Claude"],
        tags: &["guarda", "variante"],
    },
    // ---- dedupe ----
    GoldenCase {
        input: "eu eu acho que devemos",
        expected: "Eu acho que devemos",
        vocab: &[],
        tags: &["dedupe"],
    },
    GoldenCase {
        input: "OpenAI OpenAI OpenAI e o resto",
        expected: "OpenAI e o resto",
        vocab: &[],
        tags: &["dedupe"],
    },
    GoldenCase {
        input: "a reunião é 14h30 14h30",
        expected: "A reunião é 14h30",
        vocab: &[],
        tags: &["dedupe", "numero"],
    },
    // ---- normalização ----
    GoldenCase {
        input: "oi ,tudo bem",
        expected: "Oi, tudo bem",
        vocab: &[],
        tags: &["normaliza"],
    },
    GoldenCase {
        input: "primeiro item. segundo item!",
        expected: "Primeiro item. Segundo item!",
        vocab: &[],
        tags: &["normaliza"],
    },
    // ---- links (novo na v2) ----
    GoldenCase {
        input: "acesse https://tipo.com e fale com fulano@sabe.com",
        expected: "Acesse https://tipo.com e fale com fulano@sabe.com",
        vocab: &[],
        tags: &["link"],
    },
    GoldenCase {
        input: "visite tipo.com, tá?",
        expected: "Visite tipo.com.",
        vocab: &[],
        tags: &["link"],
    },
    GoldenCase {
        input: "acesse semantic.technology hoje",
        expected: "Acesse semantic.technology hoje",
        vocab: &[],
        tags: &["link"],
    },
];

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

    #[test]
    fn golden_corpus_all_pass_exactly() {
        let r = evaluate(GOLDEN_CORPUS);
        assert_eq!(r.total.exact, r.total.cases, "casos divergentes do gold");
        assert_eq!(r.total.tp, r.total.tp + r.total.fn_, "recall deve ser 1.0 no corpus de ouro");
    }

    #[test]
    fn metrics_are_perfect_on_golden_corpus() {
        let r = evaluate(GOLDEN_CORPUS);
        assert_eq!(r.total.precision(), 1.0);
        assert_eq!(r.total.recall(), 1.0);
        assert_eq!(r.total.f1(), 1.0);
    }

    #[test]
    fn guard_cases_never_remove_content() {
        let r = evaluate(GOLDEN_CORPUS);
        assert_eq!(r.total.fp, 0, "guarda removida = falso positivo");
        // na categoria "guarda" (gold == input), tudo precisa ser exato
        let guard = r.per_tag["guarda"];
        assert_eq!(guard.fp, 0);
        assert_eq!(guard.exact, guard.cases);
    }

    #[test]
    fn per_tag_metrics_segment_categories() {
        let r = evaluate(GOLDEN_CORPUS);
        for tag in [
            "filler", "guarda", "variante", "dedupe", "normaliza", "link",
            "punct", "unicode", "numero",
        ] {
            let m = r.per_tag.get(tag).unwrap_or_else(|| panic!("tag '{tag}' sem casos no corpus"));
            assert_eq!(m.precision(), 1.0, "precision na tag '{tag}'");
            assert_eq!(m.recall(), 1.0, "recall na tag '{tag}'");
            assert!(m.cases > 0, "tag '{tag}' sem casos");
        }
    }

    #[test]
    fn words_helper_strips_punctuation() {
        assert_eq!(words("Oi, tudo bem!"), vec!["oi", "tudo", "bem"]);
        assert_eq!(
            words_removed("tipo, vamos agora", "Vamos agora"),
            vec!["tipo"]
        );
    }

    // -----------------------------------------------------------------
    // Gate de CI (re-revisão externa, item 5.1) — métricas NUNCA podem
    // cair abaixo do baseline versionado em tests/golden/baseline.json
    // -----------------------------------------------------------------

    #[test]
    fn ci_gate_guard_is_never_violated() {
        // não-negociável: "em dúvida, não mexe" (ADR-0009) — FP em guarda
        // é regressão de PRODUTO, não de qualidade
        let r = evaluate(GOLDEN_CORPUS);
        let guard = r.per_tag.get("guarda").expect("tag 'guarda' deve existir");
        assert_eq!(guard.precision(), 1.0, "CRÍTICO: precisão em 'guarda' caiu");
        assert_eq!(guard.fp, 0, "CRÍTICO: falso positivo em 'guarda'");
        assert_eq!(guard.exact, guard.cases, "CRÍTICO: guarda com gold != input");
    }

    #[test]
    fn ci_gate_metrics_stay_above_baseline() {
        // baseline versionado: tests/golden/baseline.json (P/R/F1 por tag
        // da última release). Queda abaixo = regressão → build falha.
        let r = evaluate(GOLDEN_CORPUS);
        let baseline: serde_json::Value =
            serde_json::from_str(include_str!("../../tests/golden/baseline.json"))
                .expect("baseline.json inválido");
        let per_tag = baseline["por_tag"]
            .as_object()
            .expect("baseline sem 'por_tag'");
        let eps = 1e-9;
        for (tag, values) in per_tag {
            let m = r.per_tag.get(tag.as_str()).unwrap_or_else(|| {
                panic!("tag '{tag}' do baseline sem casos no corpus atual")
            });
            let min_p = values["precision"].as_f64().expect("precision");
            let min_r = values["recall"].as_f64().expect("recall");
            assert!(
                m.precision() + eps >= min_p,
                "regressão em '{tag}': precision {} < baseline {min_p}",
                m.precision()
            );
            assert!(
                m.recall() + eps >= min_r,
                "regressão em '{tag}': recall {} < baseline {min_r}",
                m.recall()
            );
        }
        // piso de segurança além do baseline: nenhuma categoria pode cair
        // abaixo de 0.95 sem revisão explícita
        for tag in ["filler", "variante", "dedupe", "normaliza", "link"] {
            let m = r.per_tag.get(tag).unwrap();
            assert!(m.precision() >= 0.95, "regressão em '{tag}': precision = {}", m.precision());
            assert!(m.recall() >= 0.95, "regressão em '{tag}': recall = {}", m.recall());
        }
    }
}