Skip to content

Commit 5a2d881

Browse files
madeinoz67claude
andcommitted
docs: update README with RAG/LKAP features
- Update description to reflect two-tier memory model - Add LKAP section: Document Memory (RAG) + Knowledge Memory (Graph) - Add RAG usage commands and document search examples - Update database backends: Neo4j, Qdrant, Ollama - Add LKAP and RAG quickstart to docs table - Update keywords: add qdrant, rag, lkap, docling, ollama - Update credits: add Qdrant, Docling; remove FalkorDB Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 2b6bf94 commit 5a2d881

File tree

1 file changed

+42
-12
lines changed

1 file changed

+42
-12
lines changed

README.md

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ version: 1.9.0
1212
author: madeinoz67
1313

1414
# description: (128 words max) One-line description
15-
description: Persistent personal knowledge management system powered by Graphiti knowledge graph with FalkorDB or Neo4j backend - automatic entity extraction, relationship mapping, and semantic search for AI conversations and documents
15+
description: Two-tier memory system with RAG document search (Qdrant) and knowledge graph (Neo4j) - automatic entity extraction, semantic search, and evidence-to-fact promotion for AI conversations and documents
1616

1717
# type: (single) concept | skill | hook | plugin | agent | mcp | workflow | template | other
1818
type: skill
@@ -27,7 +27,7 @@ platform: claude-code
2727
dependencies: []
2828

2929
# keywords: (24 tags max) Searchable tags for discovery
30-
keywords: [knowledge, graph, memory, semantic search, entity extraction, relationships, graphiti, falkordb, neo4j, mcp, persistent, ai, storage, retrieval, organizational, learning, documentation]
30+
keywords: [knowledge, graph, memory, semantic search, entity extraction, relationships, graphiti, neo4j, qdrant, rag, lkap, docling, ollama, mcp, persistent, ai, storage, retrieval, documentation]
3131
---
3232

