Struct KnowledgeGraph 

pub struct KnowledgeGraph { /* private fields */ }

In-memory knowledge graph with indexed lookups and graph traversal.

Implementations

impl KnowledgeGraph

pub fn new() -> Self

Create an empty knowledge graph.

pub fn add_entity(&mut self, entity: Entity) -> String

Add an entity to the graph. Returns the entity ID.

If the entity’s id field is empty, a new UUID is generated.

pub fn get_entity(&self, id: &str) -> Option<&Entity>

Retrieve an entity by ID.

pub fn find_entities(&self, name: &str) -> Vec<&Entity>

Find all entities whose name matches (case-insensitive substring).

pub fn find_by_type(&self, entity_type: &EntityType) -> Vec<&Entity>

Find all entities of a given type.

pub fn update_entity( &mut self, id: &str, properties: HashMap<String, Value>, ) -> bool

Update an entity’s properties. Returns true if the entity was found and updated.

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

Remove an entity and all its incident relationships. Returns true if the entity existed.

pub fn add_relationship(&mut self, rel: Relationship) -> String

Add a relationship to the graph. Returns the relationship ID.

If the relationship’s id field is empty, a new UUID is generated.

pub fn get_relationships_from(&self, entity_id: &str) -> Vec<&Relationship>

Get all relationships originating from a given entity.

pub fn get_relationships_to(&self, entity_id: &str) -> Vec<&Relationship>

Get all relationships pointing to a given entity.

pub fn find_relationships( &self, from: Option<&str>, to: Option<&str>, rel_type: Option<&RelationType>, ) -> Vec<&Relationship>

Find relationships matching optional filters.

pub fn remove_relationship(&mut self, id: &str) -> bool

Remove a relationship by ID. Returns true if it was found and removed.

pub fn neighbors(&self, entity_id: &str, depth: usize) -> Vec<&Entity>

BFS traversal to collect all neighbor entities within a given depth.

Treats the graph as undirected for traversal purposes.

pub fn shortest_path(&self, from: &str, to: &str) -> Option<Vec<String>>

BFS shortest path between two entities. Returns the list of entity IDs along the path (including start and end), or None if no path exists.

Treats the graph as undirected.

pub fn connected_component(&self, entity_id: &str) -> Vec<&Entity>

Return all entities in the connected component containing entity_id. Treats the graph as undirected.

pub fn entity_count(&self) -> usize

Total number of entities.

pub fn relationship_count(&self) -> usize

Total number of relationships.

pub fn extract_entities_from_text( &mut self, text: &str, source: &str, ) -> Vec<String>

Extract entities from free text using regex-based heuristics.

Detects:

• Capitalized multi-word phrases (potential names / organizations)
• Email addresses (creates Person entities)
• URLs (creates Custom(“Url”) entities)
• @mentions (creates Person entities)
• #hashtags (creates Concept entities)
• File paths (creates File entities)

Returns the IDs of all newly created entities.

pub fn merge_entity( &mut self, source_id: &str, target_id: &str, ) -> ArgentorResult<()>

Merge source_id entity into target_id.

All properties from the source are copied to the target (existing keys are not overwritten). All relationships that reference the source entity are redirected to the target. The source entity is then removed.

pub fn summarize(&self) -> GraphSummary

Compute aggregate statistics about the graph.

pub fn to_context_string(&self, entity_id: &str, depth: usize) -> String

Generate a human-readable context string about an entity and its neighborhood.

Output includes entity properties, direct relationships, and optionally relationships of neighbors up to the given depth.

pub fn save(&self, path: &Path) -> ArgentorResult<()>

Save the graph to a JSON file.

pub fn load(path: &Path) -> ArgentorResult<Self>

Load a graph from a JSON file.

Trait Implementations

impl Default for KnowledgeGraph

fn default() -> Self

Returns the “default value” for a type.