Crate hirn_engine 

hirn-engine — orchestrator crate for the Hirn cognitive memory database.

Wires together storage, graph, execution, query compilation, and policy enforcement into the HirnDB entry-point. Sub-modules cover recall/think pipelines, consolidation, admission control, observability, and agent tooling.

Re-exports

pub use graph::cached_graph_store;

pub use graph::causal;

pub use graph::graph_store;

pub use graph::persistent_activation;

pub use graph::persistent_graph;

pub use graph::persistent_hebbian;

pub use observability::diagnostics;

pub use observability::event;

pub use observability::event_log;

pub use observability::inspect;

pub use observability::metrics;

pub use observability::trace;

pub use retrieval::global_retrieval;

pub use retrieval::recall;

pub use retrieval::think;

pub use admission::AdmissionController;

pub use admission::AdmissionDecision;

pub use admission::AdmissionPipeline;

pub use admission::ContradictionGate;

pub use admission::ControllerVerdict;

pub use admission::DuplicateAction;

pub use admission::DuplicateDetector;

pub use admission::MemoryCandidate;

pub use admission::PipelineResult;

pub use admission::RateLimiter;

pub use admission::SurpriseGate;

pub use admission::TokenBudgetGate;

pub use agent_context::AgentContext;

pub use backup::RollbackReport;

pub use backup::Snapshot;

pub use backup::SnapshotReport;

pub use causal::CausalChain;

pub use causal::CausalChainResult;

pub use causal::CausalLink;

pub use causal::ContradictionDetection;

pub use causal::Counterfactual;

pub use causal::CounterfactualConstraint;

pub use causal::TraceReport;

pub use causal::causal_relevance;

pub use consolidation::Community;

pub use consolidation::CommunityConfig;

pub use consolidation::CommunityResult;

pub use consolidation::CommunitySummaryResult;

pub use consolidation::ConsolidateBuilder;

pub use consolidation::ConsolidationConfig;

pub use consolidation::ConsolidationResult;

pub use consolidation::ConsolidationSchedule;

pub use consolidation::ConsolidationScheduler;

pub use consolidation::ConsolidationStatus;

pub use consolidation::DetectedPatterns;

pub use consolidation::DreamCycleConfig;

pub use consolidation::DreamCycleResult;

pub use consolidation::DreamHypothesis;

pub use consolidation::DreamPhase;

pub use consolidation::EpisodeSegment;

pub use consolidation::ForgettingResult;

pub use consolidation::NarrativeThread;

pub use consolidation::Pattern;

pub use consolidation::PhaseResult;

pub use consolidation::ReconsolidationTracker;

pub use consolidation::ReconsolidationUpdate;

pub use consolidation::execute_dream_cycle;

pub use consolidation::generate_community_summaries;

pub use consolidation::retention_score;

pub use diagnostics::QueryDiagnostics;

pub use diagnostics::QueryId;

pub use event::EventEnvelope;

pub use event::MemoryEvent;

pub use event_log::CompactionResult;

pub use event_log::EventFilter;

pub use event_log::EventLog;

pub use event_log::RetentionPolicy;

pub use event_log::SnapshotMeta;

pub use export::ExportData;

pub use export::ExportReport;

pub use export::ImportReport;

pub use global_retrieval::CommunityMatch;

pub use global_retrieval::GlobalRetrievalConfig;

pub use global_retrieval::GlobalRetrievalResult;

pub use global_retrieval::global_recall;

pub use graph_store::GraphStore;

pub use index_advisor::DatasetQueryStats;

pub use index_advisor::IndexAdvisor;

pub use index_advisor::IndexRecommendation;

pub use index_advisor::QueryKind;

pub use inspect::InspectBuilder;

pub use inspect::InspectResult;

pub use inspect::NeighborInfo;

pub use integrity::IntegrityIssue;

pub use integrity::IntegrityReport;

pub use integrity::IssueKind;

pub use integrity::RepairReport;

pub use integrity::SemanticRevisionIntegrityIssue;

pub use integrity::SemanticRevisionIntegrityReport;

pub use integrity::SemanticRevisionIssueKind;

pub use integrity::SemanticRevisionRepairReport;

pub use observability::write_path::AdmissionExplanation;

pub use observability::write_path::EmbeddingDisposition;

pub use observability::write_path::InterferenceDisposition;

pub use observability::write_path::InterferenceExplanation;

pub use observability::write_path::RememberExplanation;

pub use observability::write_path::RememberFailure;

pub use observability::write_path::RememberStatus;

pub use observability::write_path::RpeExplanation;

pub use observability::write_path::WritePathOperationExplanation;

pub use observability::write_path::WritePathOperationStatus;

pub use persistent_graph::BfsResult;

pub use persistent_graph::CausalBfsRow;

pub use persistent_graph::PersistentGraph;

pub use policy::PolicyNamespaceResolver;

pub use provider_registry::ApiKeySource;

pub use provider_registry::DefaultsConfig;

pub use provider_registry::EmbedderConfig;

pub use provider_registry::LlmConfig;

pub use provider_registry::ProviderConfig;

pub use provider_registry::ProviderDefaults;

pub use provider_registry::ProviderRegistry;

pub use provider_registry::ProvidersSection;

pub use provider_registry::RerankerConfig;

pub use provider_registry::TokenizerConfig;

pub use ql::QueryPlan;

pub use ql::QueryResult;

pub use recall::LayerFilter;

pub use recall::RecallBuilder;

pub use recall::RecallPresentation;

pub use recall::RecallPresentationItem;

pub use recall::RecallResult;

pub use recall::RecallViewMode;

pub use recall::ResourceEvidenceSummary;

