modelmix 2.3.8 → 2.4.2

package/README.md

@@ -92,8 +92,8 @@ Here's a quick example to get you started:
         options: { temperature: 0.5 }
     }
     const writer = mmix.create('claude-3-5-sonnet-20240620', setup);
-    writer.replace({ '{story_title}': 'The Mysterious Package' })
-    const story = await writer.addTextFile('./prompt.md').message();
+    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 |--------');
@@ -145,7 +145,7 @@ new ModelMix(args = { options: {}, config: {} })
 
 - `new()`: Initializes a new message handler instance.
 - `addText(text, config = { role: "user" })`: Adds a text message.
-- `addTextFile(filePath, config = { role: "user" })`: Adds a text message from a file path.
+- `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.
@@ -234,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

@@ -49,8 +49,8 @@ const setup = {
     options: { temperature: 0.5 }
 }
 const writer = mmix.create('claude-3-5-sonnet-20240620', setup);
-writer.replace({ '{story_title}': 'The Mysterious Package' })
-const story = await writer.addTextFile('./prompt.md').message();
+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 |--------');

package/demo/title.md

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

package/index.js

@@ -92,7 +92,6 @@ class MessageHandler {
         this.config = config;
         this.messages = [];
 
-        this.filesToProcess = [];
         this.imagesToProcess = [];
     }
 
@@ -111,8 +110,13 @@ class MessageHandler {
         return this;
     }
 
-    addTextFile(filePath, config = { role: "user" }) {
-        this.filesToProcess.push({ filePath, config });
+    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;
     }
 
@@ -154,26 +158,6 @@ class MessageHandler {
         return this;
     }
 
-    async processTextFiles() {
-        const fileContents = await Promise.all(
-            this.filesToProcess.map(async (file) => {
-                try {
-                    const content = fs.readFileSync(file.filePath).toString();
-                    return { content, config: file.config };
-                } catch (error) {
-                    console.error(`Error leyendo archivo ${file.filePath}:`, error);
-                    return null;
-                }
-            })
-        );
-
-        fileContents.forEach((file) => {
-            if (file) {
-                this.addText(file.content, file.config);
-            }
-        });
-    }
-
     async processImageUrls() {
         const imageContents = await Promise.all(
             this.imagesToProcess.map(async (image) => {
@@ -231,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("");
     }
@@ -267,17 +261,14 @@ class MessageHandler {
 
     async execute() {
 
-        await Promise.all([
-            this.processTextFiles(),
-            this.processImageUrls()
-        ]);
+        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), addTextFile(filePath), addImage(filePath), or addImageFromUrl(url) to add a prompt.");
+            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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modelmix",
-  "version": "2.3.8",
+  "version": "2.4.2",
   "description": "🧬 ModelMix - Unified API for Diverse AI Language Models.",
   "main": "index.js",
   "repository": {

package/demo/node_modules/.package-lock.json

@@ -1,254 +0,0 @@
-{
-  "name": "demo",
-  "version": "1.0.0",
-  "lockfileVersion": 3,
-  "requires": true,
-  "packages": {
-    ".api/apis/pplx": {
-      "name": "@api/pplx",
-      "version": "0.1.0",
-      "extraneous": true,
-      "dependencies": {
-        "api": "^6.1.1",
-        "json-schema-to-ts": "^2.8.0-beta.0",
-        "oas": "^20.10.3"
-      }
-    },
-    "node_modules/@anthropic-ai/sdk": {
-      "version": "0.20.9",
-      "resolved": "https://registry.npmjs.org/@anthropic-ai/sdk/-/sdk-0.20.9.tgz",
-      "integrity": "sha512-Lq74+DhiEQO6F9/gdVOLmHx57pX45ebK2Q/zH14xYe1157a7QeUVknRqIp0Jz5gQI01o7NKbuv9Dag2uQsLjDg==",
-      "dependencies": {
-        "@types/node": "^18.11.18",
-        "@types/node-fetch": "^2.6.4",
-        "abort-controller": "^3.0.0",
-        "agentkeepalive": "^4.2.1",
-        "form-data-encoder": "1.7.2",
-        "formdata-node": "^4.3.2",
-        "node-fetch": "^2.6.7",
-        "web-streams-polyfill": "^3.2.1"
-      }
-    },
-    "node_modules/@types/node": {
-      "version": "18.19.33",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.33.tgz",
-      "integrity": "sha512-NR9+KrpSajr2qBVp/Yt5TU/rp+b5Mayi3+OlMlcg2cVCfRmcG5PWZ7S4+MG9PZ5gWBoc9Pd0BKSRViuBCRPu0A==",
-      "dependencies": {
-        "undici-types": "~5.26.4"
-      }
-    },
-    "node_modules/@types/node-fetch": {
-      "version": "2.6.11",
-      "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.6.11.tgz",
-      "integrity": "sha512-24xFj9R5+rfQJLRyM56qh+wnVSYhyXC2tkoBndtY0U+vubqNsYXGjufB2nn8Q6gt0LrARwL6UBtMCSVCwl4B1g==",
-      "dependencies": {
-        "@types/node": "*",
-        "form-data": "^4.0.0"
-      }
-    },
-    "node_modules/abort-controller": {
-      "version": "3.0.0",
-      "resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz",
-      "integrity": "sha512-h8lQ8tacZYnR3vNQTgibj+tODHI5/+l06Au2Pcriv/Gmet0eaj4TwWH41sO9wnHDiQsEj19q0drzdWdeAHtweg==",
-      "dependencies": {
-        "event-target-shim": "^5.0.0"
-      },
-      "engines": {
-        "node": ">=6.5"
-      }
-    },
-    "node_modules/agentkeepalive": {
-      "version": "4.5.0",
-      "resolved": "https://registry.npmjs.org/agentkeepalive/-/agentkeepalive-4.5.0.tgz",
-      "integrity": "sha512-5GG/5IbQQpC9FpkRGsSvZI5QYeSCzlJHdpBQntCsuTOxhKD8lqKhrleg2Yi7yvMIf82Ycmmqln9U8V9qwEiJew==",
-      "dependencies": {
-        "humanize-ms": "^1.2.1"
-      },
-      "engines": {
-        "node": ">= 8.0.0"
-      }
-    },
-    "node_modules/asynckit": {
-      "version": "0.4.0",
-      "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
-      "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q=="
-    },
-    "node_modules/combined-stream": {
-      "version": "1.0.8",
-      "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
-      "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==",
-      "dependencies": {
-        "delayed-stream": "~1.0.0"
-      },
-      "engines": {
-        "node": ">= 0.8"
-      }
-    },
-    "node_modules/delayed-stream": {
-      "version": "1.0.0",
-      "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
-      "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==",
-      "engines": {
-        "node": ">=0.4.0"
-      }
-    },
-    "node_modules/dotenv": {
-      "version": "16.4.5",
-      "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.4.5.tgz",
-      "integrity": "sha512-ZmdL2rui+eB2YwhsWzjInR8LldtZHGDoQ1ugH85ppHKwpUHL7j7rN0Ti9NCnGiQbhaZ11FpR+7ao1dNsmduNUg==",
-      "engines": {
-        "node": ">=12"
-      },
-      "funding": {
-        "url": "https://dotenvx.com"
-      }
-    },
-    "node_modules/event-target-shim": {
-      "version": "5.0.1",
-      "resolved": "https://registry.npmjs.org/event-target-shim/-/event-target-shim-5.0.1.tgz",
-      "integrity": "sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ==",
-      "engines": {
-        "node": ">=6"
-      }
-    },
-    "node_modules/form-data": {
-      "version": "4.0.0",
-      "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz",
-      "integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==",
-      "dependencies": {
-        "asynckit": "^0.4.0",
-        "combined-stream": "^1.0.8",
-        "mime-types": "^2.1.12"
-      },
-      "engines": {
-        "node": ">= 6"
-      }
-    },
-    "node_modules/form-data-encoder": {
-      "version": "1.7.2",
-      "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-1.7.2.tgz",
-      "integrity": "sha512-qfqtYan3rxrnCk1VYaA4H+Ms9xdpPqvLZa6xmMgFvhO32x7/3J/ExcTd6qpxM0vH2GdMI+poehyBZvqfMTto8A=="
-    },
-    "node_modules/formdata-node": {
-      "version": "4.4.1",
-      "resolved": "https://registry.npmjs.org/formdata-node/-/formdata-node-4.4.1.tgz",
-      "integrity": "sha512-0iirZp3uVDjVGt9p49aTaqjk84TrglENEDuqfdlZQ1roC9CWlPk6Avf8EEnZNcAqPonwkG35x4n3ww/1THYAeQ==",
-      "dependencies": {
-        "node-domexception": "1.0.0",
-        "web-streams-polyfill": "4.0.0-beta.3"
-      },
-      "engines": {
-        "node": ">= 12.20"
-      }
-    },
-    "node_modules/formdata-node/node_modules/web-streams-polyfill": {
-      "version": "4.0.0-beta.3",
-      "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-4.0.0-beta.3.tgz",
-      "integrity": "sha512-QW95TCTaHmsYfHDybGMwO5IJIM93I/6vTRk+daHTWFPhwh+C8Cg7j7XyKrwrj8Ib6vYXe0ocYNrmzY4xAAN6ug==",
-      "engines": {
-        "node": ">= 14"
-      }
-    },
-    "node_modules/humanize-ms": {
-      "version": "1.2.1",
-      "resolved": "https://registry.npmjs.org/humanize-ms/-/humanize-ms-1.2.1.tgz",
-      "integrity": "sha512-Fl70vYtsAFb/C06PTS9dZBo7ihau+Tu/DNCk/OyHhea07S+aeMWpFFkUaXRa8fI+ScZbEI8dfSxwY7gxZ9SAVQ==",
-      "dependencies": {
-        "ms": "^2.0.0"
-      }
-    },
-    "node_modules/mime-db": {
-      "version": "1.52.0",
-      "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz",
-      "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==",
-      "engines": {
-        "node": ">= 0.6"
-      }
-    },
-    "node_modules/mime-types": {
-      "version": "2.1.35",
-      "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz",
-      "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==",
-      "dependencies": {
-        "mime-db": "1.52.0"
-      },
-      "engines": {
-        "node": ">= 0.6"
-      }
-    },
-    "node_modules/ms": {
-      "version": "2.1.3",
-      "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
-      "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="
-    },
-    "node_modules/node-domexception": {
-      "version": "1.0.0",
-      "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz",
-      "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==",
-      "funding": [
-        {
-          "type": "github",
-          "url": "https://github.com/sponsors/jimmywarting"
-        },
-        {
-          "type": "github",
-          "url": "https://paypal.me/jimmywarting"
-        }
-      ],
-      "engines": {
-        "node": ">=10.5.0"
-      }
-    },
-    "node_modules/node-fetch": {
-      "version": "2.7.0",
-      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz",
-      "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==",
-      "dependencies": {
-        "whatwg-url": "^5.0.0"
-      },
-      "engines": {
-        "node": "4.x || >=6.0.0"
-      },
-      "peerDependencies": {
-        "encoding": "^0.1.0"
-      },
-      "peerDependenciesMeta": {
-        "encoding": {
-          "optional": true
-        }
-      }
-    },
-    "node_modules/tr46": {
-      "version": "0.0.3",
-      "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
-      "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw=="
-    },
-    "node_modules/undici-types": {
-      "version": "5.26.5",
-      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
-      "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA=="
-    },
-    "node_modules/web-streams-polyfill": {
-      "version": "3.3.3",
-      "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.3.3.tgz",
-      "integrity": "sha512-d2JWLCivmZYTSIoge9MsgFCZrt571BikcWGYkjC1khllbTeDlGqZ2D8vD8E/lJa8WGWbb7Plm8/XJYV7IJHZZw==",
-      "engines": {
-        "node": ">= 8"
-      }
-    },
-    "node_modules/webidl-conversions": {
-      "version": "3.0.1",
-      "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
-      "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ=="
-    },
-    "node_modules/whatwg-url": {
-      "version": "5.0.0",
-      "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
-      "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==",
-      "dependencies": {
-        "tr46": "~0.0.3",
-        "webidl-conversions": "^3.0.0"
-      }
-    }
-  }
-}