docs: v5.11.1 brain.get() metadata-only optimization (Phase 3)
Added comprehensive documentation for the 76-81% performance improvement:
Documentation Updates:
- API_REFERENCE.md: Updated brain.get() signature with GetOptions, examples
- PERFORMANCE.md: Added v5.11.1 section with performance table and usage guide
- vfs/README.md: Added performance callout (75% faster operations)
- guides/MIGRATING_TO_V5.11.md: Complete migration guide with patterns, FAQ
Key Documentation Points:
- Default behavior: metadata-only (76-81% faster)
- Opt-in vectors: { includeVectors: true } when needed
- VFS operations: automatic 75% speedup (zero config)
- Migration impact: ~6% of code needs updates
- Performance metrics: 43ms→10ms, 6KB→300bytes
This commit is contained in:
parent
f2f6a6c939
commit
a6e680d792
4 changed files with 302 additions and 8 deletions
|
|
@ -48,6 +48,20 @@ const results = await vfs.search('files about authentication')
|
|||
await vfs.addRelationship('/docs/spec.md', '/projects/my-app/', 'implements')
|
||||
```
|
||||
|
||||
## ⚡ Performance (v5.11.1)
|
||||
|
||||
**75% Faster File Operations!** VFS now automatically benefits from brain.get() metadata-only optimization:
|
||||
|
||||
| Operation | Before (v5.11.0) | After (v5.11.1) | Speedup |
|
||||
|-----------|------------------|-----------------|---------|
|
||||
| `readFile()` | 53ms | **~13ms** | **75%** |
|
||||
| `stat()` | 53ms | **~13ms** | **75%** |
|
||||
| `readdir(100 files)` | 5.3s | **~1.3s** | **75%** |
|
||||
|
||||
**Zero configuration** - automatic optimization for all VFS operations!
|
||||
|
||||
VFS operations only need metadata (path, size, timestamps), not 384-dimensional vector embeddings. The v5.11.1 optimization automatically uses metadata-only reads, saving 95% bandwidth and 76-81% time.
|
||||
|
||||
## Core Features
|
||||
|
||||
### 🆕 Tree Operations (Prevents Recursion Issues)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue