brainy/docs/api/README.md

🧠 Brainy v5.0+ API Reference

Complete API documentation for Brainy v5.0+ Zero Configuration • Triple Intelligence • Git-Style Branching

Updated: 2025-11-02 for v5.1.0 All APIs verified against actual code

---

Quick Start

import { Brainy, NounType, VerbType } from '@soulcraft/brainy'

const brain = new Brainy()  // Zero config!
await brain.init()          // VFS auto-initialized in v5.1.0!

// Add data (text auto-embeds!)
const id = await brain.add({
  data: 'The future of AI is here',
  type: NounType.Content,
  metadata: { category: 'technology' }
})

// Search with Triple Intelligence
const results = await brain.find({
  query: 'artificial intelligence',
  where: { year: { greaterThan: 2020 } },
  connected: { from: id, depth: 2 }
})

// Fork for safe experimentation (v5.0.0+)
const experiment = await brain.fork('test-feature')
await experiment.add({ data: 'test', type: NounType.Content })
await experiment.commit({ message: 'Add test data' })

---

Core Concepts

🧬 Entities (Nouns)

Semantic vectors with metadata and relationships - the fundamental data unit in Brainy.

🔗 Relationships (Verbs)

Typed connections between entities - building knowledge graphs.

🧠 Triple Intelligence

Vector search + Graph traversal + Metadata filtering in one unified query.

🌳 Git-Style Branching (v5.0.0+)

Fork, experiment, commit, and merge - Snowflake-style copy-on-write isolation.

---

Table of Contents

• Core CRUD Operations
• Search & Query
• Relationships
• Batch Operations
• Branch Management (v5.0+)
• Virtual Filesystem (VFS)
• Neural API
• Import & Export
• Configuration
• Storage Adapters
• Utility Methods

---

Core CRUD Operations

add(params) → Promise<string>

Add a single entity to the database.

const id = await brain.add({
  data: 'JavaScript is a programming language',  // Text or pre-computed vector
  type: NounType.Concept,                        // Required: Entity type
  metadata: {                                     // Optional metadata
    category: 'programming',
    year: 1995
  }
})

Parameters:

• data: string | number[] - Text (auto-embeds) or vector
• type: NounType - Entity type (required)
• metadata?: object - Additional metadata

Returns: Promise<string> - Entity ID

---

get(id) → Promise<Entity | null>

Retrieve a single entity by ID.

const entity = await brain.get(id)
console.log(entity?.data)      // Original data
console.log(entity?.metadata)  // Metadata
console.log(entity?.vector)    // Embedding vector

Parameters:

• id: string - Entity ID

Returns: Promise<Entity | null> - Entity or null if not found

---

update(params) → Promise<void>

Update an existing entity.

await brain.update({
  id: entityId,
  data: 'Updated content',           // Optional: new data
  metadata: { updated: true }        // Optional: new metadata (merges)
})

Parameters:

• id: string - Entity ID
• data?: string | number[] - New data/vector
• metadata?: object - Metadata to merge

Returns: Promise<void>

---

delete(id) → Promise<void>

Delete a single entity.

await brain.delete(id)

Parameters:

• id: string - Entity ID

Returns: Promise<void>

---

Search & Query

find(query) → Promise<Result[]>

Triple Intelligence - Vector + Graph + Metadata in ONE query.

// Simple text search
const results = await brain.find('machine learning')

// Advanced Triple Intelligence query
const results = await brain.find({
  query: 'artificial intelligence',     // Vector similarity
  where: {                               // Metadata filtering
    year: { greaterThan: 2020 },
    category: { oneOf: ['AI', 'ML'] }
  },
  connected: {                           // Graph traversal
    to: conceptId,
    depth: 2,
    type: VerbType.RelatedTo
  },
  limit: 10
})

Parameters:

• query: string | FindParams
  • Simple: Just text for vector search
  • Advanced: Object with vector + graph + metadata filters

FindParams:

• query?: string - Text for vector similarity
• where?: object - Metadata filters (see Query Operators)
• connected?: object - Graph traversal options
  • to?: string - Target entity ID
  • from?: string - Source entity ID
  • type?: VerbType - Relationship type
  • depth?: number - Traversal depth
