@ax-llm/ax 14.0.26 → 14.0.28

package/index.d.cts

@@ -3381,8 +3381,20 @@ type AxAICohereEmbedResponse = {
     embeddings: number[][];
 };
 
+/**
+ * Creates the default configuration for Cohere AI service
+ * @returns A deep clone of the default Cohere configuration with CommandRPlus model and EmbedEnglishV30 embed model
+ */
 declare const axAICohereDefaultConfig: () => AxAICohereConfig;
+/**
+ * Creates a creative configuration for Cohere AI service with more flexible parameters
+ * @returns A deep clone of the creative Cohere configuration with CommandR model and EmbedEnglishV30 embed model
+ */
 declare const axAICohereCreativeConfig: () => AxAICohereConfig;
+/**
+ * Configuration arguments for initializing the Cohere AI service
+ * @template TModelKey - The type of model keys supported
+ */
 interface AxAICohereArgs<TModelKey> {
     name: 'cohere';
     apiKey: string;
@@ -3390,7 +3402,15 @@ interface AxAICohereArgs<TModelKey> {
     options?: Readonly<AxAIServiceOptions>;
     models?: AxAIInputModelList<AxAICohereModel, AxAICohereEmbedModel, TModelKey>;
 }
+/**
+ * Main Cohere AI service class that extends the base AI implementation
+ * @template TModelKey - The type of model keys supported
+ */
 declare class AxAICohere<TModelKey> extends AxBaseAI<AxAICohereModel, AxAICohereEmbedModel, AxAICohereChatRequest, AxAICohereEmbedRequest, AxAICohereChatResponse, AxAICohereChatResponseDelta, AxAICohereEmbedResponse, TModelKey> {
+    /**
+     * Creates a new instance of AxAICohere
+     * @param args - Configuration arguments including API key, config, options, and models
+     */
     constructor({ apiKey, config, options, models, }: Readonly<Omit<AxAICohereArgs<TModelKey>, 'name'>>);
 }
 
@@ -3405,11 +3425,41 @@ declare enum AxAIDeepSeekModel {
     DeepSeekReasoner = "deepseek-reasoner"
 }
 
+/**
+ * Configuration type for DeepSeek AI models
+ */
 type DeepSeekConfig = AxAIOpenAIConfig<AxAIDeepSeekModel, undefined>;
+/**
+ * Creates the default configuration for DeepSeek AI with the chat model
+ * @returns Default DeepSeek configuration with chat model settings
+ */
 declare const axAIDeepSeekDefaultConfig: () => DeepSeekConfig;
+/**
+ * Creates a configuration optimized for code generation tasks using DeepSeek Coder
+ * @returns DeepSeek configuration with creative settings for coding tasks
+ */
 declare const axAIDeepSeekCodeConfig: () => DeepSeekConfig;
+/**
+ * Arguments type for initializing DeepSeek AI instances
+ * @template TModelKey - The model key type for type safety
+ */
 type AxAIDeepSeekArgs<TModelKey> = AxAIOpenAIArgs<'deepseek', AxAIDeepSeekModel, undefined, TModelKey>;
+/**
+ * DeepSeek AI client implementation extending OpenAI base functionality
+ * Provides access to DeepSeek's language models through OpenAI-compatible API
+ * @template TModelKey - The model key type for type safety
+ */
 declare class AxAIDeepSeek<TModelKey> extends AxAIOpenAIBase<AxAIDeepSeekModel, undefined, TModelKey> {
+    /**
+     * Creates a new DeepSeek AI client instance
+     * @param args - Configuration arguments for the DeepSeek client
+     * @param args.apiKey - DeepSeek API key for authentication
+     * @param args.config - Optional configuration overrides
+     * @param args.options - Optional client options
+     * @param args.models - Optional model definitions
+     * @param args.modelInfo - Optional additional model information
+     * @throws {Error} When API key is not provided or empty
+     */
     constructor({ apiKey, config, options, models, modelInfo, }: Readonly<Omit<AxAIDeepSeekArgs<TModelKey>, 'name'>>);
 }
 
@@ -3425,7 +3475,10 @@ declare enum AxAIGoogleGeminiModel {
     Gemini15Flash = "gemini-1.5-flash",
     Gemini15Flash002 = "gemini-1.5-flash-002",
     Gemini15Flash8B = "gemini-1.5-flash-8b",
-    Gemini15Pro = "gemini-1.5-pro"
+    Gemini15Pro = "gemini-1.5-pro",
+    GeminiFlashLatest = "gemini-flash-latest",
+    GeminiFlashLiteLatest = "gemini-flash-lite-latest",
+    GeminiProLatest = "gemini-pro-latest"
 }
 declare enum AxAIGoogleGeminiEmbedModel {
     GeminiEmbedding = "gemini-embedding-exp",
@@ -3968,18 +4021,44 @@ declare class AxMultiServiceRouter<TServices extends readonly (AxAIService | AxA
     }): void;
 }
 
