Struct DiscourseReferent 

pub struct DiscourseReferent {
    pub referent_type: ReferentType,
    pub start: usize,
    pub end: usize,
    pub label: Option<String>,
    pub text: Option<String>,
    pub event: Option<EventMention>,
    pub canonical_id: Option<CanonicalId>,
    pub confidence: Confidence,
    pub depth: u32,
}

A discourse referent - something that can be referred to by an anaphor.

This is the key data structure for abstract anaphora resolution. Unlike Entity which captures noun phrases, DiscourseReferent can represent entire clauses, events, propositions, etc.

Example

use anno::discourse::{DiscourseReferent, ReferentType, EventMention};

// "Russia invaded Ukraine in 2022. This caused inflation."
let event = EventMention::new("invaded", 7, 14);
let referent = DiscourseReferent::new(ReferentType::Event, 0, 30)
    .with_event(event)
    .with_label("Russian invasion");

assert_eq!(referent.span(), (0, 30));
assert!(referent.is_abstract());

Fields

referent_type: ReferentType

What kind of referent this is

start: usize

Start character offset (of the full discourse segment)

end: usize

End character offset (of the full discourse segment)

label: Option<String>

Human-readable label for this referent

text: Option<String>

The full text of this referent (optional, for debugging)

event: Option<EventMention>

If this is an event, the event mention details

canonical_id: Option<CanonicalId>

Coreference cluster ID (shared with entities that refer to this)

confidence: Confidence

Confidence that this is a valid discourse referent

depth: u32

Discourse depth (how nested this referent is) 0 = main clause, 1 = subordinate, 2 = embedded subordinate, etc.

Implementations

impl DiscourseReferent

pub fn new( referent_type: ReferentType, start: usize, end: usize, ) -> DiscourseReferent

Create a new discourse referent.

pub fn from_entity(entity: &Entity) -> DiscourseReferent

Create a nominal referent from an Entity.

pub fn with_label(self, label: impl Into<String>) -> DiscourseReferent

Set a human-readable label.

pub fn with_text(self, text: impl Into<String>) -> DiscourseReferent

Set the text.

pub fn with_event(self, event: EventMention) -> DiscourseReferent

Attach an event mention.

pub fn with_canonical_id(self, id: impl Into<CanonicalId>) -> DiscourseReferent

Set the canonical ID.

pub fn with_confidence(self, confidence: f64) -> DiscourseReferent

Set confidence.

pub fn with_depth(self, depth: u32) -> DiscourseReferent

Set discourse depth.

pub const fn span(&self) -> (usize, usize)

Get the span as (start, end).

pub const fn len(&self) -> usize

Get span length.

pub const fn is_empty(&self) -> bool

Check if span is empty.

pub const fn is_abstract(&self) -> bool

Is this an abstract referent (not a nominal entity)?

pub fn display_text(&self) -> &str

Get the display text (label or text or type name).

Trait Implementations

impl Clone for DiscourseReferent

fn clone(&self) -> DiscourseReferent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiscourseReferent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DiscourseReferent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DiscourseReferent

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.