Struct Entity 

pub struct Entity {
    pub id: EntityId,
    pub entity_type: EntityType,
    pub name: String,
    pub aliases: Vec<String>,
    pub domain: Domain,
    pub confidence: f32,
    pub valid_time: ValidTimeRange,
    pub transaction_time: TransactionTime,
    pub properties: HashMap<String, String>,
    pub mention_count: u32,
}

An entity in the knowledge graph.

Entities represent real-world concepts extracted from memories, such as people, organizations, technologies, and files.

Fields

id: EntityId

Unique identifier for this entity.

entity_type: EntityType

Type of entity.

name: String

Canonical name for the entity.

aliases: Vec<String>

Alternative names or aliases.

domain: Domain

Domain scope for the entity.

confidence: f32

Confidence score from extraction (0.0 to 1.0).

valid_time: ValidTimeRange

Bitemporal: when this entity was valid in the real world.

transaction_time: TransactionTime

Bitemporal: when this entity was recorded in the system.

properties: HashMap<String, String>

Optional properties as key-value pairs.

mention_count: u32

Number of times this entity has been mentioned.

Implementations

impl Entity

pub fn new( entity_type: EntityType, name: impl Into<String>, domain: Domain, ) -> Self

Creates a new entity with default temporal values.

pub fn with_id(self, id: EntityId) -> Self

Creates an entity with a specific ID.

pub fn with_confidence(self, confidence: f32) -> Self

Sets the confidence score.

pub fn with_alias(self, alias: impl Into<String>) -> Self

Adds an alias to the entity.

pub fn with_aliases( self, aliases: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Adds multiple aliases to the entity.

pub fn with_valid_time(self, valid_time: ValidTimeRange) -> Self

Sets the valid time range.

pub fn with_property( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Adds a property to the entity.

pub fn matches_name(&self, name: &str) -> bool

Returns true if this entity matches a name (canonical or alias).

pub fn is_valid_at(&self, timestamp: i64) -> bool

Returns true if this entity is valid at the given time.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Entity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Entity

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

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 Entity