Skip to main content

EntityLinker

Struct EntityLinker 

Source
pub struct EntityLinker {
    pub min_mention_len: usize,
    pub threshold: f64,
    /* private fields */
}
Expand description

String-to-entity linker backed by an in-memory knowledge base.

Fields§

§min_mention_len: usize

Minimum character length of a text span to be considered as a mention.

§threshold: f64

Minimum combined score for a candidate to be returned.

Implementations§

Source§

impl EntityLinker

Source

pub fn new(threshold: f64) -> Self

Create an empty linker with the given minimum combined score threshold.

Source

pub fn add_entity(&mut self, entity: Entity)

Add a single entity to the knowledge base and update the index.

Source

pub fn add_entities(&mut self, entities: Vec<Entity>)

Add multiple entities in bulk and rebuild the index.

Source

pub fn entity_count(&self) -> usize

Total number of entities in the knowledge base.

Source

pub fn detect_mentions(&self, text: &str) -> Vec<EntityMention>

Scan text for all known entity labels / aliases and return mentions.

Both exact (case-insensitive) and fuzzy (similarity ≥ 0.7) matches are considered. Overlapping spans from the same starting position are de-duplicated in favour of the longer match.

Link all mentions found in text to their best entity candidates.

§Errors
  • LinkerError::EmptyText if text is empty after trimming.
  • LinkerError::EmptyKnowledgeBase if no entities have been added.

Find all entity candidates for an arbitrary mention string.

Searches all entity labels and aliases using both exact (lowercase) and fuzzy matching. Results are sorted by score descending.

Source

pub fn find_by_iri(&self, iri: &str) -> Option<&Entity>

Look up an entity by its exact IRI.

Source

pub fn string_similarity(a: &str, b: &str) -> f64

Normalised edit-distance similarity: 1 − edit_distance(a, b) / max(|a|, |b|).

Returns 1.0 for identical strings and 0.0 when the edit distance equals the length of the longer string.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,