Enum EntityCategory 

#[non_exhaustive]
pub enum EntityCategory {
    Agent,
    Organization,
    Place,
    Creative,
    Temporal,
    Numeric,
    Contact,
    Relation,
    Misc,
}

Category of entity based on detection characteristics and semantics.

Based on OntoNotes 5.0 categories with extensions for:

• Structured data (Contact, patterns)
• Knowledge graphs (Relation, for TPLinker/GLiNER joint extraction)

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Agent

Named entities for people/groups (ML-required). Types: Person, NORP (nationalities/religious/political groups)

Organization

Named entities for organizations/facilities (ML-required). Types: Organization, Facility

Place

Named entities for places (ML-required). Types: GPE (geo-political), Location (geographic)

Creative

Named entities for creative/conceptual (ML-required). Types: Event, Product, WorkOfArt, Law, Language

Temporal

Temporal entities (pattern-detectable). Types: Date, Time

Numeric

Numeric entities (pattern-detectable). Types: Money, Percent, Quantity, Cardinal, Ordinal

Contact

Contact/identifier entities (pattern-detectable). Types: Email, Url, Phone

Relation

Relation triggers for knowledge graph construction (ML-required). Examples: “CEO of”, “located in”, “founded by” In GLiNER bi-encoder, relations are just another label to match.

Misc

Miscellaneous/unknown category

Implementations

impl EntityCategory

pub const fn requires_ml(&self) -> bool

Returns true if this category requires ML for detection.

pub const fn pattern_detectable(&self) -> bool

Returns true if this category can be detected via patterns.

pub const fn is_relation(&self) -> bool

Returns true if this is a relation (for knowledge graph construction).

pub const fn as_str(&self) -> &'static str

Returns OntoNotes-compatible category name.

Trait Implementations

impl Clone for EntityCategory

fn clone(&self) -> EntityCategory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityCategory

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityCategory

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EntityCategory

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

Formats the value using the given formatter.

impl Hash for EntityCategory

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EntityCategory

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

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 Copy for EntityCategory

impl Eq for EntityCategory

impl StructuralPartialEq for EntityCategory