Struct GoldEntity 

pub struct GoldEntity {
    pub text: String,
    pub entity_type: EntityType,
    pub original_label: String,
    pub start: usize,
    pub end: usize,
}

Gold standard entity annotation.

This is the canonical entity type for all NER evaluation. Use this instead of creating local entity structs.

Example

use anno_eval::eval::GoldEntity;
use anno::EntityType;

let entity = GoldEntity::new("John Doe", EntityType::Person, 0);
assert_eq!(entity.end, 8);

Fields

text: String

The entity text (surface form)

entity_type: EntityType

Normalized entity type

original_label: String

Original label from dataset (e.g., “B-PER”, “ACTOR”)

start: usize

Character offset (start)

end: usize

Character offset (end, exclusive)

Implementations

impl GoldEntity

pub fn new( text: impl Into<String>, entity_type: EntityType, start: usize, ) -> Self

Create a new gold entity with computed end offset.

Note: Uses character count (not byte count) for Unicode correctness.

pub fn with_span( text: impl Into<String>, entity_type: EntityType, start: usize, end: usize, ) -> Self

Create with explicit span (start, end).

pub fn with_label( text: impl Into<String>, entity_type: EntityType, original_label: impl Into<String>, start: usize, ) -> Self

Create with explicit original label.

Note: Uses character count (not byte count) for Unicode correctness.

pub fn full( text: impl Into<String>, entity_type: EntityType, original_label: impl Into<String>, start: usize, end: usize, ) -> Self

Create with all fields explicit.

pub fn overlaps(&self, other: &Self) -> bool

Check if this entity overlaps with another.

pub fn extract_text(&self, source_text: &str) -> String

Safely extract text from source using character offsets.

GoldEntity stores character offsets, not byte offsets. This method correctly extracts text by iterating over characters.

Arguments

• source_text - The original text from which this entity was extracted

Returns

The extracted text, or empty string if offsets are invalid

pub fn span_matches(&self, other: &Self) -> bool

Check if spans match exactly.

pub fn exact_matches(&self, other: &Self) -> bool

Check if this is an exact match (span + type).

Trait Implementations

impl Clone for GoldEntity

fn clone(&self) -> GoldEntity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GoldEntity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GoldEntity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GoldEntity

fn eq(&self, other: &GoldEntity) -> 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 GoldEntity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GoldEntity