+/**
+ * Configuration type for Ollama AI service
+ */
 type AxAIOllamaAIConfig = AxAIOpenAIConfig<string, string>;
+/**
+ * Creates default configuration for Ollama AI service
+ * @returns Default configuration object with nous-hermes2 model and all-minilm embed model
+ */
 declare const axAIOllamaDefaultConfig: () => AxAIOllamaAIConfig;
+/**
+ * Creates default creative configuration for Ollama AI service
+ * @returns Creative configuration object with nous-hermes2 model and all-minilm embed model
+ */
 declare const axAIOllamaDefaultCreativeConfig: () => AxAIOllamaAIConfig;
+/**
+ * Arguments type for initializing Ollama AI service
+ * @template TModelKey - Type for model key
+ */
 type AxAIOllamaArgs<TModelKey> = AxAIOpenAIArgs<'ollama', string, string, TModelKey> & {
     model?: string;
     embedModel?: string;
     url?: string;
 };
 /**
- * OllamaAI: AI Service
+ * Ollama AI service implementation that extends OpenAI base functionality
+ * Provides access to locally hosted Ollama models with OpenAI-compatible API
+ * @template TModelKey - Type for model key
  */
 declare class AxAIOllama<TModelKey> extends AxAIOpenAIBase<string, string, TModelKey> {
+    /**
+     * Creates a new Ollama AI service instance
+     * @param args - Configuration arguments for the Ollama service
+     * @param args.apiKey - API key for authentication (defaults to 'not-set')
+     * @param args.url - Base URL for the Ollama API (defaults to 'http://localhost:11434/v1')
+     * @param args.config - Additional configuration options
+     * @param args.options - Service options
+     * @param args.models - Available models configuration
+     */
     constructor({ apiKey, url, config, options, models, }: Readonly<Omit<AxAIOllamaArgs<TModelKey>, 'name'>>);
 }
 
@@ -5676,6 +5755,7 @@ declare class AxGEPA extends AxBaseOptimizer {
     private updateSamplerShuffled;
     private nextMinibatchIndices;
     private rand;
+    private generateOptimizationReport;
     private mergeInstructions;
 }
 
