Struct EntityBuilder 

pub struct EntityBuilder { /* private fields */ }

Fluent builder for constructing entities with optional fields.

Example

use anno_core::{Entity, EntityType, Provenance};

let entity = Entity::builder("Marie Curie", EntityType::Person)
    .span(0, 11)
    .confidence(0.95)
    .kb_id("Q7186")
    .provenance(Provenance::ml("bert", 0.95))
    .build();

Implementations

impl EntityBuilder

pub fn new(text: impl Into<String>, entity_type: EntityType) -> EntityBuilder

Create a new builder.

pub const fn span(self, start: usize, end: usize) -> EntityBuilder

Set span offsets.

pub fn confidence(self, confidence: f64) -> EntityBuilder

Set confidence score.

pub fn hierarchical_confidence( self, confidence: HierarchicalConfidence, ) -> EntityBuilder

Set hierarchical confidence.

pub fn normalized(self, normalized: impl Into<String>) -> EntityBuilder

Set normalized form.

pub fn provenance(self, provenance: Provenance) -> EntityBuilder

Set provenance.

pub fn kb_id(self, kb_id: impl Into<String>) -> EntityBuilder

Set knowledge base ID.

pub const fn canonical_id(self, canonical_id: u64) -> EntityBuilder

Set canonical (coreference) ID.

pub fn visual_span(self, span: Span) -> EntityBuilder

Set visual span.

pub fn discontinuous_span(self, span: DiscontinuousSpan) -> EntityBuilder

Set discontinuous span for non-contiguous entities.

This automatically updates start and end to the bounding range.

pub fn valid_from(self, dt: DateTime<Utc>) -> EntityBuilder

Set temporal validity start (when this entity assertion became true).

Example

use anno_core::{EntityBuilder, EntityType};
use chrono::{TimeZone, Utc};

let entity = EntityBuilder::new("CEO of Microsoft", EntityType::Person)
    .span(0, 12)
    .valid_from(Utc.with_ymd_and_hms(2008, 10, 1, 0, 0, 0).unwrap())
    .build();
assert!(entity.valid_from.is_some());

pub fn valid_until(self, dt: DateTime<Utc>) -> EntityBuilder

Set temporal validity end (when this entity assertion stopped being true).

pub fn temporal_range( self, from: DateTime<Utc>, until: DateTime<Utc>, ) -> EntityBuilder

Set temporal validity range (convenience method).

pub fn viewport(self, viewport: EntityViewport) -> EntityBuilder

Set the viewport context for multi-faceted entity representation.

Example

use anno_core::{EntityBuilder, EntityType, EntityViewport};

let entity = EntityBuilder::new("Marie Curie", EntityType::Person)
    .span(0, 11)
    .viewport(EntityViewport::Academic)
    .build();
assert_eq!(entity.viewport, Some(EntityViewport::Academic));

pub fn build(self) -> Entity

Build the entity.

Trait Implementations

impl Clone for EntityBuilder

fn clone(&self) -> EntityBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EntityBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.