modelmix 2.9.0 → 2.9.4

package/README.md

@@ -8,6 +8,7 @@
 - **Request Rate Control**: Manage the rate of requests to adhere to provider limitations using Bottleneck.
 - **Flexible Integration**: Easily integrate popular models like OpenAI, Anthropic, Perplexity, Groq, Together AI, Ollama, LM Studio or custom models.
 - **History Tracking**: Automatically logs the conversation history with model responses, allowing you to limit the number of historical messages with `max_history`.
+- **Model Fallbacks**: Automatically try different models if one fails or is unavailable.
 
 ## 📦 Installation
 
@@ -82,6 +83,21 @@ Here's a quick example to get you started:
 
 3. **Generate responses from different models**:
 
+    #### Model Fallbacks
+    ```javascript
+    // Create a message handler with multiple fallback models
+    const handler = mmix.create(['grok-2-latest', 'claude-3-7-sonnet-20250219']);
+    
+    // If the first model (grok-2-latest) fails or is unavailable,
+    // ModelMix will automatically try the next model (claude-3-7-sonnet)
+    const response = await handler.addText('do you like cats?').message();
+    ```
+
+    The `create()` method accepts either a single model name as a string or an array of model names. When an array is provided, ModelMix will attempt to use each model in order until a successful response is received. This is useful for:
+    - Implementing fallback options when a primary model is unavailable
+    - Load balancing across different providers
+    - Ensuring high availability in your application
+
     #### gpt-4o-mini
     ```javascript
     const gpt = mmix.create('gpt-4o-mini', { options: { temperature: 0 } });
@@ -247,7 +263,7 @@ new ModelMix(args = { options: {}, config: {} })
     - ...(Additional default options can be added as needed)
   - **config**: This object contains configuration settings that control the behavior of the `ModelMix` instance. These settings can also be overridden for specific model instances. Examples of configuration settings include:
     - `system`: Sets the default system message for the model, e.g., "You are an assistant."
-    - `max_history`: Limits the number of historical messages to retain, e.g., 5.
+    - `max_history`: Limits the number of historical messages to retain, e.g., 1.
     - `bottleneck`: Configures the rate limiting behavior using Bottleneck. For example:
       - `maxConcurrent`: Maximum number of concurrent requests
       - `minTime`: Minimum time between requests (in ms)

package/demo/default.env

@@ -1,4 +1,6 @@
 ANTHROPIC_API_KEY=""
 OPENAI_API_KEY=""
 PPLX_API_KEY=""
-GROQ_API_KEY=""
+GROQ_API_KEY=""
+TOGETHER_API_KEY=""
+XAI_API_KEY=""

package/demo/grok.mjs

@@ -0,0 +1,18 @@
+import 'dotenv/config'
+
+import { ModelMix, MixGrok, MixAnthropic, MixOpenAI } from '../index.js';
+
+const mmix = new ModelMix({
+    options: {
+        max_tokens: 2000,
+    },
+    config: {
+        system: 'You are ALF from Melmac.',
+        max_history: 2
+    }
+});
+
+mmix.attach(new MixGrok(), new MixAnthropic(), new MixOpenAI());
+
+const r = await mmix.create(['claude-3-7-sonnet-20250219', 'o3-mini', 'grok-2-latest']).addText('do you like cats?').message();
+console.log(r);

package/index.js

@@ -23,7 +23,7 @@ class ModelMix {
 
         this.config = {
             system: 'You are an assistant.',
-            max_history: 5, // Default max history
+            max_history: 1, // Default max history
             debug: false,
             bottleneck: defaultBottleneckConfig,
             ...args.config
@@ -37,21 +37,39 @@ class ModelMix {
         return this;
     }
 
-    attach(modelInstance) {
-        const key = modelInstance.config.prefix.join("_");
-        this.models[key] = modelInstance;
+    attach(...modelInstances) {
+        for (const modelInstance of modelInstances) {
+            const key = modelInstance.config.prefix.join("_");
+            this.models[key] = modelInstance;
+        }
         return this;
     }
 
-    create(modelKey, args = { config: {}, options: {} }) {
+    create(modelKeys, args = { config: {}, options: {} }) {
+        // If modelKeys is a string, convert it to an array for backwards compatibility
+        const modelArray = Array.isArray(modelKeys) ? modelKeys : [modelKeys];
+
+        if (modelArray.length === 0) {
+            throw new Error('No model keys provided');
+        }
+
+        // Verificar que todos los modelos estén disponibles
+        const unavailableModels = modelArray.filter(modelKey => {
+            return !Object.values(this.models).some(entry =>
+                entry.config.prefix.some(p => modelKey.startsWith(p))
+            );
+        });
+
+        if (unavailableModels.length > 0) {
+            throw new Error(`The following models are not available: ${unavailableModels.join(', ')}`);
+        }
+
+        // Una vez verificado que todos están disponibles, obtener el primer modelo
+        const modelKey = modelArray[0];
         const modelEntry = Object.values(this.models).find(entry =>
             entry.config.prefix.some(p => modelKey.startsWith(p))
         );
 
-        if (!modelEntry) {
-            throw new Error(`Model with prefix matching ${modelKey} is not attached.`);
-        }
-
         const options = {
             ...this.defaultOptions,
             ...modelEntry.options,
@@ -65,7 +83,8 @@ class ModelMix {
             ...args.config
         };
 
-        return new MessageHandler(this, modelEntry, options, config);
+        // Pass remaining models array for fallback
+        return new MessageHandler(this, modelEntry, options, config, modelArray.slice(1));
     }
 
     setSystem(text) {
@@ -96,13 +115,13 @@ class ModelMix {
 }
 
 class MessageHandler {
-    constructor(mix, modelEntry, options, config) {
+    constructor(mix, modelEntry, options, config, fallbackModels = []) {
         this.mix = mix;
         this.modelEntry = modelEntry;
         this.options = options;
         this.config = config;
         this.messages = [];
-
+        this.fallbackModels = fallbackModels;
         this.imagesToProcess = [];
     }
 
@@ -276,22 +295,56 @@ class MessageHandler {
 
     async execute() {
         return this.mix.limiter.schedule(async () => {
-            await this.processImageUrls();
-
-            this.applyTemplate();
-            this.messages = this.messages.slice(-this.config.max_history);
-            this.messages = this.groupByRoles(this.messages);
+            try {
+                await this.processImageUrls();
+                this.applyTemplate();
+                this.messages = this.messages.slice(-this.config.max_history);
+                this.messages = this.groupByRoles(this.messages);
 
-            if (this.messages.length === 0) {
-                throw new Error("No user messages have been added. Use addText(prompt), addTextFromFile(filePath), addImage(filePath), or addImageFromUrl(url) to add a prompt.");
-            }
+                if (this.messages.length === 0) {
+                    throw new Error("No user messages have been added. Use addText(prompt), addTextFromFile(filePath), addImage(filePath), or addImageFromUrl(url) to add a prompt.");
+                }
 
-            this.options.messages = this.messages;
+                this.options.messages = this.messages;
 
-            try {
-                const result = await this.modelEntry.create({ options: this.options, config: this.config });
-                this.messages.push({ role: "assistant", content: result.message });
-                return result;
+                try {
+                    const result = await this.modelEntry.create({ options: this.options, config: this.config });
+                    this.messages.push({ role: "assistant", content: result.message });
+                    return result;
+                } catch (error) {
+                    // If there are fallback models available, try the next one
+                    if (this.fallbackModels.length > 0) {
+                        const nextModelKey = this.fallbackModels[0];
+                        log.warn(`Model ${this.options.model} failed, trying fallback model ${nextModelKey}...`);
+                        
+                        // Create a completely new handler with the fallback model
+                        const nextHandler = this.mix.create(
+                            [nextModelKey, ...this.fallbackModels.slice(1)], 
+                            {
+                                options: {
+                                    // Keep only generic options, not model-specific ones
+                                    max_tokens: this.options.max_tokens,
+                                    temperature: this.options.temperature,
+                                    top_p: this.options.top_p,
+                                    stream: this.options.stream
+                                }
+                            }
+                        );
+                        
+                        // Asignar directamente todos los mensajes
+                        nextHandler.messages = [...this.messages];
+                        
+                        // Mantener el mismo sistema y reemplazos
+                        nextHandler.setSystem(this.config.system);
+                        if (this.config.replace) {
+                            nextHandler.replace(this.config.replace);
+                        }
+                        
+                        // Try with next model
+                        return nextHandler.execute();
+                    }
+                    throw error;
+                }
             } catch (error) {
                 throw error;
             }
@@ -581,6 +634,17 @@ class MixOllama extends MixCustom {
     }
 }
 
+class MixGrok extends MixOpenAI {
+    getDefaultConfig(customConfig) {
+        return super.getDefaultConfig({
+            url: 'https://api.x.ai/v1/chat/completions',
+            prefix: ['grok'],
+            apiKey: process.env.XAI_API_KEY,            
+            ...customConfig
+        });
+    }
+}
+
 class MixLMStudio extends MixCustom {
     getDefaultConfig(customConfig) {
         return super.getDefaultConfig({
@@ -655,4 +719,4 @@ class MixTogether extends MixCustom {
     }
 }
 
-module.exports = { MixCustom, ModelMix, MixAnthropic, MixOpenAI, MixPerplexity, MixOllama, MixLMStudio, MixGroq, MixTogether };
+module.exports = { MixCustom, ModelMix, MixAnthropic, MixOpenAI, MixPerplexity, MixOllama, MixLMStudio, MixGroq, MixTogether, MixGrok };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modelmix",
-  "version": "2.9.0",
+  "version": "2.9.4",
   "description": "🧬 ModelMix - Unified API for Diverse AI LLM.",
   "main": "index.js",
   "repository": {
@@ -15,6 +15,7 @@
     "anthropic",
     "agent",
     "perplexity",
+    "grok",
     "sonnet-3",
     "gpt",
     "claude",
@@ -28,6 +29,7 @@
     "together",
     "o1",
     "deepseek",
+    "fallback",
     "o3",
     "o3-mini",    
     "nousresearch",