@van1s1mys/ai-router 1.0.0 → 1.1.0

package/dist/index.d.cts

@@ -40,11 +40,29 @@ interface RouteOptions {
     /** Array of routes to index for semantic search. */
     routes: RouteConfig[];
     /**
-     * HuggingFace model ID for generating embeddings.
+     * HuggingFace model ID (or an ordered array of IDs) for generating embeddings.
      * Must produce 384-dimensional vectors.
+     *
+     * When an array is provided, the first model is loaded and used immediately.
+     * Heavier models are downloaded in the background; once ready, the router
+     * hot-swaps to the next model and re-indexes all routes automatically.
+     *
      * @default "Xenova/all-MiniLM-L6-v2"
+     *
+     * @example
+     * ```ts
+     * // Start fast with a light model, upgrade to a better one in the background
+     * model: ['Xenova/all-MiniLM-L6-v2', 'Xenova/multilingual-e5-small']
+     * ```
+     */
+    model?: string | string[];
+    /**
+     * Called each time the router upgrades to the next model in the chain.
+     * Only relevant when {@link model} is an array with more than one entry.
+     *
+     * @param modelId - The HuggingFace model ID that just became active.
      */
-    model?: string;
+    onModelUpgrade?: (modelId: string) => void;
     /**
      * Minimum similarity score (0–1) for a result to be returned.
      * Results below this threshold are discarded.
@@ -83,10 +101,13 @@ interface SearchResult {
  *     { path: '/pricing', title: 'Pricing', description: 'cost, plans, subscription' },
  *     { path: '/contact', title: 'Contact', description: 'support, phone, address' },
  *   ],
+ *   // Start with a fast lightweight model, then upgrade to a better one in the background
+ *   model: ['Xenova/all-MiniLM-L6-v2', 'Xenova/multilingual-e5-small'],
  *   threshold: 0.5,
+ *   onModelUpgrade: (modelId) => console.log(`Upgraded to ${modelId}`),
  * });
  *
- * // Wait for the model to load (~22 MB on first run, cached afterwards)
+ * // Wait for the first (lightest) model to load — ready to search immediately
  * await router.ready;
  *
  * // Search by meaning — typos and synonyms work too
@@ -105,6 +126,7 @@ declare class SmartRouter {
     private pendingSearches;
     private destroyed;
     private readonly ssr;
+    private onModelUpgrade?;
     /**
      * Creates a new SmartRouter instance.
      *

package/dist/index.d.ts

@@ -40,11 +40,29 @@ interface RouteOptions {
     /** Array of routes to index for semantic search. */
     routes: RouteConfig[];
     /**
-     * HuggingFace model ID for generating embeddings.
+     * HuggingFace model ID (or an ordered array of IDs) for generating embeddings.
      * Must produce 384-dimensional vectors.
+     *
+     * When an array is provided, the first model is loaded and used immediately.
+     * Heavier models are downloaded in the background; once ready, the router
+     * hot-swaps to the next model and re-indexes all routes automatically.
+     *
      * @default "Xenova/all-MiniLM-L6-v2"
+     *
+     * @example
+     * ```ts
+     * // Start fast with a light model, upgrade to a better one in the background
+     * model: ['Xenova/all-MiniLM-L6-v2', 'Xenova/multilingual-e5-small']
+     * ```
+     */
+    model?: string | string[];
+    /**
+     * Called each time the router upgrades to the next model in the chain.
+     * Only relevant when {@link model} is an array with more than one entry.
+     *
+     * @param modelId - The HuggingFace model ID that just became active.
      */
-    model?: string;
+    onModelUpgrade?: (modelId: string) => void;
     /**
      * Minimum similarity score (0–1) for a result to be returned.
      * Results below this threshold are discarded.
@@ -83,10 +101,13 @@ interface SearchResult {
  *     { path: '/pricing', title: 'Pricing', description: 'cost, plans, subscription' },
  *     { path: '/contact', title: 'Contact', description: 'support, phone, address' },
  *   ],
+ *   // Start with a fast lightweight model, then upgrade to a better one in the background
+ *   model: ['Xenova/all-MiniLM-L6-v2', 'Xenova/multilingual-e5-small'],
  *   threshold: 0.5,
+ *   onModelUpgrade: (modelId) => console.log(`Upgraded to ${modelId}`),
  * });
  *
- * // Wait for the model to load (~22 MB on first run, cached afterwards)
+ * // Wait for the first (lightest) model to load — ready to search immediately
  * await router.ready;
  *
  * // Search by meaning — typos and synonyms work too
@@ -105,6 +126,7 @@ declare class SmartRouter {
     private pendingSearches;
     private destroyed;
     private readonly ssr;
+    private onModelUpgrade?;
     /**
      * Creates a new SmartRouter instance.
      *