soulcraft/brainy
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions
brainy/docs/user-guides/README.md
David Snelling 5e0c02e363 chore: Update repository references from soulcraft-research to soulcraftlabs 
- Updated GitHub URLs to github.com/soulcraftlabs/brainy
- Updated git remote origin URL
- Updated all documentation references
2025-08-10 16:42:02 -07:00

4.4 KiB
Raw Permalink Blame History

User Guides

Comprehensive guides for using Brainy's features effectively in your applications.

📖 Available Guides

🔍 Search and Metadata Guide

Master advanced search techniques and metadata management.

  • Field-specific search strategies
  • JSON document search patterns
  • Metadata optimization techniques
  • Search performance tips

✏️ Write-Only Mode Implementation

Optimize data ingestion with write-only mode.

  • High-throughput data loading
  • Batch operation strategies
  • Performance optimization for writes
  • Use cases and implementations

🔒 Read-Only & Frozen Modes

Control immutability for different production scenarios.

  • Read-only with optimizations (default)
  • Completely frozen for compliance
  • Dynamic mode switching
  • Migration from older versions

💾 Cache Configuration

Configure caching for optimal performance.

  • Multi-level caching strategies
  • Memory optimization techniques
  • Cache hit rate improvement
  • Environment-specific settings

📄 JSON Document Search

Search within JSON document fields.

  • Field prioritization strategies
  • Service-based field mapping
  • Cross-service search patterns
  • Advanced querying techniques

🎯 HNSW Field Search

Field-specific vector search techniques.

  • Targeted field searches
  • Search scope optimization
  • Performance considerations
  • Integration patterns

🤖 Model Management

Manage AI models and embeddings effectively.

  • Embedding model selection
  • Custom embedding functions
  • Model performance optimization
  • Version management strategies

🚀 Production Migration Guide

Best practices for production deployment.

  • Environment transition strategies
  • Data migration techniques
  • Performance monitoring setup
  • Scaling considerations

🔌 Service Identification

Track and manage data from multiple services.

  • Service-based data organization
  • Cross-service search capabilities
  • Data source attribution
  • Integration patterns

📦 Optional Model Bundling

Optimize bundle size with selective model loading.

  • Bundle size optimization
  • Conditional model loading
  • Performance trade-offs
  • Deployment strategies

🎯 How to Use These Guides

For New Users

  1. Start with Search and Metadata Guide to understand core search concepts
  2. Review JSON Document Search for working with structured data
  3. Check Cache Configuration for performance optimization

For Production Deployments

  1. Read Production Migration Guide for deployment best practices
  2. Implement Write-Only Mode for high-throughput scenarios
  3. Configure Model Management for optimal AI model usage

For Advanced Use Cases

  1. Master HNSW Field Search for specialized search patterns
  2. Implement Service Identification for multi-service architectures
  3. Optimize with Optional Model Bundling for specific deployment needs

🔗 Related Documentation

💡 Pro Tips

  • Read Guides in Order: Each guide builds on concepts from previous ones
  • Test Examples: All guides include working code examples
  • Check Performance: Monitor metrics after implementing guide recommendations
  • Stay Updated: Guides are updated with new features and best practices

🆘 Need Help?