pub use retrieval::explanation::RetrievalExplanation;

pub use retrieval::explanation::RetrievalPolicyScope;

pub use retrieval::explanation::RetrievalPolicySummary;

pub use retrieval::explanation::RetrievalSuppressionSummary;

pub use retrieval::explanation::RetrievedRecordExplanation;

pub use retrieval::explanation::ThinkExplanation;

pub use scoring::ScoreBreakdown;

pub use scoring::ScoringWeights;

pub use security::CorruptionDefense;

pub use security::CorruptionDefenseConfig;

pub use security::QuarantineApprovalOutcome;

pub use security::QuarantineEntry;

pub use security::QuarantineStatus;

pub use think::ThinkBuilder;

pub use tools::IntrospectionResult;

pub use tools::LinkRequest;

pub use tools::MemoryAgent;

pub use tools::MemoryToolkit;

pub use tools::RecallOptions;

pub use tools::RecallRecord;

pub use tools::StoreRequest;

pub use tools::UpdateRequest;

pub use trace::TraceBuilder;

pub use trace::TraceResult;

pub use watch::WatchFilter;

pub use watch::WatchSubscription;

Modules

activation

Spreading activation engine with lateral inhibition.

adaptive

Adaptive retrieval strategy (Jeong et al., NAACL 2024).

admission

Intelligent Admission Control.

agent_context

Agent-scoped context for namespace-isolated memory operations.

backup

Versioning and point-in-time recovery for hirn databases.

consolidation

Consolidation engine — episode segmentation, pattern detection, narrative thread formation, concept extraction, adaptive forgetting, and memory reconsolidation.

export

Database export and import in human-readable JSON format.

graph

Graph sub-module — CachedGraphStore, persistent graph/activation/Hebbian, causal reasoning, and graph store trait.

hebbian

Hebbian learning: co-retrieval strengthens edge weights, solo retrieval decays them.

index_advisor

Self-Optimizing Index Selection.

integrity

observability

Observability sub-module — metrics, diagnostics, tracing, events, and event log.

operators

Composable cognitive operators for query pipelines.

policy

Cedar-based authorization for hirn.

provider_registry

Config-driven provider registry for AI traits.

ql

HirnQL — the query language for hirn cognitive memory operations.

retrieval

Retrieval sub-module — recall, think, and global retrieval pipelines.

scoring

Composite scoring: multi-factor ranking combining similarity, importance, recency, and activation.

security

Memory security: anomaly detection, quarantine management, Bayesian trust, and collective corruption defense.

tools

Agent-facing MemoryToolkit — 6 self-editing functions for AI agents.

watch

Watch subscriptions for real-time reactive memory.

Structs

AdminView

Admin operations: statistics, compaction, maintenance, and agent management.

AuthzDecision

Result of an authorization check.

AuthzRequest

An authorization request to evaluate.

CausalView

Causal operations: contradiction detection, quarantine, and ABA resolution.

CrossAgentConsolidationResult

Result of cross-agent consolidation.

DbStats

Database statistics.

EpisodicFilter

Filter for listing episodic records.

EpisodicView

Episodic memory operations: remember, recall and manage event-based memories.

GraphEdge

A typed, weighted edge in the property graph.

GraphNodeData

Minimal node data for persistence.

GraphView

Graph operations: create edges and inspect the property graph.

HebbianBuffer

Lock-free buffer for co-retrieval events.

HebbianConfig

Configuration for Hebbian weight updates.

HebbianUpdateResult

Result of a Hebbian update step.

HirnDB

The main database handle.

HydratedResource

Hydrated resource payload returned from storage fetch operations.

LayerCounts

Layer counts.

MutationWriteContract

One documented write class in Hirn’s mutation contract.

NamespaceView

Namespace operations: create, list and manage agent namespaces.

ParseError

Parse error with location and context.

PolicyEngine

Thread-safe Cedar policy engine.

PolicyView

Policy operations: Cedar authorization enforcement and evaluation.

PrefetchStats

Statistics about predictive prefetch activity.

ProceduralView

Procedural memory operations: store, execute and track skill/procedure records.

PurgeReport

Result of a GDPR agent data purge.

QueryView

Query operations: HirnQL execution, explain, and prepared statements.

RecallView

Recall operations: vector search, think and trace queries.

ResourceScoreAttribution

SemanticFilter

Filter for listing semantic records.

SemanticMerge

Describes how one active semantic memory should absorb other logical memories.

SemanticMergeOutcome

Result of merging one or more semantic logical memories into a target chain.

SemanticOverride

Describes a durable human/admin override that selects a semantic revision head.

SemanticRetraction

Describes metadata for retracting a semantic record.

SemanticSupersession

Describes replacement metadata for superseding a semantic record.

SemanticUpdate

Describes updates to apply to a semantic record.

SemanticView

Semantic memory operations: store, query and manage concept-based knowledge.

WorkingView

Working memory operations: manage the short-term focus set.

Enums

Action

Hirn authorization actions mapped to Cedar action names.

ActivationMode

Activation mode for recall queries.

EntityKind

An entity registered in the policy engine’s entity store.

MutationWriteGuarantee

Product-level durability class for a write surface.

PolicyError

Errors from the policy engine.

Statement

A parsed HirnQL statement.

StoreError

Internal storage error conversions.

Constants

MAX_EDGES_PER_NODE

Maximum number of edges per node (fan-out cap). Prevents graph injection attacks where a malicious agent floods a node with edges.

Functions

inspected_result_to_json

mutation_write_contracts

trace_result_to_json

traced_result_to_json

Type Aliases

EdgeId

A unique identifier for a graph edge.