@bedrockio/ai 0.7.0 → 0.7.1

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.7.1
+
+- Better model listing.
+
 ## 0.7.0
 
 - Allow getting the template source.

package/dist/cjs/openai.js

@@ -14,11 +14,33 @@ class OpenAiClient extends BaseClient_js_1.default {
     }
     /**
      * Lists available models.
+     * @param {OpenAICategory} category
      * {@link https://platform.openai.com/docs/models Documentation}
      */
-    async models() {
+    async models(category = 'general') {
         const { data } = await this.client.models.list();
-        return data.map((o) => o.id);
+        const names = [];
+        for (let entry of data) {
+            const model = {
+                ...entry,
+                category: getModelCategory(entry),
+            };
+            if (isMatch(model, category)) {
+                names.push(model.id);
+            }
+        }
+        names.sort((a, b) => {
+            // If one is a prefix of the other, the shorter one comes first
+            if (a.startsWith(b)) {
+                return 1;
+            }
+            else if (b.startsWith(a)) {
+                return -1;
+            }
+            // Otherwise sort alphabetically
+            return b.localeCompare(a);
+        });
+        return names;
     }
     async runPrompt(options) {
         const { model, tools, verbosity, temperature, prevResponseId, messages: input, system: instructions, tool_choice = 'auto', stream = false, } = options;
@@ -136,3 +158,47 @@ class OpenAiClient extends BaseClient_js_1.default {
     }
 }
 exports.OpenAiClient = OpenAiClient;
+// Categories
+const DATE_REG = /\d{4}-\d{2}-\d{2}$|\d{4}/;
+/**
+ * @typedef {
+ *   | "all"
+ *   | "general"
+ *   | "reasoning"
+ *   | "lightweight"
+ *   | "moderation"
+ *   | "embedding"
+ *   | "speech"
+ *   | "audio"
+ *   | "image"
+ *   | "code"
+ *   | "legacy"
+ * } OpenAICategory
+ */
+const MODEL_CATEGORIES = [
+    { name: 'code', reg: /codex/ },
+    { name: 'image', reg: /(dall-e|image|sora)/ },
+    { name: 'audio', reg: /(audio|realtime)/ },
+    { name: 'speech', reg: /(transcribe|tts)/ },
+    { name: 'embedding', reg: /embedding/ },
+    { name: 'moderation', reg: /moderation/ },
+    { name: 'lightweight', reg: /(mini|nano|small)/ },
+    { name: 'reasoning', reg: /(^o\d|deep-research)/ },
+    { name: 'legacy', reg: /(davinci|babbage|curie|ada)/ },
+    { name: 'general', reg: /^gpt/ },
+];
+function getModelCategory(model) {
+    const category = MODEL_CATEGORIES.find((category) => {
+        return category.reg.test(model.id);
+    });
+    return category?.name || 'none';
+}
+function isMatch(model, category) {
+    if (model.owned_by === 'openai-internal') {
+        return false;
+    }
+    else if (DATE_REG.test(model.id)) {
+        return false;
+    }
+    return category === 'all' || model.category === category;
+}

package/dist/esm/openai.js

@@ -8,11 +8,33 @@ export class OpenAiClient extends BaseClient {
     }
     /**
      * Lists available models.
+     * @param {OpenAICategory} category
      * {@link https://platform.openai.com/docs/models Documentation}
      */
-    async models() {
+    async models(category = 'general') {
         const { data } = await this.client.models.list();
-        return data.map((o) => o.id);
+        const names = [];
+        for (let entry of data) {
+            const model = {
+                ...entry,
+                category: getModelCategory(entry),
+            };
+            if (isMatch(model, category)) {
+                names.push(model.id);
+            }
+        }
+        names.sort((a, b) => {
+            // If one is a prefix of the other, the shorter one comes first
+            if (a.startsWith(b)) {
+                return 1;
+            }
+            else if (b.startsWith(a)) {
+                return -1;
+            }
+            // Otherwise sort alphabetically
+            return b.localeCompare(a);
+        });
+        return names;
     }
     async runPrompt(options) {
         const { model, tools, verbosity, temperature, prevResponseId, messages: input, system: instructions, tool_choice = 'auto', stream = false, } = options;
@@ -129,3 +151,47 @@ export class OpenAiClient extends BaseClient {
         }
     }
 }
+// Categories
+const DATE_REG = /\d{4}-\d{2}-\d{2}$|\d{4}/;
+/**
+ * @typedef {
+ *   | "all"
+ *   | "general"
+ *   | "reasoning"
+ *   | "lightweight"
+ *   | "moderation"
+ *   | "embedding"
+ *   | "speech"
+ *   | "audio"
+ *   | "image"
+ *   | "code"
+ *   | "legacy"
+ * } OpenAICategory
+ */
+const MODEL_CATEGORIES = [
+    { name: 'code', reg: /codex/ },
+    { name: 'image', reg: /(dall-e|image|sora)/ },
+    { name: 'audio', reg: /(audio|realtime)/ },
+    { name: 'speech', reg: /(transcribe|tts)/ },
+    { name: 'embedding', reg: /embedding/ },
+    { name: 'moderation', reg: /moderation/ },
+    { name: 'lightweight', reg: /(mini|nano|small)/ },
+    { name: 'reasoning', reg: /(^o\d|deep-research)/ },
+    { name: 'legacy', reg: /(davinci|babbage|curie|ada)/ },
+    { name: 'general', reg: /^gpt/ },
+];
+function getModelCategory(model) {
+    const category = MODEL_CATEGORIES.find((category) => {
+        return category.reg.test(model.id);
+    });
+    return category?.name || 'none';
+}
+function isMatch(model, category) {
+    if (model.owned_by === 'openai-internal') {
+        return false;
+    }
+    else if (DATE_REG.test(model.id)) {
+        return false;
+    }
+    return category === 'all' || model.category === category;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/ai",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Bedrock wrapper for common AI chatbots.",
   "type": "module",
   "scripts": {

package/types/openai.d.ts

@@ -3,9 +3,10 @@ export class OpenAiClient extends BaseClient {
     client: OpenAI;
     /**
      * Lists available models.
+     * @param {OpenAICategory} category
      * {@link https://platform.openai.com/docs/models Documentation}
      */
-    models(): Promise<string[]>;
+    models(category?: OpenAICategory): Promise<string[]>;
     runPrompt(options: any): Promise<OpenAI.Responses.Response & {
         _request_id?: string | null;
     } & import("openai/core/streaming.js").Stream<OpenAI.Responses.ResponseStreamEvent>>;
@@ -54,6 +55,7 @@ export class OpenAiClient extends BaseClient {
         delta?: undefined;
     };
 }
+export type OpenAICategory = any | "all" | "general" | "reasoning" | "lightweight" | "moderation" | "embedding" | "speech" | "audio" | "image" | "code" | "legacy";
 import BaseClient from './BaseClient.js';
 import OpenAI from 'openai';
 //# sourceMappingURL=openai.d.ts.map

package/types/openai.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openai.d.ts","sourceRoot":"","sources":["../src/openai.js"],"names":[],"mappings":"AAIA;IACE,6BAAoC;IAIlC,eAAiC;IAGnC;;;OAGG;IACH,4BAGC;IAED;;yFAiCC;IAED;;yFAKC;IAED,oCAEC;IAwBD;;;MAcC;IAID;;;;;;;;;;MAmBC;IAED;;;;;;;;;;;;;;;;;;;;;;;;MAyBC;CACF;uBAxJsB,iBAAiB;mBAFrB,QAAQ"}
+{"version":3,"file":"openai.d.ts","sourceRoot":"","sources":["../src/openai.js"],"names":[],"mappings":"AAIA;IACE,6BAAoC;IAIlC,eAAiC;IAGnC;;;;OAIG;IACH,kBAHW,cAAc,qBAgCxB;IAED;;yFAiCC;IAED;;yFAKC;IAED,oCAEC;IAwBD;;;MAcC;IAID;;;;;;;;;;MAmBC;IAED;;;;;;;;;;;;;;;;;;;;;;;;MAyBC;CACF;6BAQA,GAAC,GAAK,KAAK,GACL,SAAS,GACT,WAAW,GACX,aAAa,GACb,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ;uBArMQ,iBAAiB;mBAFrB,QAAQ"}