Struct ReferenceCandidate 

pub struct ReferenceCandidate {
    pub entity_id: u64,
    pub description: String,
    pub weight: f64,
    pub source: CandidateSource,
    pub satisfied_constraints: Vec<String>,
    pub violated_constraints: Vec<String>,
}

A candidate referent for uncertain reference resolution.

Each candidate represents a possible antecedent with an associated weight (in log-odds space for numerical stability) and metadata about how it was identified and which constraints it satisfies or violates.

Example

use anno::discourse::uncertain_reference::{ReferenceCandidate, CandidateSource};

let candidate = ReferenceCandidate::new(1, "John Smith", 0.8)
    .with_source(CandidateSource::Discourse)
    .satisfies("gender:masculine")
    .satisfies("number:singular");

// Check for hard constraint violations
let bad_candidate = ReferenceCandidate::new(2, "they", 0.6)
    .violates("number:singular");  // "they" violates singular constraint

assert!(!candidate.has_violations());
assert!(bad_candidate.has_violations());

Fields

entity_id: u64

Entity/cluster ID (links to coreference cluster).

description: String

Surface form or description (e.g., “John”, “the CEO”).

weight: f64

Weight in log-odds space. Higher = more likely. Use update_evidence to adjust, and probabilities to convert to probabilities via softmax.

source: CandidateSource

How this candidate was identified (discourse, bridging, world knowledge).

satisfied_constraints: Vec<String>

Constraints this candidate satisfies (e.g., “gender:masculine”).

violated_constraints: Vec<String>

Constraints this candidate violates. Hard constraint violations can be pruned via UncertainReference::prune_violations.

Implementations

impl ReferenceCandidate

pub fn new( entity_id: u64, description: impl Into<String>, weight: f64, ) -> ReferenceCandidate

Create a new candidate.

pub fn with_source(self, source: CandidateSource) -> ReferenceCandidate

Set the source of this candidate.

pub fn satisfies(self, constraint: impl Into<String>) -> ReferenceCandidate

Add a satisfied constraint.

pub fn violates(self, constraint: impl Into<String>) -> ReferenceCandidate

Add a violated constraint.

pub fn has_violations(&self) -> bool

Check if this candidate has violations.

Trait Implementations

impl Clone for ReferenceCandidate

fn clone(&self) -> ReferenceCandidate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferenceCandidate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReferenceCandidate

fn deserialize<__D>( __deserializer: __D, ) -> Result<ReferenceCandidate, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ReferenceCandidate

fn eq(&self, other: &ReferenceCandidate) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ReferenceCandidate

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReferenceCandidate