Struct NlpFact 

#[non_exhaustive]
pub struct NlpFact {
    pub head: usize,
    pub tail: usize,
    pub relation: String,
    pub margin: f32,
    pub polarity: FactPolarity,
    pub modality: FactModality,
    pub holder: Option<usize>,
    pub time: Option<usize>,
}

One extracted fact: a relation between two entities, with its attributes.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

head: usize

Index into NlpWindow::entities of the head (subject).

tail: usize

Index into NlpWindow::entities of the tail (object).

relation: String

The relation name, as given in ExtractionSchema::relations.

margin: f32

Calibrated margin over the model’s keep threshold. Always > 0 for a reported fact; larger is surer.

Not a probability. Map it to one with sigmoid if a confidence is wanted, and tune a relation’s threshold through NlpCalibrationOverrides::rel_offsets rather than by filtering on the margin.

polarity: FactPolarity

Whether the fact is asserted or denied.

modality: FactModality

How the fact is held: asserted, planned, merely questioned, and so on.

holder: Option<usize>

Index into NlpWindow::entities of whoever holds this belief, when the model found one — the speaker for "I live in Lisbon", the reporter for "Leon says I work at Northstar".

time: Option<usize>

Index into NlpWindow::entities of a temporal entity anchoring the fact. Only ever set when the schema has temporal entity types.

Trait Implementations

impl Clone for NlpFact

fn clone(&self) -> NlpFact

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NlpFact

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

Formats the value using the given formatter.

impl Default for NlpFact

fn default() -> NlpFact

Returns the “default value” for a type.