modelmix 2.3.2 → 2.4.2

package/README.md

@@ -5,7 +5,7 @@
 ## ✨ Features
 
 - **Unified Interface**: Interact with multiple AI models through a single, coherent API.
-- **Request Control**: Manage the number of parallel requests to adhere to provider limitations (`max_request`).
+- **Request Control**: Manage the number of parallel requests to adhere to provider limitations with `max_request`.
 - **Flexible Integration**: Easily integrate popular models like OpenAI, Anthropic, Perplexity, Groq, 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`.
 
@@ -17,7 +17,7 @@ First, install the ModelMix package:
 npm install modelmix
 ```
 
-Also, install dotenv to manage environment variables:
+Optional: install dotenv to manage environment variables:
 
 ```bash
 npm install dotenv
@@ -51,6 +51,7 @@ Here's a quick example to get you started:
             system: "You are {name} from Melmac.",
             max_history: 2,
             max_request: 1,
+            debug: true
         }
     });
 
@@ -85,9 +86,19 @@ Here's a quick example to get you started:
     gpt.replace({ '{animal}': 'cat' });
     console.log(await gpt.message());
 
-    console.log("\n" + '--------| claude-3-sonnet-20240229 |--------');
-    const claude = mmix.create('claude-3-sonnet-20240229', { temperature: 0.5 });
-    claude.addImage("./watson.jpg");
+    console.log("\n" + '--------| [writer] claude-3-5-sonnet-20240620 |--------');
+    const setup = {
+        config: { system: "You are a writer like Stephen King" },
+        options: { temperature: 0.5 }
+    }
+    const writer = mmix.create('claude-3-5-sonnet-20240620', setup);
+    writer.replace({ '{story_title}': 'The Mysterious Package' }) // or claude.replaceKeyFromFile(key, filePath)
+    const story = await writer.addTextFromFile('./prompt.md').message();
+    console.log(story);
+
+    console.log("\n" + '--------| [image] claude-3-5-sonnet-20240620 |--------');
+    const claude = mmix.create('claude-3-5-sonnet-20240620', { temperature: 0.5 });
+    claude.addImage("./watson.jpg"); // or claude.addImageFromUrl(url)
     const imageDescription = await claude.addText("Describe the image").message();
     console.log(imageDescription);
 
@@ -134,7 +145,9 @@ new ModelMix(args = { options: {}, config: {} })
 
 - `new()`: Initializes a new message handler instance.
 - `addText(text, config = { role: "user" })`: Adds a text message.
+- `addTextFromFile(filePath, config = { role: "user" })`: Adds a text message from a file path.
 - `addImage(filePath, config = { role: "user" })`: Adds an image message from a file path.
+- `addImageFromUrl(url, config = { role: "user" })`: Adds an image message from URL.
 - `message()`: Sends the message and returns the response.
 - `raw()`: Sends the message and returns the raw response data.
 - `stream(callback)`: Sends the message and streams the response, invoking the callback with each streamed part.
@@ -221,6 +234,81 @@ new MixLMStudio(args = { config: {}, options: {} })
     - `url`: The endpoint URL to which the model sends requests.
   - **options**: Default options for Ollama model instances.
 
+## Explanation of `replace` and `replaceKeyFromFile` Methods
+
+### `replace` Method
+
+The `replace` method is used to define key-value pairs for text replacement in the messages and system prompt. 
+
+#### Usage:
+```javascript
+gpt.replace({ '{{key1}}': 'value1', '{{key2}}': 'value2' });
+```
+
+#### How it works:
+-  It updates the `config.replace` object with the provided key-value pairs.
+-  In the template, placeholders like `{{key1}}` will be replaced with 'value1'.
+
+#### Example:
+```javascript
+gpt
+  .replace({ '{{name}}': 'Alice', '{{age}}': '30' })
+  .addText('Hello {{name}}, are you {{age}} years old?');
+```
+This would result in the message: "Hello Alice, are you 30 years old?"
+
+### `replaceKeyFromFile` Method
+
+The `replaceKeyFromFile` method is similar to `replace`, but it reads the replacement value from a file.
+
+#### Usage:
+```javascript
+messageHandler.replaceKeyFromFile('longText', './path/to/file.txt');
+```
+
+#### How it works:
+1. It reads the content of the specified file synchronously.
+2. It then calls the `replace` method, using the provided key and the file content as the value.
+
+#### Example:
+```javascript
+messageHandler
+  .replaceKeyFromFile('article_file_contents', './article.txt')
+  .addText('Please summarize this article: article_file_contents');
+```
+This would replace `article_file_contents` with the entire content of 'article.txt'.
+
+### When to use each method:
+- Use `replace` for short, inline replacements or dynamically generated content.
+- Use `replaceKeyFromFile` for longer texts or content that's stored externally.
+
+Both methods allow for flexible content insertion, enabling you to create dynamic and customizable prompts for your AI model interactions.
+
+## Enabling Debug Mode in ModelMix
+
+To activate debug mode in ModelMix and view detailed request information, follow these two steps:
+
+1. In the ModelMix constructor, include `debug: true` in the configuration:
+
+   ```javascript
+   const mix = new ModelMix({
+     config: {
+       debug: true
+       // ... other configuration options ...
+     }
+   });
+   ```
+
+2. When running your script from the command line, use the `DEBUG=ModelMix*` prefix:
+
+   ```
+   DEBUG=ModelMix* node your_script.js
+   ```
+
+When you run your script this way, you'll see detailed information about the requests in the console, including the configuration and options used for each AI model request.
+
+This information is valuable for debugging and understanding how ModelMix is processing your requests.
+
 ## 🤝 Contributing
 
 Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request on the [GitHub repository](https://github.com/clasen/ModelMix).

package/demo/demo.mjs

@@ -9,6 +9,7 @@ const mmix = new ModelMix({
         system: 'You are {name} from Melmac.',
         max_history: 2,
         max_request: 1,
+        debug: true,
     }
 });
 
@@ -38,18 +39,28 @@ console.log(await gpt.message());
 
 console.log("\n" + '--------| claude-3-5-sonnet-20240620 |--------');
 const claude = mmix.create('claude-3-5-sonnet-20240620', { temperature: 0.5 });
-claude.addImage('./watson.jpg');
+claude.addImageFromUrl('https://pbs.twimg.com/media/F6-GsjraAAADDGy?format=jpg');
 const imageDescription = await claude.addText('describe the image').message();
 console.log(imageDescription);
 
+console.log("\n" + '--------| claude-3-5-sonnet-20240620 |--------');
+const setup = {
+    config: { system: "You are a writer like Stephen King" },
+    options: { temperature: 0.5 }
+}
+const writer = mmix.create('claude-3-5-sonnet-20240620', setup);
+writer.replaceKeyFromFile('{story_title}', './title.md');
+const story = await writer.addTextFromFile('./prompt.md').message();
+console.log(story);
+
 console.log("\n" + '--------| llama-3-sonar-large-32k-online |--------');
 const pplx = mmix.create('llama-3-sonar-large-32k-online', { max_tokens: 500 });
 pplx.addText('How much is ETH trading in USD?');
 const news = await pplx.addText('What are the 3 most recent Ethereum news?').message();
 console.log(news);
 
-console.log("\n" + '--------| ollama (llava:latest) |--------');
-await mmix.create('llava:latest')
-    .addImage('./watson.jpg')
-    .addText('what is the predominant color?')
-    .stream((data) => { console.log(data.message); });
+// console.log("\n" + '--------| ollama (llava:latest) |--------');
+// await mmix.create('llava:latest')
+//     .addImage('./watson.jpg')
+//     .addText('what is the predominant color?')
+//     .stream((data) => { console.log(data.message); });

package/demo/prompt.md

@@ -0,0 +1,25 @@
+# Writing Prompt: {story_title}
+
+## Setting
+A small, quiet town where nothing unusual ever happens.
+
+## Main Character
+You are a postal worker who has worked in this town for over 20 years.
+
+## Situation
+One day, you come across a package with these unusual characteristics:
+- No return address
+- Addressed to a person who doesn't exist in town
+- Emits a faint, pulsing glow
+- Feels unusually warm to the touch
+
+## Writing Task
+Write a short story (500-1000 words) that explores:
+1. Your character's decision on what to do with the package
+2. The consequences of that decision
+3. The ultimate revelation of what's inside the package and its significance
+
+### Additional Elements to Consider
+- The reactions of other townspeople
+- Any changes in the town's atmosphere after the package's arrival
+- Your character's internal conflict between curiosity and duty

package/demo/title.md

@@ -0,0 +1 @@
+The Mysterious Package

package/index.js

@@ -1,6 +1,7 @@
 const axios = require('axios');
 const fs = require('fs');
 const mime = require('mime-types');
+const log = require('lemonlog')('ModelMix');
 
 class ModelMix {
     constructor(args = { options: {}, config: {} }) {
@@ -16,6 +17,7 @@ class ModelMix {
             system: 'You are an assistant.',
             max_request: 1,
             max_history: 5, // Default max history
+            debug: false,
             ...args.config
         }
     }
@@ -89,6 +91,8 @@ class MessageHandler {
         this.options = options;
         this.config = config;
         this.messages = [];
+
+        this.imagesToProcess = [];
     }
 
     new() {
@@ -106,6 +110,16 @@ class MessageHandler {
         return this;
     }
 
+    addTextFromFile(filePath, config = { role: "user" }) {
+        try {
+            const content = fs.readFileSync(filePath, { encoding: 'utf8' });
+            this.addText(content, config);
+        } catch (error) {
+            console.error(`Error reading file ${filePath}:`, error);
+        }
+        return this;
+    }
+
     addImage(filePath, config = { role: "user" }) {
         try {
             const imageBuffer = fs.readFileSync(filePath);
@@ -139,6 +153,46 @@ class MessageHandler {
         return this;
     }
 
+    addImageFromUrl(url, config = { role: "user" }) {
+        this.imagesToProcess.push({ url, config });
+        return this;
+    }
+
+    async processImageUrls() {
+        const imageContents = await Promise.all(
+            this.imagesToProcess.map(async (image) => {
+                try {
+                    const response = await axios.get(image.url, { responseType: 'arraybuffer' });
+                    const base64 = Buffer.from(response.data, 'binary').toString('base64');
+                    const mimeType = response.headers['content-type'];
+                    return { base64, mimeType, config: image.config };
+                } catch (error) {
+                    console.error(`Error descargando imagen desde ${image.url}:`, error);
+                    return null;
+                }
+            })
+        );
+
+        imageContents.forEach((image) => {
+            if (image) {
+                const imageMessage = {
+                    ...image.config,
+                    content: [
+                        {
+                            type: "image",
+                            "source": {
+                                type: "base64",
+                                media_type: image.mimeType,
+                                data: image.base64
+                            }
+                        }
+                    ]
+                };
+                this.messages.push(imageMessage);
+            }
+        });
+    }
+
     async message() {
         this.options.stream = false;
         const response = await this.execute();
@@ -161,6 +215,16 @@ class MessageHandler {
         return this;
     }
 
+    replaceKeyFromFile(key, filePath) {
+        try {
+            const content = fs.readFileSync(filePath, { encoding: 'utf8' });
+            this.replace({ [key]: content });
+        } catch (error) {
+            console.error(`Error reading file ${filePath}:`, error);
+        }
+        return this;
+    }
+
     template(input, replace) {
         return input.split(/([¿?¡!,"';:\.\s])/).map(x => x in replace ? replace[x] : x).join("");
     }
@@ -197,12 +261,14 @@ class MessageHandler {
 
     async execute() {
 
+        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 addMessage(prompt) to add a message.");
+            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;
@@ -255,6 +321,13 @@ class MixCustom {
 
     async create(args = { config: {}, options: {} }) {
 
+        if (args.config.debug) {
+            log.info("config");
+            log.info(args.config);
+            log.inspect("options");
+            log.inspect(args.options);
+        }
+
         if (args.options.stream) {
             return this.processStream(await axios.post(this.config.url, args.options, {
                 headers: this.headers,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modelmix",
-  "version": "2.3.2",
+  "version": "2.4.2",
   "description": "🧬 ModelMix - Unified API for Diverse AI Language Models.",
   "main": "index.js",
   "repository": {
@@ -36,6 +36,7 @@
   },
   "homepage": "https://github.com/clasen/ModelMix#readme",
   "dependencies": {
-    "axios": "^1.6.8"
+    "axios": "^1.6.8",
+    "lemonlog": "^1.1.2"
   }
-}
+}