Skip to main content

Entity

Struct Entity 

Source
pub struct Entity {
    pub base: DataPoint,
    pub name: String,
    pub is_a: Option<Uuid>,
    pub description: String,
}
Expand description

Storage-layer entity model.

Represents an entity (e.g., “TechCorp”, “Alice”, “London”) extracted from text. Each entity has a name, description, and a reference to its EntityType (e.g., “Organization”, “Person”, “Location”).

Fields§

§base: DataPoint

Base data point fields (id, timestamps, metadata, etc.)

§name: String

Entity name (e.g., “TechCorp”)

§is_a: Option<Uuid>

Reference to EntityType UUID (e.g., UUID of “Organization” type)

§description: String

Entity description from LLM extraction

Implementations§

Source§

impl Entity

Source

pub const INDEX_FIELDS: &'static [&'static str]

Index fields to embed for vector search.

Source

pub fn new( name: impl Into<String>, entity_type_id: Option<Uuid>, description: impl Into<String>, dataset_id: Option<Uuid>, ) -> Self

Create a new Entity.

§Arguments
  • name - Entity name
  • entity_type_id - Optional reference to EntityType
  • description - Entity description
  • dataset_id - Dataset UUID
Source

pub fn from_node( node_id: impl Into<String>, node_name: impl Into<String>, node_description: impl Into<String>, entity_type_id: Uuid, dataset_id: Option<Uuid>, ) -> Self

Create Entity from LLM-extracted Node.

§Arguments
  • node_id - Original node ID from LLM extraction
  • node_name - Node name
  • node_description - Node description
  • entity_type_id - EntityType UUID
  • dataset_id - Dataset UUID
Source

pub fn get_embeddable_text(&self) -> String

Get the entity name (for embedding).

Source

pub fn set_description(&mut self, description: impl Into<String>)

Update entity description.

Source

pub fn set_entity_type(&mut self, entity_type_id: Uuid)

Update entity type reference.

Trait Implementations§

Source§

impl Clone for Entity

Source§

fn clone(&self) -> Entity

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Entity

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl HasDataPoint for Entity

Source§

fn data_point(&self) -> &DataPoint

Borrow the embedded DataPoint of this container.
Source§

fn data_point_mut(&mut self) -> &mut DataPoint

Mutably borrow the embedded DataPoint of this container.
Source§

fn for_each_child_mut(&mut self, _visit: &mut dyn FnMut(&mut dyn HasDataPoint))

Visit every owned child that itself implements HasDataPoint. Default: no children. Override on container types whose fields own (rather than reference by Uuid) another HasDataPoint.
Source§

impl PartialEq for Entity

Source§

fn eq(&self, other: &Entity) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Entity

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Entity

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.