David Snelling
4f22c46f4c
Add confidence and weight properties to Entity interface and flatten Result fields to top level for improved developer experience and API consistency. Breaking Changes: None (all changes are backward compatible) Phase 2 - Entity Confidence & Weight: - Add confidence (type classification certainty) and weight (entity importance) to Entity interface - Add confidence/weight parameters to AddParams and UpdateParams - Update convertNounToEntity() to extract confidence/weight from storage - Update add() and update() methods to preserve confidence/weight in metadata - Enable developers to specify and access entity confidence/weight scores Phase 3 - Result Field Flattening: - Flatten commonly-used entity fields (type, metadata, data, confidence, weight) to Result top level - Add createResult() helper for consistent Result construction - Update all find() code paths to use createResult() - Enable direct access: result.metadata instead of result.entity.metadata - Preserve full entity in result.entity for backward compatibility VFS Fix (from previous work): - Fix VFSStructureGenerator to use brain.vfs() cached instance instead of creating separate instance - Improve VFS error messages with step-by-step guidance - Update examples to show correct vfs.init() usage - Add comprehensive VFS import verification tests Documentation Updates: - Update API_REFERENCE.md with confidence/weight examples and flattened Result documentation - Enhance JSDoc for add(), get(), find(), similar() with v4.3.0 examples - Document Result structure changes and backward compatibility - Add migration examples showing both old and new access patterns Tests: - Add 16 comprehensive tests for Entity confidence/weight exposure - Add tests for Result field flattening - Add tests for backward compatibility - All tests passing (16/16) API Consistency: - Entity: direct access to confidence/weight - Result: flattened fields + nested entity (both work) - Relation: already had confidence/weight (consistent) - VFS: inherits from Entity (automatic) Files Changed: - src/types/brainy.types.ts - Updated Entity, AddParams, UpdateParams, Result interfaces - src/brainy.ts - Updated implementation and JSDoc for all affected methods - tests/integration/entity-confidence-weight.test.ts - 16 comprehensive tests - docs/API_REFERENCE.md - Updated with v4.3.0 examples - src/importers/VFSStructureGenerator.ts - VFS fix - src/vfs/VirtualFileSystem.ts - Improved error messages - examples/unified-import-example.ts - Added vfs.init() example - tests/integration/vfs-*-verification.test.ts - VFS verification tests 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| tests | ||
| api-server-example.ts | ||
| augmentations-zero-config.ts | ||
| bluesky-distributed-setup.js | ||
| brainy-backup.ts | ||
| complete-import-demo.ts | ||
| debug-vector-similarity.js | ||
| demo.ts | ||
| directory-import-with-caching.ts | ||
| hybrid-type-inference-demo.js | ||
| import-excel-pdf-csv.ts | ||
| import-with-progress.ts | ||
| monitor-cache-performance.ts | ||
| production-ready-demo.js | ||
| quick-import-test.ts | ||
| README.md | ||
| smart-import-example.ts | ||
| test-csv-performance.ts | ||
| test-deduplication.ts | ||
| test-excel-import.ts | ||
| test-excel-performance.ts | ||
| test-pdf-performance.ts | ||
| test-threshold-tuning.js | ||
| unified-import-example.ts | ||
Brainy Examples
This directory contains example code and test scripts for Brainy.
Structure
demo.ts- Basic demonstration of Brainy's core featurestests/- 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.