• limit?: number - Max results (default: 10)
• offset?: number - Skip results

Returns: Promise<Result[]> - Matching entities with scores

---

Query Operators

Brainy uses clean, readable operators:

Operator	Description	Example
equals	Exact match	{age: {equals: 25}}
greaterThan	Greater than	{age: {greaterThan: 18}}
lessThan	Less than	{price: {lessThan: 100}}
greaterEqual	Greater or equal	{score: {greaterEqual: 90}}
lessEqual	Less or equal	{rating: {lessEqual: 3}}
oneOf	In array	{color: {oneOf: ['red', 'blue']}}
notOneOf	Not in array	{status: {notOneOf: ['deleted']}}
contains	Contains value	{tags: {contains: 'ai'}}
startsWith	String prefix	{name: {startsWith: 'John'}}
endsWith	String suffix	{email: {endsWith: '@gmail.com'}}
matches	Pattern match	{text: {matches: /^[A-Z]/}}
between	Range	{year: {between: [2020, 2024]}}

---

Relationships

relate(params) → Promise<string>

Create a typed relationship between entities.

const relId = await brain.relate({
  from: sourceId,
  to: targetId,
  type: VerbType.RelatedTo,
  metadata: {                   // Optional
    strength: 0.9,
    confidence: 0.85
  }
})

Parameters:

• from: string - Source entity ID
• to: string - Target entity ID
• type: VerbType - Relationship type
• metadata?: object - Optional metadata

Returns: Promise<string> - Relationship ID

---

getRelations(params) → Promise<Relation[]>

Get relationships for an entity.

// Get all relationships FROM an entity
const outgoing = await brain.getRelations({ from: entityId })

// Get all relationships TO an entity
const incoming = await brain.getRelations({ to: entityId })

// Filter by type
const related = await brain.getRelations({
  from: entityId,
  type: VerbType.Contains
})

Parameters:

• from?: string - Source entity ID
• to?: string - Target entity ID
• type?: VerbType - Filter by relationship type

Returns: Promise<Relation[]> - Matching relationships

---

Batch Operations

addMany(params) → Promise<BatchResult<string>>

Add multiple entities in one operation.

const result = await brain.addMany({
  items: [
    { data: 'Entity 1', type: NounType.Content },
    { data: 'Entity 2', type: NounType.Concept }
  ]
})

console.log(result.successful)  // Array of IDs
console.log(result.failed)      // Array of errors

Returns: Promise<BatchResult<string>> - Success/failure results

---

deleteMany(params) → Promise<BatchResult<string>>

Delete multiple entities.

const result = await brain.deleteMany({
  ids: [id1, id2, id3]
})

---

updateMany(params) → Promise<BatchResult<string>>

Update multiple entities.

const result = await brain.updateMany({
  updates: [
    { id: id1, metadata: { updated: true } },
    { id: id2, data: 'New content' }
  ]
})

---

relateMany(params) → Promise<string[]>

Create multiple relationships.

const ids = await brain.relateMany({
  relations: [
    { from: id1, to: id2, type: VerbType.RelatedTo },
    { from: id1, to: id3, type: VerbType.Contains }
  ]
})

---

Branch Management (v5.0+)

NEW in v5.0.0: Git-style branching with Snowflake-style copy-on-write.

fork(branch?, options?) → Promise<Brainy>

Create an instant fork (<100ms) with full isolation.

// Create a fork
const experiment = await brain.fork('test-feature')

// Make changes safely in isolation
await experiment.add({ data: 'Test entity', type: NounType.Content })
await experiment.update({ id: someId, metadata: { modified: true } })

// Parent is unaffected!
const parentData = await brain.find({})  // Original data unchanged

Parameters:

• branch?: string - Branch name (auto-generated if omitted)
• options?: object
  • description?: string - Branch description

Returns: Promise<Brainy> - New Brainy instance on forked branch

How it works: Snowflake-style COW shares HNSW index, copies only modified nodes (10-20% memory overhead).

---

checkout(branch) → Promise<void>

Switch to a different branch.

await brain.checkout('main')
await brain.checkout('test-feature')

Parameters:

• branch: string - Branch name

---

listBranches() → Promise<string[]>

