aimodels 0.1.1 → 0.2.0

package/README.md

@@ -17,61 +17,76 @@ import { models } from 'aimodels';
 console.log(models.all);
 
 // Get list of all providers
-console.log(models.providers); // ['openai', 'anthropic', 'meta', ...]
+console.log(models.providers); // ['openai', 'anthropic', 'mistral', ...]
+
+// Get list of model creators
+console.log(models.creators); // ['meta', 'mistral', ...]
 
 // Get models from a specific provider
-const openAiModels = models.from('openai');
+const openAiModels = models.fromProvider('openai');
+
+// Get models from a specific creator
+const metaModels = models.fromCreator('meta');
 
 // Find a specific model
-const model = models.find('deepseek-r1');
-console.log(model.contextWindow);
-console.log(model.providers); 
-console.log(model.pricing.input);
+const model = models.find('gpt-4');
+console.log(model?.context.total); // Context window size
+console.log(model?.providers); // ['openai']
+
+// Get model pricing for a specific provider
+const price = models.getPrice('gpt-4', 'openai');
+console.log(price); // { type: 'token', input: 0.03, output: 0.06 }
 
-// Filter models by capability
-const chatModels = models.withCapability('chat');
+// Filter models by capabilities
+const chatModels = models.can('chat');
+const multimodalModels = models.can('chat', 'img-in');
 
 // Filter by context window
 const largeContextModels = models.withMinContext(32768);
-
-// Filter by maximum price
-const affordableModels = models.withMaxPrice(0.01); // Max $0.01 per 1K tokens
-```
-
-## Data Structure
-
-Each model entry contains the following information:
-
-```typescript
-interface ModelSpec {
-  id: string;                 // Unique identifier for the model
-  name: string;              // Display name
-  provider: string;          // Provider (e.g., 'openai', 'anthropic', etc.)
-  contextWindow: number;     // Maximum context window size in tokens
-  capabilities: string[];    // Array of capabilities (e.g., ['chat', 'completion'])
-  pricing: {
-    input: number;          // Cost per 1K input tokens in USD
-    output: number;         // Cost per 1K output tokens in USD
-  };
-  released: string;         // Release date
-  license?: string;         // License information for open-source models
-  trainingData?: string[];  // Known training data sources
-  parameters?: number;      // Number of parameters (if known)
-}
 ```
 
 ## Features
 
-- Comprehensive database of AI models
+- Comprehensive database of AI models from major providers (OpenAI, Anthropic, Mistral, etc.)
 - Normalized data structure for easy comparison
-- Regular updates with new models
-- TypeScript support
+- Model capabilities (chat, img-in, img-out, function-out, etc.)
+- Context window information
+- Pricing information per provider
+- Creator and provider associations
+- TypeScript support with full type safety
 - Zero dependencies
 - Universal JavaScript support (Node.js, browsers, Deno)
+- Regular updates with new models
+
+
+## Types
 
-## Contributing
+```typescript
+interface Model {
+  id: string;           // Unique model identifier
+  name: string;         // Display name
+  can: string[];        // Capabilities (chat, img-in, img-out, etc.)
+  providers: string[];  // Available providers
+  context: {
+    total: number;      // Total context window size
+  };
+  license: string;      // License or creator
+}
 
