Struct Reference 

pub struct Reference {
    pub text: String,
    pub start: usize,
    pub end: usize,
    pub reference_type: ReferenceType,
    pub url: Option<String>,
    pub entity_id: Option<String>,
    pub title: Option<String>,
    pub antecedent: Option<String>,
    pub is_resolved: bool,
}

A detected reference in text.

Fields

text: String

The reference text as it appears in the document

start: usize

Start offset in the document

end: usize

End offset in the document

reference_type: ReferenceType

Type of reference

url: Option<String>

Resolved URL (if applicable)

entity_id: Option<String>

Entity ID if this is a KB link (e.g., Wikidata Q-number)

title: Option<String>

Title/name of the referenced resource (if known)

antecedent: Option<String>

The antecedent text this reference relates to (if any)

is_resolved: bool

Whether this reference has been resolved

Implementations

impl Reference

pub fn new( text: &str, start: usize, end: usize, ref_type: ReferenceType, ) -> Self

Create a new reference.

pub fn with_url(self, url: &str) -> Self

Set the URL.

pub fn with_entity_id(self, id: &str) -> Self

Set the entity ID.

pub fn with_antecedent(self, antecedent: &str) -> Self

Set the antecedent.

pub fn mark_resolved(self) -> Self

Mark as resolved.

pub fn wikidata_qid(&self) -> Option<&str>

Get the Wikidata Q-number if this is a Wikidata reference.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Reference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Reference

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Reference

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

where __S: Serializer,

Serialize this value into the given Serde serializer.