aimodels 0.3.10 → 0.3.12

package/README.md

@@ -13,9 +13,34 @@ npm install aimodels
 ```typescript
 import { models } from 'aimodels';
 
-// Find models by capability
-const chatModels = models.can('chat');
-const multimodalModels = models.can('chat', 'img-in');
+// Find models by capability using fluent API
+const chatModels = models.canChat();
+const visionModels = models.canSee();
+const reasoningModels = models.canReason();
+
+// Chain methods for more specific filtering
+const smartVisionModels = models.canChat().canReason().canSee();
+const multimodalAssistants = models.canChat().canSee().canHear();
+const fullStackModels = models.canChat().canCallFunctions().canOutputJSON();
+
+// Audio capabilities
+const speechModels = models.canHear().canSpeak();
+
+// Text processing
+const textProcessors = models.canRead().canWrite();
+
+// Available fluent API methods:
+// - canChat() - models with chat capability
+// - canReason() - models with reasoning capability
+// - canRead() - models that can process text input
+// - canWrite() - models that can output text
+// - canSee() - models that understand images
+// - canGenerateImages() - models that can create images
+// - canHear() - models that understand audio
+// - canSpeak() - models that can generate speech
+// - canOutputJSON() - models that provide structured JSON output
+// - canCallFunctions() - models with function calling capability
+// - canGenerateEmbeddings() - models that output vector embeddings
 
 // Find models by provider
 const openaiModels = models.fromProvider('openai');
@@ -27,7 +52,7 @@ const metaModels = models.fromCreator('meta');
 const largeContextModels = models.withMinContext(32768);
 
 // Find specific model
-const model = models.id('gpt-4');
+const model = models.id('gpt-4o');
 console.log(model?.context.total); // Context window size
 console.log(model?.providers); // ['openai']
 ```
@@ -36,7 +61,7 @@ console.log(model?.providers); // ['openai']
 
 - Comprehensive database of AI models from major providers (OpenAI, Anthropic, Mistral, etc.)
 - Normalized data structure for easy comparison
-- Model capabilities (chat, img-in, img-out, function-out, etc.)
+- Intuitive fluent API for filtering models by capabilities
 - Context window information
 - Creator and provider associations
 - TypeScript support with full type safety