List all branches.

const branches = await brain.listBranches()
// ['main', 'test-feature', 'experiment-2']

---

getCurrentBranch() → Promise<string>

Get current branch name.

const current = await brain.getCurrentBranch()
// 'main'

---

commit(options?) → Promise<string>

Create a commit snapshot.

const commitId = await brain.commit({
  message: 'Add new features',
  author: 'dev@example.com',
  metadata: { ticket: 'PROJ-123' }
})

Parameters:

• message?: string - Commit message
• author?: string - Author email
• metadata?: object - Additional commit metadata

Returns: Promise<string> - Commit ID

---

merge(sourceBranch, targetBranch, options?) → Promise<MergeResult>

Merge branches with conflict resolution.

const result = await brain.merge('test-feature', 'main', {
  strategy: 'last-write-wins',  // or 'manual'
  deleteSource: false            // Keep source branch
})

console.log(result.added)       // Entities added
console.log(result.modified)    // Entities modified
console.log(result.conflicts)   // Conflicts (if any)

Strategies:

• last-write-wins: Auto-resolve with latest changes
• manual: Return conflicts for manual resolution

---

deleteBranch(branch) → Promise<void>

Delete a branch (cannot delete 'main').

await brain.deleteBranch('old-experiment')

---

getHistory(options?) → Promise<Commit[]>

Get commit history.

const history = await brain.getHistory({
  branch: 'main',
  limit: 10
})

---

Virtual Filesystem (VFS)

Auto-initialized in v5.1.0! Access via brain.vfs (property, not method).

Basic File Operations

vfs.readFile(path, options?) → Promise<Buffer>

Read file content.

const content = await brain.vfs.readFile('/docs/README.md')
console.log(content.toString())

---

vfs.writeFile(path, data, options?) → Promise<void>

Write file content.

await brain.vfs.writeFile('/docs/README.md', 'New content', {
  encoding: 'utf-8'
})

---

vfs.unlink(path) → Promise<void>

Delete a file.

await brain.vfs.unlink('/docs/old-file.md')

---

Directory Operations

vfs.mkdir(path, options?) → Promise<void>

Create directory.

await brain.vfs.mkdir('/projects/new-app', { recursive: true })

---

vfs.readdir(path, options?) → Promise<string[] | Dirent[]>

List directory contents.

const files = await brain.vfs.readdir('/projects')

// With file types
const entries = await brain.vfs.readdir('/projects', { withFileTypes: true })
entries.forEach(entry => {
  console.log(entry.name, entry.isDirectory() ? 'DIR' : 'FILE')
})

---

vfs.rmdir(path, options?) → Promise<void>

Remove directory.

await brain.vfs.rmdir('/old-project', { recursive: true })

---

vfs.stat(path) → Promise<Stats>

Get file/directory stats.

const stats = await brain.vfs.stat('/docs/README.md')
console.log(stats.size)        // File size
console.log(stats.mtime)       // Modified time
console.log(stats.isDirectory())  // Is directory?

---

Semantic Operations

vfs.search(query, options?) → Promise<SearchResult[]>

Semantic file search.

const results = await brain.vfs.search('React components with hooks', {
  path: '/src',
  limit: 10
})

---

vfs.findSimilar(path, options?) → Promise<SearchResult[]>

Find similar files.

const similar = await brain.vfs.findSimilar('/src/App.tsx', {
  limit: 5,
  threshold: 0.7
})

---

Tree Operations

vfs.getTreeStructure(path, options?) → Promise<TreeNode>

Get directory tree (prevents infinite recursion).

const tree = await brain.vfs.getTreeStructure('/projects', {
  maxDepth: 3
})

---

vfs.getDescendants(path, options?) → Promise<VFSEntity[]>

Get all descendants with optional filtering.

const files = await brain.vfs.getDescendants('/src', {
  filter: (entity) => entity.name.endsWith('.tsx')
})

---

Metadata & Relationships

vfs.getMetadata(path) → Promise<Metadata>

Get file metadata.

const meta = await brain.vfs.getMetadata('/src/App.tsx')
console.log(meta.todos)        // Extracted TODOs
console.log(meta.tags)         // Tags

---

