german-impressum-extractor 0.1.0

Extract structured data from German B2B website Impressum text — email, phone, address, HR-Nummer, USt-IdNr., Geschäftsführer names, legal form, and more. Pure-Rust, no async.
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

//! Scored extraction results (TP2). [`crate::extract_all_scored`] returns a
//! [`ScoredExtracted`]; each field carries a heuristic confidence in
//! `0.0..=1.0` (higher means more likely correct).

use crate::Person;

/// A value paired with a heuristic confidence in `0.0..=1.0`.
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Scored<T> {
    /// The extracted value — identical to what the unscored `extract_all` returns.
    pub value: T,
    /// Heuristic confidence in `0.0..=1.0`; higher means more likely correct.
    pub confidence: f32,
}

/// Scored counterpart of [`crate::Extracted`]: the same fields, each annotated
/// with a confidence. Returned by [`crate::extract_all_scored`].
#[derive(Debug, Clone, Default, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub struct ScoredExtracted {
    /// Scored email addresses.
    pub emails: Vec<Scored<String>>,
    /// Scored phone numbers.
    pub phones: Vec<Scored<String>>,
    /// Scored fax number, if any.
    pub fax: Option<Scored<String>>,
    /// Scored postcode.
    pub postcode: Option<Scored<String>>,
    /// Scored city.
    pub city: Option<Scored<String>>,
    /// Scored street.
    pub street: Option<Scored<String>>,
    /// Scored Handelsregister number.
    pub hr_number: Option<Scored<String>>,
    /// Scored Handelsregister court.
    pub hr_court: Option<Scored<String>>,
    /// Scored USt-IdNr. (VAT ID).
    pub vat_id: Option<Scored<String>>,
    /// Scored Steuernummer.
    pub tax_number: Option<Scored<String>>,
    /// Scored IBAN.
    pub iban: Option<Scored<String>>,
    /// Scored BIC.
    pub bic: Option<Scored<String>>,
    /// Scored legal form.
    pub legal_form: Option<Scored<String>>,
    /// Scored founding year.
    pub year_founded: Option<Scored<i32>>,
    /// Scored persons.
    pub persons: Vec<Scored<Person>>,
    /// Scored Handelsregister section (HRA/HRB).
    pub register_type: Option<Scored<String>>,
    /// Scored supervisory authority ("Aufsichtsbehörde").
    pub supervisory_authority: Option<Scored<String>>,
    /// Scored professional chamber ("zuständige Kammer" / "Berufskammer").
    pub professional_chamber: Option<Scored<String>>,
    /// Scored De-Mail address.
    pub de_mail: Option<Scored<String>>,
    /// Scored EU Online-Dispute-Resolution (OS-Plattform) URL.
    pub dispute_resolution_url: Option<Scored<String>>,
}

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

    #[test]
    fn scored_holds_value_and_confidence() {
        let s = Scored {
            value: "info@a.de".to_string(),
            confidence: 0.85,
        };
        assert_eq!(s.value, "info@a.de");
        assert!((s.confidence - 0.85).abs() < f32::EPSILON);
        let d = ScoredExtracted::default();
        assert!(d.emails.is_empty() && d.iban.is_none());
    }
}