brainy/examples
David Snelling 606445cd61 feat(8.0): API simplification — remove neural()/Db.search, one storage path key, integration→0
8.0 RC cleanup toward "one place per thing, zero-config, no deprecation":

- Remove the `brain.neural()` clustering namespace (ImprovedNeuralAPI + the dead
  legacy NeuralAPI + the neural CLI + neural-only types). Similarity is `find({vector})`
  / `similar({to})`; attribute grouping is the aggregation `GROUP BY` engine. The separate
  entity-extraction / smart-import feature (NeuralImport, NeuralEntityExtractor, SmartExtractor,
  NaturalLanguageProcessor, `brain.extract()`/`brain.nlp()`) is kept.
- Remove `Db.search()`; `find()` is the one query verb (accepts a bare string or FindParams).
  Fix the bundled MCP client, which called a non-existent `brain.search(query, limit)` →
  now `find({ query, limit })`.
- Storage config: collapse to one canonical top-level `path` key. The pre-8.0 aliases
  (`rootDirectory`, `options.*`, `fileSystemStorage.*`) are removed and now THROW with the
  exact rename instead of silently defaulting to `./brainy-data` on upgrade. A single resolver
  feeds createStorage, the 7.x→8.0 migration probe, and the plugin-factory handoff, so a native
  storage provider resolves the identical root (no split-brain).
- Fix `similar({ threshold })`: the min-similarity filter was silently dropped; it is now
  applied as a post-filter on `result.score` (the documented way to bound semantic results).
- Fix `vfs.rename()` on a directory: child path updates spread the entity vector into `update()`
  and failed dimension validation; they are metadata-only updates now.
- Fix `vfs.move()`: copy+delete orphaned the content-addressed content blob (the destination
  shared the source hash, then unlink removed it). `move()` now delegates to `rename()` — an
  in-place path change that preserves the blob and the entity id, for files and directories.
- Fix streaming import: the bulk fast path never flushed mid-import nor signalled queryability.
  Entity writes are now chunked by a progressive flush interval (100 → 1000 → 5000); each chunk
  flushes and emits `progress.queryable`, so imported data is queryable during the import.
- Sweep all docs, comments, and JSDoc for the removed/changed APIs.

Integration suite: 49 files / 588 passed / 0 failed. Unit: 80 files / 1456 passed, no type errors.
2026-06-20 13:31:11 -07:00
..
tests refactor: remove augmentation system and semantic type matching 2026-02-01 10:48:56 -08:00
bluesky-distributed-setup.js feat: add distributed architecture with sharding and coordination 2025-09-22 15:45:35 -07:00
complete-import-demo.ts feat: add real-time progress callbacks for relationship building phase 2025-10-16 12:08:46 -07:00
demo.ts feat: Brainy 3.0 - Production-ready Triple Intelligence database 2025-09-11 16:23:32 -07:00
directory-import-with-caching.ts feat(8.0): API simplification — remove neural()/Db.search, one storage path key, integration→0 2026-06-20 13:31:11 -07:00
import-excel-pdf-csv.ts feat: add intelligent import for CSV, Excel, and PDF files 2025-10-01 16:51:03 -07:00
import-with-progress.ts feat: add real-time progress callbacks for relationship building phase 2025-10-16 12:08:46 -07:00
monitor-cache-performance.ts feat: implement always-adaptive caching with getCacheStats monitoring 2025-10-10 14:09:30 -07:00
quick-import-test.ts feat: add unified import system with auto-detection and dual storage 2025-10-08 16:55:30 -07:00
README.md feat: Brainy 3.0 - Production-ready Triple Intelligence database 2025-09-11 16:23:32 -07:00
smart-import-example.ts feat: add unified import system with auto-detection and dual storage 2025-10-08 16:55:30 -07:00
test-csv-performance.ts feat: extend batch processing and enhanced progress to CSV and PDF imports 2025-10-13 10:32:25 -07:00
test-deduplication.ts feat: add unified import system with auto-detection and dual storage 2025-10-08 16:55:30 -07:00
test-excel-import.ts feat: add unified import system with auto-detection and dual storage 2025-10-08 16:55:30 -07:00
test-excel-performance.ts feat: massive performance improvements for Excel imports with AI extraction 2025-10-13 10:05:58 -07:00
test-pdf-performance.ts feat: extend batch processing and enhanced progress to CSV and PDF imports 2025-10-13 10:32:25 -07:00
unified-import-example.ts feat: add confidence/weight to Entity and flatten Result fields for convenient access 2025-10-23 12:19:50 -07:00

Brainy Examples

This directory contains example code and test scripts for Brainy.

Structure

  • demo.ts - Basic demonstration of Brainy's core features
  • tests/ - Various test scripts demonstrating different aspects of Brainy
    • Performance tests
    • Memory tests
    • Storage adapter tests
    • API functionality tests
    • CLI tests

Running Examples

Basic Demo

npm run build
node dist/examples/demo.js

Test Scripts

The scripts in tests/ are standalone Node.js scripts that can be run directly:

node examples/tests/test-simple.js
node examples/tests/test-core-functionality.js

Note

These are examples and test scripts for reference. For production use, see the main documentation in the project root.