Trait Model

Source

pub trait Model:
    Sealed
    + Send
    + Sync {
    // Required methods
    fn extract_entities(
        &self,
        text: &str,
        language: Option<&str>,
    ) -> Result<Vec<Entity>>;
    fn supported_types(&self) -> Vec<EntityType>;
    fn is_available(&self) -> bool;

    // Provided methods
    fn name(&self) -> &'static str { ... }
    fn description(&self) -> &'static str { ... }
    fn capabilities(&self) -> ModelCapabilities { ... }
    fn version(&self) -> String { ... }
}

Expand description

Trait for NER model backends.

§Sealed Trait

Model is intentionally sealed (cannot be implemented outside this crate) to:

Maintain invariants: All backends must produce entities with valid character offsets, confidence in [0, 1], and non-empty text.
Allow evolution: New methods can be added with default implementations without breaking external code.
Ensure consistency: All backends share standardized behavior for is_available(), supported_types(), etc.

§For External Backends

If you need to integrate an external NER backend (e.g., a REST API, Python model via PyO3, or custom implementation), use the AnyModel wrapper:

use anno::{AnyModel, Entity, EntityType, Result};

struct MyExternalNER { /* ... */ }

impl MyExternalNER {
    fn extract(&self, text: &str) -> Vec<Entity> {
        // Your implementation
        vec![]
    }
}

// Wrap in AnyModel to use with anno's infrastructure
let model = AnyModel::new(
    "my-ner",
    vec![EntityType::Person, EntityType::Organization],
    move |text, _lang| Ok(my_ner.extract(text)),
);

// Now usable wherever Box<dyn Model> is expected
let entities = model.extract_entities("Hello world", None)?;