Keyboard shortcuts

Press ← or β†’ to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Demo

Experience Needle’s capabilities with our interactive demo! The demo showcases the complete Needle workflow: text-to-image generation and similarity search.

🎯 What You’ll See

The demo demonstrates Needle’s core functionality:

  1. Text Queries: Click on sample queries to see how Needle works
  2. Image Generation: AI-generated images based on your text prompts
  3. Similarity Search: Find similar images from a curated dataset
  4. Real-time Results: See how Needle processes queries and returns results

πŸš€ Try the Demo

πŸ“‹ Demo Features

Search Interface

  • Sample Queries: Pre-defined queries to test different scenarios
  • Generated Images: See AI-generated images for each query
  • Similarity Results: Browse through similar images from the dataset
  • Performance Metrics: View timing information for each search

Directory Management

  • Dataset Overview: See indexed directories and their status
  • Indexing Progress: Watch real-time indexing progress
  • Directory Details: View file counts, sizes, and metadata

Generator Configuration

  • Available Generators: Browse different image generation engines
  • Configuration Options: See how generators can be configured
  • Service Status: Monitor generator service health

System Status

  • Health Monitoring: Check overall system status
  • Service Overview: View all running services
  • Performance Metrics: See system performance indicators

πŸ”§ Technical Details

The demo is built with:

  • Frontend: React with Tailwind CSS
  • Data: Pre-processed sample queries and images
  • API: Mock API simulating the full Needle backend
  • Images: Curated dataset of 1000+ images with embeddings

πŸ“ Demo Structure

demo/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ sample-queries.json    # Pre-defined queries and results
β”‚   └── services/
β”‚       └── mockApi.js         # Mock API responses
β”œβ”€β”€ public/
β”‚   └── demo-images/           # Sample images
└── scripts/
    └── build-sample-queries.py # Script to generate demo data

🎨 Customizing the Demo

You can customize the demo with your own queries and images:

  1. Add Images: Place your images in public/demo-images/
  2. Update Queries: Edit src/sample-queries.json
  3. Rebuild: Run the build script to update the demo

For detailed customization instructions, see the Demo Customization Guide.

πŸš€ Getting Started with Needle

After trying the demo, you can:

  1. Install Needle: Follow our Getting Started guide
  2. Use Needlectl: Learn about our command-line interface
  3. Configure Services: Set up your own image generation and search pipeline

The demo is updated automatically with each release. For the latest features, make sure you’re viewing the most recent version.