modelmix 1.1.8 → 1.2.2

package/README.md

@@ -45,7 +45,7 @@ Here's a quick example to get you started:
 
     const env = process.env;
 
-    const driver = new ModelMix({
+    const mmix = new ModelMix({
         options: {
             max_tokens: 200,
         },
@@ -55,9 +55,9 @@ Here's a quick example to get you started:
         }
     });
 
-    driver.attach(new OpenAIModel(new OpenAI({ apiKey: env.OPENAI_API_KEY })));
-    driver.attach(new AnthropicModel(new Anthropic({ apiKey: env.ANTHROPIC_API_KEY })));
-    driver.attach(new CustomModel({
+    mmix.attach(new OpenAIModel(new OpenAI({ apiKey: env.OPENAI_API_KEY })));
+    mmix.attach(new AnthropicModel(new Anthropic({ apiKey: env.ANTHROPIC_API_KEY })));
+    mmix.attach(new CustomModel({
         config: {
             url: 'https://api.perplexity.ai/chat/completions',
             bearer: env.PPLX_API_KEY,
@@ -70,16 +70,16 @@ Here's a quick example to get you started:
 3. **Generate responses from different models**:
 
     ```javascript
-    const claude = await driver.create('claude-3-sonnet-20240229', { temperature: 0.5 });
+
+    const gpt = mmix.create('gpt-4o', { temperature: 0.5 }).addText("Have you ever eaten a cat?");
+    console.log(await gpt.message());
+
+    const claude = mmix.create('claude-3-sonnet-20240229', { temperature: 0.5 });
     await claude.addImage("./watson.png")
     const imageDescription = await claude.addText("describe the image").message();
     console.log(imageDescription);
 
-    const gpt = await driver.create('gpt-4o', { temperature: 0.5 });
-    const question = await gpt.addText("Have you ever eaten a cat?").message();
-    console.log(question);
-
-    const pplx = await driver.create('pplx-70b-online', { max_tokens: 500 });
+    const pplx = mmix.create('pplx-70b-online', { max_tokens: 500 });
     await 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);
@@ -90,10 +90,6 @@ Here's a quick example to get you started:
 
 ## 📚 ModelMix Class Overview
 
-#### ModelMix
-
-**Constructor**
-
 ```javascript
 new ModelMix(args = { options: {}, config: {} })
 ```
@@ -107,6 +103,7 @@ new ModelMix(args = { options: {}, config: {} })
     - `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_request`: Limits the number of parallel request.
+    - ...
 
 **Methods**
 
@@ -125,8 +122,6 @@ new ModelMix(args = { options: {}, config: {} })
 
 #### OpenAIModel
 
-**Constructor**
-
 ```javascript
 new OpenAIModel(openai, args = { options: {}, config: {} })
 ```
@@ -136,8 +131,6 @@ new OpenAIModel(openai, args = { options: {}, config: {} })
 
 #### AnthropicModel
 
-**Constructor**
-
 ```javascript
 new AnthropicModel(anthropic, args = { options: {}, config: {} })
 ```
@@ -147,13 +140,21 @@ new AnthropicModel(anthropic, args = { options: {}, config: {} })
 
 #### CustomModel
 
-**Constructor**
-
 ```javascript
 new CustomModel(args = { config: {}, options: {} })
 ```
 
 - **args**: Configuration object with `config` and `options` properties.
+  - **config**: 
+    - `url`: 
+    - `bearer`: 
+    - `prefix`: 
+    - ...
+  - **options**: This object contains default options that are applied to all models. These options can be overridden when creating a specific model instance. Examples of default options include:
+    - `max_tokens`: Sets the maximum number of tokens to generate, e.g., 2000.
+    - `temperature`: Controls the randomness of the model's output, e.g., 1.
+    - `top_p`: Controls the diversity of the output, e.g., 1.
+    - ...
 
 ## 🤝 Contributing
 

package/demo/demo.mjs

@@ -13,7 +13,8 @@ const mmix = new ModelMix({
     },
     config: {
         system: "You are ALF from Melmac.",
-        max_history: 2
+        max_history: 2,
+        max_request: 1,
     }
 });
 
@@ -29,18 +30,17 @@ mmix.attach(new CustomModel({
 }));
 
 console.log("\n" + '--------| gpt-4o |--------');
-const gpt = await mmix.create('gpt-4o', { temperature: 0.5 });
-const question = await gpt.addText("Have you ever eaten a cat?").message();
-console.log(question);
+const gpt = mmix.create('gpt-4o', { temperature: 0.5 }).addText("Have you ever eaten a cat?");
+console.log(await gpt.message());
 
 console.log("\n" + '--------| claude-3-sonnet-20240229 |--------');
-const claude = await mmix.create('claude-3-sonnet-20240229', { temperature: 0.5 });
+const claude = mmix.create('claude-3-sonnet-20240229', { temperature: 0.5 });
 await claude.addImage("./watson.png")
 const imageDescription = await claude.addText("describe the image").message();
 console.log(imageDescription);
 
 console.log("\n" + '--------| pplx-70b-online |--------');
-const pplx = await mmix.create('pplx-70b-online', { max_tokens: 500 });
+const pplx = mmix.create('pplx-70b-online', { max_tokens: 500 });
 await 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);

package/package.json

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