docs: Universal Knowledge Protocol positioning and complete noun-verb taxonomy

- Position Brainy as the Universal Knowledge Protocol with Triple Intelligence
- Document all 24 noun types and 40 verb types with industry examples
- Add verb relationship examples to demonstrate graph capabilities
- Emphasize infinite expressiveness and universal interoperability
- Show how standardized types enable tool and AI model compatibility
- Version 2.0.2
This commit is contained in:
David Snelling 2025-08-27 09:27:12 -07:00
parent 5b880b5015
commit bf6e026d75
3 changed files with 946 additions and 147 deletions

169
README.md
View file

@ -9,18 +9,24 @@
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/) [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
**🧠 Brainy 2.0 - Zero-Configuration AI Database with Triple Intelligence™** **🧠 Brainy 2.0 - The Universal Knowledge Protocol™**
The industry's first truly zero-configuration AI database that combines vector similarity, metadata filtering, and graph relationships with O(log n) performance. Production-ready with 3ms search latency, 220 pre-computed NLP patterns, and only 24MB memory footprint. **World's first Triple Intelligence™ database**—unifying vector similarity, graph relationships, and document filtering in one magical API. Model ANY data from ANY domain using 24 standardized noun types × 40 verb types.
**Why Brainy Leads**: We're the first to solve the impossible—combining three different database paradigms (vector, graph, document) into one unified query interface. This breakthrough enables us to be the Universal Knowledge Protocol where all tools, augmentations, and AI models speak the same language.
**Build once, integrate everywhere.** O(log n) performance, 3ms search latency, 24MB memory footprint.
## 🎉 What's New in 2.0 ## 🎉 What's New in 2.0
- **Triple Intelligence™**: Unified Vector + Metadata + Graph queries in one API - **World's First Triple Intelligence™**: Unified vector + graph + document in ONE query
- **Universal Knowledge Protocol**: 24 nouns × 40 verbs standardize all knowledge
- **Infinite Expressiveness**: Model ANY data with unlimited metadata
- **API Consolidation**: 15+ methods → 2 clean APIs (`search()` and `find()`) - **API Consolidation**: 15+ methods → 2 clean APIs (`search()` and `find()`)
- **Natural Language**: Ask questions in plain English - **Natural Language**: Ask questions in plain English
- **Zero Configuration**: Works instantly, no setup required - **Zero Configuration**: Works instantly, no setup required
- **O(log n) Performance**: Binary search on sorted indices - **O(log n) Performance**: Binary search on sorted indices
- **220+ NLP Patterns**: Pre-computed for instant understanding - **Perfect Interoperability**: All tools and AI models speak the same language
- **Universal Compatibility**: Node.js, Browser, Edge, Workers - **Universal Compatibility**: Node.js, Browser, Edge, Workers
## ⚡ Quick Start ## ⚡ Quick Start
@ -35,29 +41,53 @@ import { BrainyData } from 'brainy'
const brain = new BrainyData() const brain = new BrainyData()
await brain.init() await brain.init()
// Add data with automatic embedding // Add entities (nouns) with automatic embedding
await brain.addNoun("JavaScript is a programming language", { const jsId = await brain.addNoun("JavaScript is a programming language", {
type: "language", type: "language",
year: 1995 year: 1995,
paradigm: "multi-paradigm"
}) })
// Natural language search const nodeId = await brain.addNoun("Node.js runtime environment", {
const results = await brain.find("programming languages from the 90s") type: "runtime",
year: 2009,
platform: "server-side"
})
// Vector similarity with metadata filtering // Create relationships (verbs) between entities
const filtered = await brain.search("JavaScript", { await brain.addVerb(nodeId, jsId, "executes", {
metadata: { type: "language" }, since: 2009,
limit: 5 performance: "high"
})
// Natural language search with graph relationships
const results = await brain.find("programming languages used by server runtimes")
// Triple Intelligence: vector + metadata + relationships
const filtered = await brain.find({
like: "JavaScript", // Vector similarity
where: { type: "language" }, // Metadata filtering
connected: { from: nodeId, depth: 1 } // Graph relationships
}) })
``` ```
## 🚀 Key Features ## 🚀 Key Features
### Triple Intelligence Engine ### World's First Triple Intelligence Engine
Combines three search paradigms in one unified API: **The breakthrough that enables the Universal Knowledge Protocol:**
- **Vector Search**: Semantic similarity with HNSW indexing - **Vector Search**: Semantic similarity with HNSW indexing
- **Metadata Filtering**: O(log n) field lookups with binary search - **Graph Relationships**: Navigate connected knowledge like Neo4j
- **Graph Relationships**: Navigate connected knowledge - **Document Filtering**: MongoDB-style queries with O(log n) performance
- **Unified in ONE API**: No separate queries, no complex joins
- **First to solve this**: Others do vector OR graph OR document—we do ALL
### Universal Knowledge Protocol with Infinite Expressiveness
**Enabled by Triple Intelligence, standardized for everyone:**
- **24 Noun Types × 40 Verb Types**: 960 base combinations
- **∞ Expressiveness**: Unlimited metadata = model ANY data
- **One Language**: All tools, augmentations, AI models speak the same types
- **Perfect Interoperability**: Move data between any Brainy instance
- **No Schema Lock-in**: Evolve without migrations
### Natural Language Understanding ### Natural Language Understanding
```javascript ```javascript
@ -108,17 +138,26 @@ const results = await brain.find({
### CRUD Operations ### CRUD Operations
```javascript ```javascript
// Create // Create entities (nouns)
const id = await brain.addNoun(data, metadata) const id = await brain.addNoun(data, metadata)
// Create relationships (verbs)
const verbId = await brain.addVerb(sourceId, targetId, "relationType", {
strength: 0.9,
bidirectional: false
})
// Read // Read
const item = await brain.getNoun(id) const item = await brain.getNoun(id)
const verb = await brain.getVerb(verbId)
// Update // Update
await brain.updateNoun(id, newData, newMetadata) await brain.updateNoun(id, newData, newMetadata)
await brain.updateVerb(verbId, newMetadata)
// Delete // Delete
await brain.deleteNoun(id) await brain.deleteNoun(id)
await brain.deleteVerb(verbId)
// Bulk operations // Bulk operations
await brain.import(arrayOfData) await brain.import(arrayOfData)
@ -127,16 +166,35 @@ const exported = await brain.export({ format: 'json' })
## 🎯 Use Cases ## 🎯 Use Cases
### Knowledge Management ### Knowledge Management with Relationships
```javascript ```javascript
// Store and search documentation // Store documentation with rich relationships
await brain.addNoun(documentContent, { const apiGuide = await brain.addNoun("REST API Guide", {
title: "API Guide", title: "API Guide",
category: "documentation", category: "documentation",
version: "2.0" version: "2.0"
}) })
const docs = await brain.find("API documentation for version 2") const author = await brain.addNoun("Jane Developer", {
type: "person",
role: "tech-lead"
})
const project = await brain.addNoun("E-commerce Platform", {
type: "project",
status: "active"
})
// Create knowledge graph
await brain.addVerb(author, apiGuide, "authored", {
date: "2024-03-15"
})
await brain.addVerb(apiGuide, project, "documents", {
coverage: "complete"
})
// Query the knowledge graph naturally
const docs = await brain.find("documentation authored by tech leads for active projects")
``` ```
### Semantic Search ### Semantic Search
@ -148,17 +206,35 @@ const similar = await brain.search(existingContent, {
}) })
``` ```
### AI Memory Layer ### AI Memory Layer with Context
```javascript ```javascript
// Store conversation context // Store conversation with relationships
await brain.addNoun(userMessage, { const userId = await brain.addNoun("User 123", {
userId: "123", type: "user",
tier: "premium"
})
const messageId = await brain.addNoun(userMessage, {
type: "message",
timestamp: Date.now(), timestamp: Date.now(),
session: "abc" session: "abc"
}) })
// Retrieve relevant context const topicId = await brain.addNoun("Product Support", {
const context = await brain.find(`previous conversations with user 123`) type: "topic",
category: "support"
})
// Link conversation elements
await brain.addVerb(userId, messageId, "sent")
await brain.addVerb(messageId, topicId, "about")
// Retrieve context with relationships
const context = await brain.find({
where: { type: "message" },
connected: { from: userId, type: "sent" },
like: "previous product issues"
})
``` ```
## 💾 Storage Options ## 💾 Storage Options
@ -272,6 +348,42 @@ Key changes:
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
## 🧠 The Universal Knowledge Protocol Explained
### How We Achieved The Impossible
**Triple Intelligence™** makes us the **world's first** to unify three database paradigms:
1. **Vector databases** (Pinecone, Weaviate) - semantic similarity
2. **Graph databases** (Neo4j, ArangoDB) - relationships
3. **Document databases** (MongoDB, Elasticsearch) - metadata filtering
**One API to rule them all.** Others make you choose. We unified them.
### The Math of Infinite Expressiveness
```
24 Nouns × 40 Verbs × ∞ Metadata × Triple Intelligence = Universal Protocol
```
- **960 base combinations** from standardized types
- **∞ domain specificity** via unlimited metadata
- **∞ relationship depth** via graph traversal
- **= Model ANYTHING**: From quantum physics to social networks
### Why This Changes Everything
**Like HTTP for the web, Brainy for knowledge:**
- All augmentations compose perfectly - same noun-verb language
- All AI models share knowledge - GPT, Claude, Llama all understand
- All tools integrate seamlessly - no translation layers
- All data flows freely - perfect portability
**The Vision**: One protocol. All knowledge. Every tool. Any AI.
**Proven across industries**: Healthcare, Finance, Manufacturing, Education, Legal, Retail, Government, and beyond.
[→ See the Mathematical Proof & Full Taxonomy](docs/architecture/noun-verb-taxonomy.md)
## 📖 Documentation ## 📖 Documentation
- [Getting Started Guide](docs/guides/getting-started.md) - [Getting Started Guide](docs/guides/getting-started.md)
@ -279,6 +391,7 @@ We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
- [Architecture Overview](docs/architecture/overview.md) - [Architecture Overview](docs/architecture/overview.md)
- [Natural Language Guide](docs/guides/natural-language.md) - [Natural Language Guide](docs/guides/natural-language.md)
- [Triple Intelligence](docs/architecture/triple-intelligence.md) - [Triple Intelligence](docs/architecture/triple-intelligence.md)
- [Noun-Verb Taxonomy](docs/architecture/noun-verb-taxonomy.md)
## 🏢 Enterprise & Cloud ## 🏢 Enterprise & Cloud

File diff suppressed because it is too large Load diff

View file

@ -1,7 +1,7 @@
{ {
"name": "@soulcraft/brainy", "name": "@soulcraft/brainy",
"version": "2.0.1", "version": "2.0.2",
"description": "Multi-Dimensional AI Database - Vector search, graph relationships, field filtering with Triple Intelligence Engine, HNSW indexing and universal storage", "description": "Universal Knowledge Protocol™ - World's first Triple Intelligence database unifying vector, graph, and document search in one API. 24 nouns × 40 verbs for infinite expressiveness.",
"main": "dist/index.js", "main": "dist/index.js",
"module": "dist/index.js", "module": "dist/index.js",
"types": "dist/index.d.ts", "types": "dist/index.d.ts",