@@ -64,22 +89,6 @@ interface Model {
 }
 ```
 
-### Capabilities
-```typescript
-type Capability =
-  | "chat"         // shortcut for "text-in" and "text-out"
-  | "reason"       // when the model spends some tokens on reasoning
-  | "text-in"      // process text input
-  | "text-out"     // output text
-  | "img-in"       // understand images
-  | "img-out"      // generate images
-  | "sound-in"     // process audio input
-  | "sound-out"    // generate audio/speech
-  | "json-out"     // structured JSON output
-  | "function-out" // function calling
-  | "vectors-out"; // output vector embeddings
-```
-
 For more detailed information, see:
 - [Model Capabilities](/docs/model-capabilities.md)
 - [Model Structure](/docs/model-structure.md)

package/dist/index.d.mts

@@ -1,32 +1,28 @@
-interface TokenBasedPricePerMillionTokens {
-    /** Price per million input tokens */
-    input: number;
-    /** Price per million output tokens */
-    output: number;
-    /** Price type */
-    type: 'token';
-}
-interface ImagePrice {
-    /** Price per image */
-    price: number;
-    /** Image size */
-    size: string;
-    /** Price type */
-    type: 'image';
-    /** Price unit */
-    unit: 'per_image';
-}
-
 /**
  * Defines all possible model capabilities
  */
-type Capability = "chat" | "reason" | "text-in" | "text-out" | "img-in" | "img-out" | "sound-in" | "sound-out" | "json-out" | "function-out" | "vectors-out";
+type Capability = "chat" | "reason" | "txt-in" | "txt-out" | "img-in" | "img-out" | "audio-in" | "audio-out" | "json-out" | "fn-out" | "vec-out";
 
 declare class ModelCollection extends Array<Model> {
     /** Create a new ModelCollection from an array of models */
     constructor(models?: Model[]);
     /** Filter models by one or more capabilities (all must be present) */
     can(...capabilities: Capability[]): ModelCollection;
+    /**
+     * Fluent capability filters for better readability
+     * Each method filters models by a specific capability
+     */
+    canChat(): ModelCollection;
+    canReason(): ModelCollection;
+    canRead(): ModelCollection;
+    canWrite(): ModelCollection;
+    canSee(): ModelCollection;
+    canGenerateImages(): ModelCollection;
+    canHear(): ModelCollection;
+    canSpeak(): ModelCollection;
+    canOutputJSON(): ModelCollection;
+    canCallFunctions(): ModelCollection;
+    canGenerateEmbeddings(): ModelCollection;
     /** Filter models by one or more languages (all must be supported) */
     know(...languages: string[]): ModelCollection;
     /** Override array filter to return ModelCollection */
@@ -43,6 +39,7 @@ declare class ModelCollection extends Array<Model> {
     withMinContext(tokens: number): ModelCollection;
     /** Get all providers from all models in the collection deduplicated */
     getProviders(): string[];
+    getCreators(): string[];
 }
 interface BaseContext {
     /** The type discriminator */
@@ -142,6 +139,25 @@ interface Model {
     overrides?: Partial<Omit<Model, 'id' | 'extends' | 'overrides'>>;
 }
 
+interface TokenBasedPricePerMillionTokens {
+    /** Price per million input tokens */
+    input: number;
+    /** Price per million output tokens */
+    output: number;
+    /** Price type */
+    type: 'token';
+}
+interface ImagePrice {
+    /** Price per image */
+    price: number;
+    /** Image size */
+    size: string;
+    /** Price type */
+    type: 'image';
+    /** Price unit */
+    unit: 'per_image';
+}
+
 interface Provider {
     /** Provider identifier */
     id: string;

package/dist/index.d.ts

@@ -1,32 +1,28 @@
-interface TokenBasedPricePerMillionTokens {
-    /** Price per million input tokens */
-    input: number;
-    /** Price per million output tokens */
-    output: number;
-    /** Price type */
-    type: 'token';
-}
-interface ImagePrice {
-    /** Price per image */
-    price: number;
-    /** Image size */
-    size: string;
-    /** Price type */
-    type: 'image';
-    /** Price unit */
-    unit: 'per_image';
-}
-
 /**
  * Defines all possible model capabilities
  */
-type Capability = "chat" | "reason" | "text-in" | "text-out" | "img-in" | "img-out" | "sound-in" | "sound-out" | "json-out" | "function-out" | "vectors-out";
+type Capability = "chat" | "reason" | "txt-in" | "txt-out" | "img-in" | "img-out" | "audio-in" | "audio-out" | "json-out" | "fn-out" | "vec-out";
 
 declare class ModelCollection extends Array<Model> {
     /** Create a new ModelCollection from an array of models */
     constructor(models?: Model[]);
     /** Filter models by one or more capabilities (all must be present) */
     can(...capabilities: Capability[]): ModelCollection;
+    /**
+     * Fluent capability filters for better readability
+     * Each method filters models by a specific capability
+     */
+    canChat(): ModelCollection;
+    canReason(): ModelCollection;
+    canRead(): ModelCollection;
+    canWrite(): ModelCollection;
+    canSee(): ModelCollection;
+    canGenerateImages(): ModelCollection;
+    canHear(): ModelCollection;
+    canSpeak(): ModelCollection;
+    canOutputJSON(): ModelCollection;
+    canCallFunctions(): ModelCollection;
+    canGenerateEmbeddings(): ModelCollection;
     /** Filter models by one or more languages (all must be supported) */
     know(...languages: string[]): ModelCollection;
     /** Override array filter to return ModelCollection */
@@ -43,6 +39,7 @@ declare class ModelCollection extends Array<Model> {
     withMinContext(tokens: number): ModelCollection;
     /** Get all providers from all models in the collection deduplicated */
     getProviders(): string[];
+    getCreators(): string[];
 }
 interface BaseContext {
     /** The type discriminator */
@@ -142,6 +139,25 @@ interface Model {
     overrides?: Partial<Omit<Model, 'id' | 'extends' | 'overrides'>>;
 }
 
+interface TokenBasedPricePerMillionTokens {
+    /** Price per million input tokens */
+    input: number;
+    /** Price per million output tokens */
+    output: number;
+    /** Price type */
+    type: 'token';
+}
+interface ImagePrice {
+    /** Price per image */
+    price: number;
+    /** Image size */
+    size: string;
+    /** Price type */
+    type: 'image';
+    /** Price unit */
+    unit: 'per_image';
+}
+
 interface Provider {
     /** Provider identifier */
     id: string;