vfs.getRelationships(path) → Promise<Relation[]>

Get file relationships.

const rels = await brain.vfs.getRelationships('/src/App.tsx')
// Returns: imports, references, dependencies

---

vfs.getTodos(path) → Promise<Todo[]>

Get TODOs from a file.

const todos = await brain.vfs.getTodos('/src/App.tsx')

---

vfs.getAllTodos(path?) → Promise<Todo[]>

Get all TODOs from directory tree.

const allTodos = await brain.vfs.getAllTodos('/src')

---

Project Analysis

vfs.getProjectStats(path?) → Promise<Stats>

Get project statistics.

const stats = await brain.vfs.getProjectStats('/projects/my-app')
console.log(stats.fileCount)
console.log(stats.totalSize)
console.log(stats.fileTypes)  // Breakdown by extension

---

vfs.searchEntities(query) → Promise<VFSEntity[]>

Search for VFS entities by metadata.

const tsxFiles = await brain.vfs.searchEntities({
  type: 'file',
  extension: '.tsx'
})

---

📖 Complete VFS Documentation →

---

Neural API

Access advanced AI features via brain.neural() (method that returns NeuralAPI instance).

neural().similar(a, b, options?) → Promise<number | SimilarityResult>

Calculate semantic similarity.

// Simple similarity score
const score = await brain.neural().similar(
  'renewable energy',
  'sustainable power'
)  // 0.87

// Detailed result
const result = await brain.neural().similar('text1', 'text2', {
  detailed: true
})
console.log(result.score)
console.log(result.explanation)

---

neural().clusters(input?, options?) → Promise<Cluster[]>

Automatic clustering.

const clusters = await brain.neural().clusters({
  algorithm: 'kmeans',
  k: 5,
  minSize: 3
})

clusters.forEach(cluster => {
  console.log(cluster.label)
  console.log(cluster.items)
  console.log(cluster.centroid)
})

---

neural().neighbors(id, options?) → Promise<Neighbor[]>

Find k-nearest neighbors.

const neighbors = await brain.neural().neighbors(entityId, {
  k: 10,
  threshold: 0.7
})

---

neural().outliers(threshold?) → Promise<string[]>

Detect outlier entities.

const outliers = await brain.neural().outliers(0.3)
// Returns entity IDs that are outliers

---

neural().visualize(options?) → Promise<VizData>

Generate visualization data.

const vizData = await brain.neural().visualize({
  maxNodes: 100,
  dimensions: 3,
  algorithm: 'force',
  includeEdges: true
})
// Use with D3.js, Cytoscape, GraphML tools

---

Performance Methods

neural().clusterFast(options) → Promise<Cluster[]>

Fast clustering for large datasets.

const clusters = await brain.neural().clusterFast({
  k: 10,
  maxIterations: 50
})

---

neural().clusterLarge(options) → Promise<Cluster[]>

Streaming clustering for very large datasets.

const clusters = await brain.neural().clusterLarge({
  k: 20,
  batchSize: 1000
})

---

Import & Export

import(source, options?) → Promise<ImportResult>

Smart import with auto-detection (CSV, Excel, PDF, JSON, URLs).

// CSV import
await brain.import('data.csv', {
  format: 'csv',
  createEntities: true
})

// Excel import
await brain.import('sales.xlsx', {
  format: 'excel',
  sheets: ['Q1', 'Q2']
})

// PDF import
await brain.import('research.pdf', {
  format: 'pdf',
  extractTables: true
})

// URL import
await brain.import('https://api.example.com/data.json')

Parameters:

• source: string | Buffer | object - File path, URL, buffer, or object
• options?: Import configuration
  • format?: 'csv' | 'excel' | 'pdf' | 'json' - Auto-detected if omitted
  • createEntities?: boolean - Create entities from rows
  • sheets?: string[] - Excel sheets to import
  • extractTables?: boolean - Extract tables from PDF

Returns: Promise<ImportResult> - Import statistics

Note: Import always uses the current branch (v5.1.0 verified).

📖 Complete Import Guide →

---

Export & Backup

// Export to file
await brain.export('/path/to/backup.brainy')

// Create backup snapshot
const backup = await brain.backup()