@@ -5834,6 +5914,7 @@ declare class AxMiPRO extends AxBaseOptimizer {
      * parameter optimization rather than full MiPRO functionality.
      */
     private compilePython;
+    private generateOptimizationReport;
     /**
      * Simplified evaluation method for Python optimization
      */

package/index.d.ts

@@ -3381,8 +3381,20 @@ type AxAICohereEmbedResponse = {
     embeddings: number[][];
 };
 
+/**
+ * Creates the default configuration for Cohere AI service
+ * @returns A deep clone of the default Cohere configuration with CommandRPlus model and EmbedEnglishV30 embed model
+ */
 declare const axAICohereDefaultConfig: () => AxAICohereConfig;
+/**
+ * Creates a creative configuration for Cohere AI service with more flexible parameters
+ * @returns A deep clone of the creative Cohere configuration with CommandR model and EmbedEnglishV30 embed model
+ */
 declare const axAICohereCreativeConfig: () => AxAICohereConfig;
+/**
+ * Configuration arguments for initializing the Cohere AI service
+ * @template TModelKey - The type of model keys supported
+ */
 interface AxAICohereArgs<TModelKey> {
     name: 'cohere';
     apiKey: string;
@@ -3390,7 +3402,15 @@ interface AxAICohereArgs<TModelKey> {
     options?: Readonly<AxAIServiceOptions>;
     models?: AxAIInputModelList<AxAICohereModel, AxAICohereEmbedModel, TModelKey>;
 }
+/**
+ * Main Cohere AI service class that extends the base AI implementation
+ * @template TModelKey - The type of model keys supported
+ */
 declare class AxAICohere<TModelKey> extends AxBaseAI<AxAICohereModel, AxAICohereEmbedModel, AxAICohereChatRequest, AxAICohereEmbedRequest, AxAICohereChatResponse, AxAICohereChatResponseDelta, AxAICohereEmbedResponse, TModelKey> {
+    /**
+     * Creates a new instance of AxAICohere
+     * @param args - Configuration arguments including API key, config, options, and models
+     */
     constructor({ apiKey, config, options, models, }: Readonly<Omit<AxAICohereArgs<TModelKey>, 'name'>>);
 }
 
@@ -3405,11 +3425,41 @@ declare enum AxAIDeepSeekModel {
     DeepSeekReasoner = "deepseek-reasoner"
 }
 
+/**
+ * Configuration type for DeepSeek AI models
+ */
 type DeepSeekConfig = AxAIOpenAIConfig<AxAIDeepSeekModel, undefined>;
+/**
+ * Creates the default configuration for DeepSeek AI with the chat model
+ * @returns Default DeepSeek configuration with chat model settings
+ */
 declare const axAIDeepSeekDefaultConfig: () => DeepSeekConfig;
+/**
+ * Creates a configuration optimized for code generation tasks using DeepSeek Coder
+ * @returns DeepSeek configuration with creative settings for coding tasks
+ */
 declare const axAIDeepSeekCodeConfig: () => DeepSeekConfig;
+/**
+ * Arguments type for initializing DeepSeek AI instances
+ * @template TModelKey - The model key type for type safety
+ */
 type AxAIDeepSeekArgs<TModelKey> = AxAIOpenAIArgs<'deepseek', AxAIDeepSeekModel, undefined, TModelKey>;
+/**
+ * DeepSeek AI client implementation extending OpenAI base functionality
+ * Provides access to DeepSeek's language models through OpenAI-compatible API
+ * @template TModelKey - The model key type for type safety
+ */
 declare class AxAIDeepSeek<TModelKey> extends AxAIOpenAIBase<AxAIDeepSeekModel, undefined, TModelKey> {
+    /**
+     * Creates a new DeepSeek AI client instance
+     * @param args - Configuration arguments for the DeepSeek client
+     * @param args.apiKey - DeepSeek API key for authentication
+     * @param args.config - Optional configuration overrides
+     * @param args.options - Optional client options
+     * @param args.models - Optional model definitions
+     * @param args.modelInfo - Optional additional model information
+     * @throws {Error} When API key is not provided or empty
+     */
     constructor({ apiKey, config, options, models, modelInfo, }: Readonly<Omit<AxAIDeepSeekArgs<TModelKey>, 'name'>>);
 }
 
@@ -3425,7 +3475,10 @@ declare enum AxAIGoogleGeminiModel {
     Gemini15Flash = "gemini-1.5-flash",
     Gemini15Flash002 = "gemini-1.5-flash-002",
     Gemini15Flash8B = "gemini-1.5-flash-8b",
-    Gemini15Pro = "gemini-1.5-pro"
+    Gemini15Pro = "gemini-1.5-pro",
+    GeminiFlashLatest = "gemini-flash-latest",
+    GeminiFlashLiteLatest = "gemini-flash-lite-latest",
+    GeminiProLatest = "gemini-pro-latest"
 }
 declare enum AxAIGoogleGeminiEmbedModel {
     GeminiEmbedding = "gemini-embedding-exp",
@@ -3968,18 +4021,44 @@ declare class AxMultiServiceRouter<TServices extends readonly (AxAIService | AxA
     }): void;
 }
 
+/**
+ * Configuration type for Ollama AI service
+ */
 type AxAIOllamaAIConfig = AxAIOpenAIConfig<string, string>;
+/**
+ * Creates default configuration for Ollama AI service
+ * @returns Default configuration object with nous-hermes2 model and all-minilm embed model
+ */
 declare const axAIOllamaDefaultConfig: () => AxAIOllamaAIConfig;
+/**
+ * Creates default creative configuration for Ollama AI service
+ * @returns Creative configuration object with nous-hermes2 model and all-minilm embed model
+ */
 declare const axAIOllamaDefaultCreativeConfig: () => AxAIOllamaAIConfig;
+/**
+ * Arguments type for initializing Ollama AI service
+ * @template TModelKey - Type for model key
+ */
 type AxAIOllamaArgs<TModelKey> = AxAIOpenAIArgs<'ollama', string, string, TModelKey> & {
     model?: string;
     embedModel?: string;
     url?: string;
 };
 /**
- * OllamaAI: AI Service
+ * Ollama AI service implementation that extends OpenAI base functionality
+ * Provides access to locally hosted Ollama models with OpenAI-compatible API
+ * @template TModelKey - Type for model key
  */
 declare class AxAIOllama<TModelKey> extends AxAIOpenAIBase<string, string, TModelKey> {
+    /**
+     * Creates a new Ollama AI service instance
+     * @param args - Configuration arguments for the Ollama service
+     * @param args.apiKey - API key for authentication (defaults to 'not-set')
+     * @param args.url - Base URL for the Ollama API (defaults to 'http://localhost:11434/v1')
+     * @param args.config - Additional configuration options
+     * @param args.options - Service options
+     * @param args.models - Available models configuration
+     */
     constructor({ apiKey, url, config, options, models, }: Readonly<Omit<AxAIOllamaArgs<TModelKey>, 'name'>>);
 }
 
@@ -5676,6 +5755,7 @@ declare class AxGEPA extends AxBaseOptimizer {
     private updateSamplerShuffled;
     private nextMinibatchIndices;
     private rand;
+    private generateOptimizationReport;
     private mergeInstructions;
 }
 
@@ -5834,6 +5914,7 @@ declare class AxMiPRO extends AxBaseOptimizer {
      * parameter optimization rather than full MiPRO functionality.
      */
     private compilePython;
+    private generateOptimizationReport;
     /**
      * Simplified evaluation method for Python optimization
      */