Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

User Guides

Comprehensive guides for using NornicDB features and capabilities.

📚 Available Guides

Core Features

Query & Data Management

Operations

🎯 Quick Start Paths

I want to...

Search by meaning, not just keywordsVector Search Guide

Get the best search resultsHybrid Search (RRF)

Use GraphQL API with real-time subscriptionsGraphQL Guide

Learn Cypher query languageCypher Queries Guide

Find paths between nodesGraph Traversal Guide

Ensure data consistencyTransactions Guide

Build a distributed logical graph across local and remote databasesNeo4j-Style Infinigraph Topology

Build a canonical truth storeCanonical Graph + Mutation Log Guide

Migrate from Neo4jData Import/Export

See complete examplesComplete Examples

Set up high availabilityClustering Guide

Use natural language to query my databaseHeimdall AI Assistant

Extend Heimdall with custom actionsHeimdall Plugins

Understand Heimdall's token budgetHeimdall Context & Tokens

Build event-driven automationHeimdall Plugins - Autonomous Actions

Enable MCP memory tools in chat (store, recall, link…)Enabling MCP tools in the agentic loop

Understand how the agentic loop and plugins workHeimdall agentic loop

Set up event triggers and automatic remediationEvent triggers and automatic remediation

🤖 Heimdall Plugin Features

Heimdall plugins support advanced capabilities:

Feature Description
Lifecycle Hooks Modify prompts, validate actions, log results
Database Events React to CRUD operations, queries, transactions
Autonomous Actions Trigger SLM analysis based on accumulated events
Inline Notifications Send ordered messages to the chat interface
Request Cancellation Cancel requests with reasons from any hook

See Heimdall Plugins Guide for complete documentation.

📖 Learning Path

Beginner

  1. Getting Started
  2. First Queries
  3. Cypher Queries
  4. Complete Examples

Intermediate

  1. GraphQL API
  2. Vector Search
  3. Graph Traversal
  4. Transactions
  5. Data Import/Export

Advanced

  1. Hybrid Search
  2. Advanced Topics - K-Means clustering, embeddings
  3. Performance Tuning
  4. Custom Functions

🔍 Search Features

NornicDB provides three search methods:

  1. Vector Search - Semantic similarity using embeddings
  2. Full-Text Search - BM25 keyword matching
  3. Hybrid Search - RRF fusion of both methods

See Vector Search and Hybrid Search for details.

📊 Common Use Cases

Knowledge Graphs

  • Store and query interconnected information
  • Find relationships between concepts
  • Semantic search across documents

Example: Personal Knowledge Graph

AI Agent Memory

  • User preferences and context
  • Project decisions and architecture
  • Semantic memory with decay

Example: AI Agent Memory System

Code Knowledge Bases

  • Code structure and dependencies
  • Documentation search
  • Pattern recognition

Example: Code Knowledge Base

Document Management

  • Semantic document search
  • Automatic categorization
  • Related document discovery

Example: Vector Search Guide

🆘 Common Questions

How do I search by meaning?

Use Vector Search with automatic embeddings.

How do I ensure data consistency?

Use Transactions for ACID guarantees.

How do I query relationships?

See Graph Traversal for pattern matching.

How do I migrate from Neo4j?

Check Data Import/Export for compatibility.

Where are code examples?

See Complete Examples for full applications.

📚 Related Documentation

⏭️ Next Steps

After mastering the user guides:


Ready to dive in?Vector Search Guide