// Restore from backup
await brain.restore(backup)

---

Configuration

Constructor Options

const brain = new Brainy({
  // Storage configuration
  storage: {
    type: 'memory',              // memory | opfs | filesystem | s3 | r2 | gcs | azure
    path: './brainy-data',       // For filesystem storage
    compression: true,           // Enable gzip compression (60-80% savings)

    // Cloud storage configs (see Storage Adapters section)
    s3Storage: { ... },
    r2Storage: { ... },
    gcsStorage: { ... },
    azureStorage: { ... }
  },

  // HNSW vector index config
  hnsw: {
    M: 16,                       // Connections per layer
    efConstruction: 200,         // Construction quality
    efSearch: 100,               // Search quality
    typeAware: true              // Enable type-aware indexing (v4.0+)
  },

  // Model configuration
  model: {
    type: 'transformers',        // transformers | custom
    name: 'Xenova/all-MiniLM-L6-v2',
    device: 'auto'               // auto | cpu | gpu
  },

  // Cache configuration
  cache: {
    enabled: true,
    maxSize: 10000,
    ttl: 3600000                 // 1 hour in ms
  }
})

await brain.init()  // Required! VFS auto-initialized in v5.1.0

---

Storage Adapters

All 7 storage adapters support copy-on-write branching (v5.0+).

Memory (Default)

const brain = new Brainy({
  storage: { type: 'memory' }
})

Use case: Development, testing, prototyping

---

OPFS (Browser)

const brain = new Brainy({
  storage: { type: 'opfs' }
})

Use case: Browser applications with persistent storage

---

Filesystem (Node.js)

const brain = new Brainy({
  storage: {
    type: 'filesystem',
    path: './brainy-data',
    compression: true  // 60-80% space savings
  }
})

Use case: Node.js applications, local persistence

---

AWS S3

const brain = new Brainy({
  storage: {
    type: 's3',
    s3Storage: {
      bucketName: 'my-brainy-data',
      region: 'us-east-1',
      accessKeyId: process.env.AWS_ACCESS_KEY_ID,
      secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
    }
  }
})

// Enable Intelligent-Tiering for 96% cost savings
await brain.storage.enableIntelligentTiering('entities/', 'auto-tier')

Use case: Production deployments, scalable storage

📖 AWS S3 Cost Optimization →

---

Cloudflare R2

const brain = new Brainy({
  storage: {
    type: 'r2',
    r2Storage: {
      accountId: process.env.CF_ACCOUNT_ID,
      bucketName: 'my-brainy-data',
      accessKeyId: process.env.CF_ACCESS_KEY_ID,
      secretAccessKey: process.env.CF_SECRET_ACCESS_KEY
    }
  }
})

Use case: Zero egress fees, cost-effective storage

📖 R2 Cost Optimization →

---

Google Cloud Storage (GCS)

const brain = new Brainy({
  storage: {
    type: 'gcs',
    gcsStorage: {
      bucketName: 'my-brainy-data',
      projectId: process.env.GCP_PROJECT_ID,
      keyFilename: './gcp-key.json'
    }
  }
})

// Enable auto-tiering
await brain.storage.enableAutoclass({
  terminalStorageClass: 'ARCHIVE'
})

Use case: Google Cloud ecosystem, global distribution

📖 GCS Cost Optimization →

---

Azure Blob Storage

const brain = new Brainy({
  storage: {
    type: 'azure',
    azureStorage: {
      accountName: process.env.AZURE_STORAGE_ACCOUNT,
      accountKey: process.env.AZURE_STORAGE_KEY,
      containerName: 'brainy-data'
    }
  }
})

Use case: Azure ecosystem, enterprise deployments

📖 Azure Cost Optimization →

---

Utility Methods

clear() → Promise<void>

Clear all data (entities and relationships).

await brain.clear()

---

getNounCount() → Promise<number>

Get total entity count.

const count = await brain.getNounCount()

---

getVerbCount() → Promise<number>

Get total relationship count.

const count = await brain.getVerbCount()

---

embed(data) → Promise<number[]>

Generate embedding vector from text.

const vector = await brain.embed('Hello world')
// [0.1, -0.3, 0.8, ...]

---