-Contributions are welcome! Please check our contributing guidelines for details on how to submit new models or updates.
+type ModelPrice = 
+  | { type: 'token'; input: number; output: number }      // Price per 1K tokens
+  | { type: 'image'; price: number; size: string }        // Price per image
+  | { type: 'character'; price: number }                  // Price per character
+  | { type: 'minute'; price: number };                    // Price per minute
+
+interface Provider {
+  id: string;           // Provider identifier
+  name: string;         // Display name
+  websiteUrl: string;   // Provider's website
+  apiUrl: string;       // API documentation URL
+  models: Record<string, ModelPrice>;  // Model pricing
+}
+```
 
 ## License
 

package/dist/index.d.mts

@@ -1,36 +1,89 @@
-interface ModelPricing {
+interface ModelPrice {
+    /** Price per million input tokens */
     input: number;
+    /** Price per million output tokens */
     output: number;
+    /** Price type */
+    type: 'token';
 }
-interface ModelSpec {
+
+/**
+ * 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";
+
+declare class ModelCollection extends Array<Model> {
+    constructor(models: Model[]);
+    can(...capabilities: Capability[]): ModelCollection;
+    know(...languages: string[]): ModelCollection;
+    filter(predicate: (value: Model, index: number, array: Model[]) => boolean): ModelCollection;
+    slice(start?: number, end?: number): ModelCollection;
+}
+interface ModelContext {
+    /** Maximum total tokens (input + output) */
+    total: number;
+    /** Maximum output tokens */
+    maxOutput: number;
+}
+interface Model {
+    /** Unique identifier */
     id: string;
+    /** Display name */
     name: string;
-    provider: string;
-    contextWindow: number;
-    capabilities: string[];
-    pricing: ModelPricing;
-    released: string;
-    license?: string;
-    trainingData?: string[];
-    parameters?: number;
+    /** License type (e.g., "proprietary", "apache-2.0", "llama-2-community") */
+    license: string;
+    /** List of providers that can serve this model */
+    providers: string[];
+    /** Model capabilities */
+    can: Capability[];
+    /** Languages the model knows */
+    languages?: string[];
+    /** Context window information */
+    context: ModelContext;
 }
-interface ModelsCollection {
+interface ModelsAPI {
     /** All available models */
-    all: ModelSpec[];
-    /** List of all unique providers */
+    all: ModelCollection;
+    /** List of all creators */
+    creators: string[];
+    /** List of all providers */
     providers: string[];
+    /** Get models from a specific creator */
+    fromCreator(creator: string): ModelCollection;
     /** Get models from a specific provider */
-    from(provider: string): ModelSpec[];
+    fromProvider(provider: string): ModelCollection;
     /** Find a specific model by ID */
-    find(id: string): ModelSpec | undefined;
-    /** Filter models by capability */
-    withCapability(capability: string): ModelSpec[];
+    find(id: string): Model | undefined;
+    /** Filter models by one or more capabilities (all must be present) */
+    can(...capabilities: string[]): ModelCollection;
     /** Filter models by minimum context window */
-    withMinContext(tokens: number): ModelSpec[];
-    /** Filter models by maximum price (per 1K tokens) */
-    withMaxPrice(price: number): ModelSpec[];
+    withMinContext(tokens: number): ModelCollection;
+    /** Get pricing for a model from a specific provider */
+    getPrice(modelId: string, provider: string): ModelPrice | undefined;
 }
 
-declare const models: ModelsCollection;
+var creators = {
+	openai: {
+		name: "OpenAI",
+		website: "https://openai.com"
+	},
+	anthropic: {
+		name: "Anthropic",
+		website: "https://anthropic.com"
+	},
+	meta: {
+		name: "Meta",
+		website: "https://ai.meta.com"
+	},
+	mistral: {
+		name: "Mistral AI",
+		website: "https://mistral.ai"
+	}
+};
+var creators$1 = {
+	creators: creators
+};
+
+declare const models: ModelsAPI;
 
-export { type ModelPricing, type ModelSpec, type ModelsCollection, models };
+export { creators$1 as creators, models };

package/dist/index.d.ts

@@ -1,36 +1,89 @@
-interface ModelPricing {
+interface ModelPrice {
+    /** Price per million input tokens */
     input: number;
+    /** Price per million output tokens */
     output: number;
+    /** Price type */
+    type: 'token';
 }
-interface ModelSpec {
+
+/**
+ * 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";
+
+declare class ModelCollection extends Array<Model> {
+    constructor(models: Model[]);
+    can(...capabilities: Capability[]): ModelCollection;
+    know(...languages: string[]): ModelCollection;
+    filter(predicate: (value: Model, index: number, array: Model[]) => boolean): ModelCollection;
+    slice(start?: number, end?: number): ModelCollection;
+}
+interface ModelContext {
+    /** Maximum total tokens (input + output) */
+    total: number;
+    /** Maximum output tokens */
+    maxOutput: number;
+}
+interface Model {
+    /** Unique identifier */
     id: string;
+    /** Display name */
     name: string;
-    provider: string;
-    contextWindow: number;
-    capabilities: string[];
-    pricing: ModelPricing;
-    released: string;
-    license?: string;
-    trainingData?: string[];
-    parameters?: number;
+    /** License type (e.g., "proprietary", "apache-2.0", "llama-2-community") */
+    license: string;
+    /** List of providers that can serve this model */
+    providers: string[];
+    /** Model capabilities */
+    can: Capability[];
+    /** Languages the model knows */
+    languages?: string[];
+    /** Context window information */
+    context: ModelContext;
 }
-interface ModelsCollection {
+interface ModelsAPI {
     /** All available models */
-    all: ModelSpec[];
-    /** List of all unique providers */
+    all: ModelCollection;
+    /** List of all creators */
+    creators: string[];
+    /** List of all providers */
     providers: string[];
+    /** Get models from a specific creator */
+    fromCreator(creator: string): ModelCollection;
     /** Get models from a specific provider */
-    from(provider: string): ModelSpec[];
+    fromProvider(provider: string): ModelCollection;
     /** Find a specific model by ID */
-    find(id: string): ModelSpec | undefined;
-    /** Filter models by capability */
-    withCapability(capability: string): ModelSpec[];
+    find(id: string): Model | undefined;
+    /** Filter models by one or more capabilities (all must be present) */
+    can(...capabilities: string[]): ModelCollection;
     /** Filter models by minimum context window */
-    withMinContext(tokens: number): ModelSpec[];
-    /** Filter models by maximum price (per 1K tokens) */
-    withMaxPrice(price: number): ModelSpec[];
+    withMinContext(tokens: number): ModelCollection;
+    /** Get pricing for a model from a specific provider */
+    getPrice(modelId: string, provider: string): ModelPrice | undefined;
 }
 
-declare const models: ModelsCollection;
+var creators = {
+	openai: {
+		name: "OpenAI",
+		website: "https://openai.com"
+	},
+	anthropic: {
+		name: "Anthropic",
+		website: "https://anthropic.com"
+	},
+	meta: {
+		name: "Meta",
+		website: "https://ai.meta.com"
+	},
+	mistral: {
+		name: "Mistral AI",
+		website: "https://mistral.ai"
+	}
+};
+var creators$1 = {
+	creators: creators
+};
+
+declare const models: ModelsAPI;
 
-export { type ModelPricing, type ModelSpec, type ModelsCollection, models };
+export { creators$1 as creators, models };