notdiamond 0.3.2 → 0.3.3

package/README.md

@@ -26,26 +26,35 @@ Here's a simple example of how to use NotDiamond to select the best model betwee
 import { NotDiamond } from 'notdiamond';
 
 const notDiamond = new NotDiamond({
+  // Optional - automatically loads from environment variable
   apiKey: process.env.NOTDIAMOND_API_KEY,
 });
 
 async function basicExample() {
+  // 1. Select the best model
   const result = await notDiamond.modelSelect({
+    // Define the user's message
     messages: [{ content: 'What is 12x12?', role: 'user' }],
+    // Specify the LLM providers and models to choose from
     llmProviders: [
       { provider: 'openai', model: 'gpt-4o-2024-05-13' },
       { provider: 'anthropic', model: 'claude-3-5-sonnet-20240620' },
       { provider: 'google', model: 'gemini-1.5-pro-latest' },
     ],
+    // Set the optimization criteria to latency
     tradeoff: 'latency',
   });
 
+  // 2. Handle potential errors
   if ('detail' in result) {
     console.error('Error:', result.detail);
     return;
   }
 
+  // 3. Log the results
+  // Display the selected provider(s)
   console.log('Selected providers:', result.providers);
+  // Show the unique session ID for this request
   console.log('Session ID:', result.session_id);
 }
 
@@ -59,10 +68,9 @@ You can also use NotDiamond with custom tools:
 ```typescript
 import { NotDiamond, Tool } from 'notdiamond';
 
-const notDiamond = new NotDiamond({
-  apiKey: process.env.NOTDIAMOND_API_KEY,
-});
+const notDiamond = new NotDiamond();
 
+// Define custom tools for the AI to use
 const tools: Tool[] = [
   {
     type: 'function',
@@ -88,8 +96,11 @@ async function toolCallingExample() {
       { provider: 'openai', model: 'gpt-4-1106-preview' },
       { provider: 'anthropic', model: 'claude-3-sonnet-20240229' },
     ],
+    // Include custom tools in the request
     tools: tools,
+    // Optimize for cost instead of latency
     tradeoff: 'cost',
+    // Allow selection of up to 2 models
     maxModelDepth: 2,
   });
 

package/dist/index.cjs

@@ -16,7 +16,7 @@ function _interopNamespaceCompat(e) {
 
 const dotenv__namespace = /*#__PURE__*/_interopNamespaceCompat(dotenv);
 
-const version = "0.3.1";
+const version = "0.3.2";
 
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
@@ -72,7 +72,20 @@ class NotDiamond {
     console.log("Calling modelSelect with options:", options);
     const requestBody = {
       messages: options.messages,
-      llm_providers: options.llmProviders,
+      llm_providers: options.llmProviders.map((provider) => ({
+        provider: provider.provider,
+        model: provider.model,
+        ...provider.contextLength !== void 0 && {
+          context_length: provider.contextLength
+        },
+        ...provider.inputPrice !== void 0 && {
+          input_price: provider.inputPrice
+        },
+        ...provider.outputPrice !== void 0 && {
+          output_price: provider.outputPrice
+        },
+        ...provider.latency !== void 0 && { latency: provider.latency }
+      })),
       ...options.tradeoff && {
         tradeoff: options.tradeoff
       },

package/dist/index.d.cts

@@ -4,6 +4,10 @@ interface NotDiamondOptions {
 interface Provider {
     provider: string;
     model: string;
+    contextLength?: number;
+    inputPrice?: number;
+    outputPrice?: number;
+    latency?: number;
 }
 interface NotDiamondErrorResponse {
     detail: string;

package/dist/index.d.mts

@@ -4,6 +4,10 @@ interface NotDiamondOptions {
 interface Provider {
     provider: string;
     model: string;
+    contextLength?: number;
+    inputPrice?: number;
+    outputPrice?: number;
+    latency?: number;
 }
 interface NotDiamondErrorResponse {
     detail: string;

package/dist/index.d.ts

@@ -4,6 +4,10 @@ interface NotDiamondOptions {
 interface Provider {
     provider: string;
     model: string;
+    contextLength?: number;
+    inputPrice?: number;
+    outputPrice?: number;
+    latency?: number;
 }
 interface NotDiamondErrorResponse {
     detail: string;

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import * as dotenv from 'dotenv';
 
-const version = "0.3.1";
+const version = "0.3.2";
 
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
@@ -56,7 +56,20 @@ class NotDiamond {
     console.log("Calling modelSelect with options:", options);
     const requestBody = {
       messages: options.messages,
-      llm_providers: options.llmProviders,
+      llm_providers: options.llmProviders.map((provider) => ({
+        provider: provider.provider,
+        model: provider.model,
+        ...provider.contextLength !== void 0 && {
+          context_length: provider.contextLength
+        },
+        ...provider.inputPrice !== void 0 && {
+          input_price: provider.inputPrice
+        },
+        ...provider.outputPrice !== void 0 && {
+          output_price: provider.outputPrice
+        },
+        ...provider.latency !== void 0 && { latency: provider.latency }
+      })),
       ...options.tradeoff && {
         tradeoff: options.tradeoff
       },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "notdiamond",
   "type": "module",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "author": "not-diamond",
   "license": "MIT",
   "description": "TS/JS client for the NotDiamond API",