getStats() → Statistics

Get comprehensive statistics.

const stats = brain.getStats()
console.log(stats.entityCount)
console.log(stats.relationshipCount)
console.log(stats.cacheHitRate)

---

Lifecycle

Initialization

const brain = new Brainy(config)
await brain.init()  // Required! VFS auto-initialized here (v5.1.0)

v5.1.0 Change: VFS is now auto-initialized during brain.init() - no separate vfs.init() needed!

---

Shutdown

await brain.shutdown()  // Graceful shutdown, flush caches

---

Examples

Basic CRUD

// Create
const id = await brain.add({
  data: 'Quantum computing breakthrough',
  type: NounType.Content,
  metadata: { category: 'tech', year: 2024 }
})

// Read
const entity = await brain.get(id)

// Update
await brain.update({
  id,
  metadata: { updated: true }
})

// Delete
await brain.delete(id)

---

Knowledge Graphs

// Create entities
const ai = await brain.add({
  data: 'Artificial Intelligence',
  type: NounType.Concept
})

const ml = await brain.add({
  data: 'Machine Learning',
  type: NounType.Concept
})

// Create relationship
await brain.relate({
  from: ml,
  to: ai,
  type: VerbType.IsA
})

// Traverse graph
const results = await brain.find({
  connected: { from: ai, depth: 2 }
})

---

Triple Intelligence Query

const results = await brain.find({
  query: 'modern frontend frameworks',      // 🔍 Vector
  where: {                                   // 📊 Document
    year: { greaterThan: 2020 },
    category: { oneOf: ['framework', 'library'] }
  },
  connected: {                               // 🕸️ Graph
    to: reactId,
    depth: 2,
    type: VerbType.BuiltOn
  },
  limit: 10
})

---

Git-Style Workflow (v5.0+)

// Fork for experimentation
const experiment = await brain.fork('test-migration')

// Make changes in isolation
await experiment.add({
  data: 'New feature',
  type: NounType.Content
})

// Commit your work
await experiment.commit({
  message: 'Add new feature',
  author: 'dev@example.com'
})

// Merge back to main
const result = await brain.merge('test-migration', 'main', {
  strategy: 'last-write-wins'
})

console.log(`Added: ${result.added}, Modified: ${result.modified}`)

---

VFS File Management

// Write files
await brain.vfs.writeFile('/docs/README.md', 'Project documentation')
await brain.vfs.mkdir('/src/components', { recursive: true })

// Read files
const content = await brain.vfs.readFile('/docs/README.md')

// Semantic search
const reactFiles = await brain.vfs.search('React components with hooks', {
  path: '/src'
})

// Get tree structure (safe, prevents infinite recursion)
const tree = await brain.vfs.getTreeStructure('/projects', {
  maxDepth: 3
})

---

What's New in v5.0

v5.1.0 (Latest)

• ✅ VFS Auto-Initialization - No more separate vfs.init() calls
• ✅ VFS Property Access - Use brain.vfs.method() instead of brain.vfs().method()
• ✅ Complete COW Support - All 20 TypeAware methods use COW helpers
• ✅ Verified Import/Export - Work correctly with current branch

v5.0.0

• ✅ Instant Fork - Snowflake-style copy-on-write (<100ms fork time)
• ✅ Git-Style Branching - fork, merge, commit, checkout, listBranches
• ✅ Full Branch Isolation - Parent and fork fully isolated
• ✅ Read-Through Inheritance - Forks see parent + own data
• ✅ Universal Storage Support - All 7 adapters support branching

📖 Complete v5.0 Changes →

---

Support & Resources

• 📖 Documentation: Full Documentation
• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• 📦 NPM: @soulcraft/brainy
• ⭐ GitHub: Star us

---

See Also

• Triple Intelligence Architecture - How vector + graph + document work together
• VFS Quick Start - Complete VFS documentation
• Import Anything Guide - CSV, Excel, PDF, URL imports
• Cloud Deployment - Production deployment
• Instant Fork - Git-style branching guide

---

License: MIT © Brainy Contributors

---

Brainy v5.0+ - The Knowledge Operating System From prototype to planet-scale • Zero configuration • Triple Intelligence™ • Git-Style Branching