Skip to main content

KnowledgeBaseBuilder

Struct KnowledgeBaseBuilder 

Source
pub struct KnowledgeBaseBuilder { /* private fields */ }
Expand description

Incrementally builds and maintains a semantic knowledge base.

Supports entities, directed semantic relations, concept co-occurrence graphs, and document ingestion.

Implementations§

Source§

impl KnowledgeBaseBuilder

Source

pub fn new() -> Self

Create an empty KnowledgeBaseBuilder.

Source

pub fn add_entity(&mut self, entity: KbBuilderEntity) -> Result<(), KbError>

Add a new entity to the knowledge base.

Returns KbError::EntityAlreadyExists if an entity with the same ID was previously registered. Also registers all aliases in the alias index.

Source

pub fn update_entity( &mut self, entity_id: &str, update_fn: impl FnOnce(&mut KbBuilderEntity), ) -> Result<(), KbError>

Apply an in-place mutation to an existing entity.

Returns KbError::EntityNotFound if the ID is not registered. After mutation, re-indexes all aliases (including the primary name).

Source

pub fn remove_entity(&mut self, entity_id: &str) -> bool

Remove an entity and all relations that involve it.

Returns true if the entity existed.

Source

pub fn add_relation( &mut self, triple: KbTriple, confidence: f64, source: String, now: u64, ) -> Result<String, KbError>

Add a semantic relation from a triple.

Validates that both subject and object entities exist. The relation ID is the FNV-1a hash of subject_id + predicate + object_id.

Returns the relation ID on success. Returns KbError::RelationAlreadyExists if the same triple was already added.

Source

pub fn remove_relation(&mut self, relation_id: &str) -> bool

Remove the relation with the given ID.

Returns true if it existed.

Source

pub fn add_document(&mut self, doc: KbDocument) -> Result<(), KbError>

Ingest a document into the knowledge base.

Updates the concept graph for each concept in the document: increments frequency, records the document ID, and adds co-occurrence edges to every other concept in the same document.

Returns KbError::DocumentAlreadyExists if the doc_id is taken.

Source

pub fn find_entity_by_name(&self, name: &str) -> Option<&KbBuilderEntity>

Look up an entity by its primary name or any registered alias.

The comparison is case-insensitive.

Source

pub fn find_entity_by_alias(&self, alias: &str) -> Option<&KbBuilderEntity>

Look up an entity via the alias index (case-insensitive).

Source

pub fn relations_for_entity(&self, entity_id: &str) -> Vec<&KbRelation>

All relations where the entity is the subject or the object.

Source

pub fn outgoing_relations(&self, entity_id: &str) -> Vec<&KbRelation>

Relations where entity_id is the subject (outgoing).

Source

pub fn incoming_relations(&self, entity_id: &str) -> Vec<&KbRelation>

Relations where entity_id is the object (incoming).

Source

pub fn entity_neighbors(&self, entity_id: &str) -> Vec<&KbBuilderEntity>

Entities directly connected to entity_id via any relation (neighbours).

Source

pub fn path_between( &self, from_id: &str, to_id: &str, max_hops: usize, ) -> Option<Vec<String>>

Find the shortest path between two entities via BFS over relations.

Returns a sequence of entity IDs (inclusive of from_id and to_id), or None if no path exists within max_hops.

Source

pub fn top_concepts(&self, n: usize) -> Vec<&KbConceptNode>

Return the top n concept nodes by frequency, descending.

Source

pub fn concept_cooccurrence(&self, concept_a: &str, concept_b: &str) -> usize

Count how many documents mention both concept_a and concept_b.

Source

pub fn entity_count(&self) -> usize

Number of entities in the knowledge base.

Source

pub fn relation_count(&self) -> usize

Number of relations in the knowledge base.

Source

pub fn document_count(&self) -> usize

Number of documents ingested.

Source

pub fn stats(&self) -> KbStats

Compute aggregate statistics for the knowledge base.

Source

pub fn entities(&self) -> &HashMap<String, KbBuilderEntity>

Direct read access to the entity map.

Source

pub fn relations(&self) -> &[KbRelation]

Direct read access to the relation list.

Source

pub fn concept_graph(&self) -> &HashMap<String, KbConceptNode>

Direct read access to the concept graph.

Source

pub fn documents(&self) -> &HashMap<String, KbDocument>

Direct read access to the document map.

Trait Implementations§

Source§

impl Debug for KnowledgeBaseBuilder

Source§

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

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

impl Default for KnowledgeBaseBuilder

Source§

fn default() -> KnowledgeBaseBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more