3333
<p align="center"><img src="./icons/knowledge-system-architecture.png" alt="Madeinoz Knowledge System Architecture"></p>
@@ -52,30 +52,42 @@ See [CHANGELOG.md](CHANGELOG.md) for full version history.
5252
| Topic | Description |
5353
|-------|-------------|
5454
| [Getting Started](https://madeinoz67.github.io/madeinoz-knowledge-system/getting-started/) | Installation and quick start guide |
55+
| [LKAP Overview](https://madeinoz67.github.io/madeinoz-knowledge-system/lkap/) | Two-tier memory model |
56+
| [RAG Quickstart](https://madeinoz67.github.io/madeinoz-knowledge-system/rag/quickstart/) | Document search setup |
5557
| [Configuration](https://madeinoz67.github.io/madeinoz-knowledge-system/reference/configuration/) | Environment variables and settings |
56-
| [Architecture](https://madeinoz67.github.io/madeinoz-knowledge-system/reference/architecture/) | System design and components |
58+
| [Architecture](https://madeinoz67.github.io/madeinoz-knowledge-system/concepts/architecture/) | System design and components |
5759
| [Troubleshooting](https://madeinoz67.github.io/madeinoz-knowledge-system/troubleshooting/) | Common issues and solutions |
58-
| [Developer Notes](https://madeinoz67.github.io/madeinoz-knowledge-system/reference/developer-notes/) | Contributing and development |
5960

6061
## Installation
6162

6263
See [INSTALL.md](INSTALL.md) for complete installation instructions, performance benchmarks, and [VERIFY.md](VERIFY.md) for verification checklist.
6364

6465
## Features
6566

67+
### Two-Tier Memory (LKAP)
68+
69+
- **Document Memory (RAG)** - Fast semantic search across PDFs, markdown, and text using Qdrant
70+
- **Knowledge Memory (Graph)** - Durable facts with provenance tracking in Neo4j
71+
- **Promotion Workflow** - Promote evidence from documents to verified facts
72+
73+
### Knowledge Graph
74+
6675
- **Automatic Entity Extraction** - LLM-powered extraction of people, organizations, concepts, and more
6776
- **Relationship Mapping** - Automatically discovers connections between entities
6877
- **Semantic Search** - Find knowledge using natural language, not just keywords
6978
- **Investigative Search** - Find entity with all connected relationships in a single query (configurable depth 1-3 hops)
7079
- **Memory Decay Scoring** - Automatic memory prioritization with importance/stability classification
7180
- **Weighted Search** - Results ranked by semantic relevance, recency, and importance
7281
- **Lifecycle Management** - Automated memory transitions (ACTIVE → DORMANT → ARCHIVED → EXPIRED)
82+
- **Temporal Tracking** - Know when knowledge was captured and how it evolves
83+
- **OSINT/CTI Ontology** - Custom entity types for threat intelligence with STIX 2.1 import support
84+
85+
### Observability
86+
7387
- **Prometheus Metrics** - Token usage, API costs, cache statistics, and memory health metrics
7488
- **Automated Maintenance** - Scheduled cleanup of expired memories
7589
- **Grafana Dashboards** - Visualize knowledge, token usage, graph stats and memory health
76-
- **Temporal Tracking** - Know when knowledge was captured and how it evolves
7790
- **Memory Sync** - Auto-syncs learnings from PAI Memory System
78-
- **OSINT/CTI Ontology** - Custom entity types for threat intelligence (ThreatActor, Malware, Vulnerability, Indicator, etc.) with STIX 2.1 import support
7991

8092
## Usage
8193

@@ -89,6 +101,21 @@ The skill triggers automatically based on natural language:
89101
| "what did I learn today" | **Temporal search** - filter by date |
90102
| "recent learnings" | Retrieve recent knowledge additions |
91103
| "knowledge status" | Check system health |
104+
| "search documents for X" | **RAG search** across ingested documents |
105+
106+
### Document Search (RAG)
107+
108+
Drop documents in `knowledge/inbox/` for automatic ingestion, then search:
109+
110+
```bash
111+
# Semantic search across documents
112+
bun run rag-cli.ts search "GPIO configuration"
113+
114+
# Ingest new documents
115+
bun run rag-cli.ts ingest knowledge/inbox/
116+
```
117+
118+
See [RAG Quickstart](https://madeinoz67.github.io/madeinoz-knowledge-system/rag/quickstart/) for full documentation.
92119

93120
### Temporal Search
94121

@@ -135,14 +162,15 @@ bun run tools/knowledge-cli.ts search_nodes "topic" --weighted
135162
| `src/skills/workflows/` | 8 workflows (Capture, Search, SearchByDate, Facts, Recent, Status, Clear, BulkImport) |
136163
| `src/skills/tools/` | Server management scripts (start, stop, status, logs) |
137164
| `src/hooks/` | Memory sync hook for automatic knowledge capture |
138-
| `docker/` | Docker/Podman compose files for Neo4j and FalkorDB |
165+
| `docker/` | Docker/Podman compose files for Neo4j and Qdrant |
139166

140167
## Database Backends
141168

142-
| Backend | Web UI | Best For |
143-
|---------|--------|----------|
144-
| **Neo4j** (default and recommended) | <http://localhost:7474> | Rich queries, special character handling |
145-
| **FalkorDB** (experimental) | <http://localhost:3000> | Simple setup, lower resources |
169+
| Backend | Port | Purpose |
170+
|---------|------|---------|
171+
| **Neo4j** (default) | 7474/7687 | Knowledge graph storage |
172+
| **Qdrant** | 6333 | Document memory (RAG) vector storage |
173+
| **Ollama** | 11434 | Local embeddings (optional) |
146174

147175
## For AI Agents
148176

@@ -156,7 +184,9 @@ This is a **PAI Pack** - a complete, self-contained module for Personal AI Infra
156184
## Credits
157185

158186
- **Knowledge graph engine**: [Graphiti](https://github.com/getzep/graphiti) by Zep AI
159-
- **Graph databases**: [Neo4j](https://neo4j.com/), [FalkorDB](https://www.falkordb.com/)
187+
- **Graph database**: [Neo4j](https://neo4j.com/)
188+
- **Vector database**: [Qdrant](https://qdrant.tech/)
189+
- **Document parsing**: [Docling](https://github.com/DS4SD/docling)
160190
- **Built for**: [Personal AI Infrastructure (PAI)](https://github.com/danielmiessler/PAI)
161191

162192
See full [Acknowledgments](https://madeinoz67.github.io/madeinoz-knowledge-system/acknowledgments) for credits to the community and research that inspired this system.

0 commit comments

Comments
 (0)