llama-stack-client 0.2.16 → 0.2.17-rc1

package/src/resources/post-training/post-training.ts

@@ -37,32 +37,74 @@ export class PostTraining extends APIResource {
   }
 }
 
+/**
+ * Configuration for Low-Rank Adaptation (LoRA) fine-tuning.
+ */
 export type AlgorithmConfig = AlgorithmConfig.LoraFinetuningConfig | AlgorithmConfig.QatFinetuningConfig;
 
 export namespace AlgorithmConfig {
+  /**
+   * Configuration for Low-Rank Adaptation (LoRA) fine-tuning.
+   */
   export interface LoraFinetuningConfig {
+    /**
+     * LoRA scaling parameter that controls adaptation strength
+     */
     alpha: number;
 
+    /**
+     * Whether to apply LoRA to MLP layers
+     */
     apply_lora_to_mlp: boolean;
 
+    /**
+     * Whether to apply LoRA to output projection layers
+     */
     apply_lora_to_output: boolean;
 
+    /**
+     * List of attention module names to apply LoRA to
+     */
     lora_attn_modules: Array<string>;
 
+    /**
+     * Rank of the LoRA adaptation (lower rank = fewer parameters)
+     */
     rank: number;
 
+    /**
+     * Algorithm type identifier, always "LoRA"
+     */
     type: 'LoRA';
 
+    /**
+     * (Optional) Whether to quantize the base model weights
+     */
     quantize_base?: boolean;
 
+    /**
+     * (Optional) Whether to use DoRA (Weight-Decomposed Low-Rank Adaptation)
+     */
     use_dora?: boolean;
   }
 
+  /**
+   * Configuration for Quantization-Aware Training (QAT) fine-tuning.
+   */
   export interface QatFinetuningConfig {
+    /**
+     * Size of groups for grouped quantization
+     */
     group_size: number;
 
+    /**
+     * Name of the quantization algorithm to use
+     */
     quantizer_name: string;
 
+    /**
+     * Algorithm type identifier, always "QAT"
+     */
     type: 'QAT';
   }
 }
@@ -118,8 +160,14 @@ export namespace PostTrainingPreferenceOptimizeParams {
    * The algorithm configuration.
    */
   export interface AlgorithmConfig {
+    /**
+     * Temperature parameter for the DPO loss
+     */
     beta: number;
 
+    /**
+     * The type of loss function to use for DPO
+     */
     loss_type: 'sigmoid' | 'hinge' | 'ipo' | 'kto_pair';
   }
 
@@ -127,57 +175,136 @@ export namespace PostTrainingPreferenceOptimizeParams {
    * The training configuration.
    */
   export interface TrainingConfig {
+    /**
+     * Number of steps to accumulate gradients before updating
+     */
     gradient_accumulation_steps: number;
 
+    /**
+     * Maximum number of steps to run per epoch
+     */
     max_steps_per_epoch: number;
 
+    /**
+     * Number of training epochs to run
+     */
     n_epochs: number;
 
+    /**
+     * (Optional) Configuration for data loading and formatting
+     */
     data_config?: TrainingConfig.DataConfig;
 
+    /**
+     * (Optional) Data type for model parameters (bf16, fp16, fp32)
+     */
     dtype?: string;
 
+    /**
+     * (Optional) Configuration for memory and compute optimizations
+     */
     efficiency_config?: TrainingConfig.EfficiencyConfig;
 
+    /**
+     * (Optional) Maximum number of validation steps per epoch
+     */
     max_validation_steps?: number;
 
+    /**
+     * (Optional) Configuration for the optimization algorithm
+     */
     optimizer_config?: TrainingConfig.OptimizerConfig;
   }
 
   export namespace TrainingConfig {
+    /**
+     * (Optional) Configuration for data loading and formatting
+     */
     export interface DataConfig {
+      /**
+       * Number of samples per training batch
+       */
       batch_size: number;
 
+      /**
+       * Format of the dataset (instruct or dialog)
+       */
       data_format: 'instruct' | 'dialog';
 
+      /**
+       * Unique identifier for the training dataset
+       */
       dataset_id: string;
 
+      /**
+       * Whether to shuffle the dataset during training
+       */
       shuffle: boolean;
 
+      /**
+       * (Optional) Whether to pack multiple samples into a single sequence for
+       * efficiency
+       */
       packed?: boolean;
 
+      /**
+       * (Optional) Whether to compute loss on input tokens as well as output tokens
+       */
       train_on_input?: boolean;
 
+      /**
+       * (Optional) Unique identifier for the validation dataset
+       */
       validation_dataset_id?: string;
     }
 
+    /**
+     * (Optional) Configuration for memory and compute optimizations
+     */
     export interface EfficiencyConfig {
+      /**
+       * (Optional) Whether to use activation checkpointing to reduce memory usage
+       */
       enable_activation_checkpointing?: boolean;
 
+      /**
+       * (Optional) Whether to offload activations to CPU to save GPU memory
+       */
       enable_activation_offloading?: boolean;
 
+      /**
+       * (Optional) Whether to offload FSDP parameters to CPU
+       */
       fsdp_cpu_offload?: boolean;
 
+      /**
+       * (Optional) Whether to use memory-efficient FSDP wrapping
+       */
       memory_efficient_fsdp_wrap?: boolean;
     }
 
+    /**
+     * (Optional) Configuration for the optimization algorithm
+     */
     export interface OptimizerConfig {
+      /**
+       * Learning rate for the optimizer
+       */
       lr: number;
 
+      /**
+       * Number of steps for learning rate warmup
+       */
       num_warmup_steps: number;
 
+      /**
+       * Type of optimizer to use (adam, adamw, or sgd)
+       */
       optimizer_type: 'adam' | 'adamw' | 'sgd';
 
+      /**
+       * Weight decay coefficient for regularization
+       */
       weight_decay: number;
     }
   }
@@ -225,57 +352,136 @@ export namespace PostTrainingSupervisedFineTuneParams {
    * The training configuration.
    */
   export interface TrainingConfig {
+    /**
+     * Number of steps to accumulate gradients before updating
+     */
     gradient_accumulation_steps: number;
 
+    /**
+     * Maximum number of steps to run per epoch
+     */
     max_steps_per_epoch: number;
 
+    /**
+     * Number of training epochs to run
+     */
     n_epochs: number;
 
+    /**
+     * (Optional) Configuration for data loading and formatting
+     */
     data_config?: TrainingConfig.DataConfig;
 
+    /**
+     * (Optional) Data type for model parameters (bf16, fp16, fp32)
+     */
     dtype?: string;
 
+    /**
+     * (Optional) Configuration for memory and compute optimizations
+     */
     efficiency_config?: TrainingConfig.EfficiencyConfig;
 
+    /**
+     * (Optional) Maximum number of validation steps per epoch
+     */
     max_validation_steps?: number;
 
+    /**
+     * (Optional) Configuration for the optimization algorithm
+     */
     optimizer_config?: TrainingConfig.OptimizerConfig;
   }
 
   export namespace TrainingConfig {
+    /**
+     * (Optional) Configuration for data loading and formatting
+     */
     export interface DataConfig {
+      /**
+       * Number of samples per training batch
+       */
       batch_size: number;
 
+      /**
+       * Format of the dataset (instruct or dialog)
+       */
       data_format: 'instruct' | 'dialog';
 
+      /**
+       * Unique identifier for the training dataset
+       */
       dataset_id: string;
 
+      /**
+       * Whether to shuffle the dataset during training
+       */
       shuffle: boolean;
 
+      /**
+       * (Optional) Whether to pack multiple samples into a single sequence for
+       * efficiency
+       */
       packed?: boolean;
 
+      /**
+       * (Optional) Whether to compute loss on input tokens as well as output tokens
+       */
       train_on_input?: boolean;
 
+      /**
+       * (Optional) Unique identifier for the validation dataset
+       */
       validation_dataset_id?: string;
     }
 
+    /**
+     * (Optional) Configuration for memory and compute optimizations
+     */
     export interface EfficiencyConfig {
+      /**
+       * (Optional) Whether to use activation checkpointing to reduce memory usage
+       */
       enable_activation_checkpointing?: boolean;
 
+      /**
+       * (Optional) Whether to offload activations to CPU to save GPU memory
+       */
       enable_activation_offloading?: boolean;
 
+      /**
+       * (Optional) Whether to offload FSDP parameters to CPU
+       */
       fsdp_cpu_offload?: boolean;
 
+      /**
+       * (Optional) Whether to use memory-efficient FSDP wrapping
+       */
       memory_efficient_fsdp_wrap?: boolean;
     }
 
+    /**
+     * (Optional) Configuration for the optimization algorithm
+     */
     export interface OptimizerConfig {
+      /**
+       * Learning rate for the optimizer
+       */
       lr: number;
 
+      /**
+       * Number of steps for learning rate warmup
+       */
       num_warmup_steps: number;
 
+      /**
+       * Type of optimizer to use (adam, adamw, or sgd)
+       */
       optimizer_type: 'adam' | 'adamw' | 'sgd';
 
+      /**
+       * Weight decay coefficient for regularization
+       */
       weight_decay: number;
     }
   }

package/src/resources/providers.ts

@@ -22,10 +22,19 @@ export class Providers extends APIResource {
   }
 }
 
+/**
+ * Response containing a list of all available providers.
+ */
 export interface ListProvidersResponse {
+  /**
+   * List of provider information objects
+   */
   data: ProviderListResponse;
 }
 
+/**
+ * List of provider information objects
+ */
 export type ProviderListResponse = Array<InspectAPI.ProviderInfo>;
 
 export declare namespace Providers {

package/src/resources/responses/input-items.ts

@@ -26,7 +26,13 @@ export class InputItems extends APIResource {
   }
 }
 
+/**
+ * List container for OpenAI response input items.
+ */
 export interface InputItemListResponse {
+  /**
+   * List of input items
+   */
   data: Array<
     | InputItemListResponse.OpenAIResponseOutputMessageWebSearchToolCall
     | InputItemListResponse.OpenAIResponseOutputMessageFileSearchToolCall
@@ -35,41 +41,95 @@ export interface InputItemListResponse {
     | InputItemListResponse.OpenAIResponseMessage
   >;
 
+  /**
+   * Object type identifier, always "list"
+   */
   object: 'list';
 }
 
 export namespace InputItemListResponse {
+  /**
+   * Web search tool call output message for OpenAI responses.
+   */
   export interface OpenAIResponseOutputMessageWebSearchToolCall {
+    /**
+     * Unique identifier for this tool call
+     */
     id: string;
 
+    /**
+     * Current status of the web search operation
+     */
     status: string;
 
+    /**
+     * Tool call type identifier, always "web_search_call"
+     */
     type: 'web_search_call';
   }
 
+  /**
+   * File search tool call output message for OpenAI responses.
+   */
   export interface OpenAIResponseOutputMessageFileSearchToolCall {
+    /**
+     * Unique identifier for this tool call
+     */
     id: string;
 
+    /**
+     * List of search queries executed
+     */
     queries: Array<string>;
 
+    /**
+     * Current status of the file search operation
+     */
     status: string;
 
+    /**
+     * Tool call type identifier, always "file_search_call"
+     */
     type: 'file_search_call';
 
+    /**
+     * (Optional) Search results returned by the file search operation
+     */
     results?: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
   }
 
+  /**
+   * Function tool call output message for OpenAI responses.
+   */
   export interface OpenAIResponseOutputMessageFunctionToolCall {
+    /**
+     * JSON string containing the function arguments
+     */
     arguments: string;
 
+    /**
+     * Unique identifier for the function call
+     */
     call_id: string;
 
+    /**
+     * Name of the function being called
+     */
     name: string;
 
+    /**
+     * Tool call type identifier, always "function_call"
+     */
     type: 'function_call';
 
+    /**
+     * (Optional) Additional identifier for the tool call
+     */
     id?: string;
 
+    /**
+     * (Optional) Current status of the function call execution
+     */
     status?: string;
   }
 
@@ -113,17 +173,38 @@ export namespace InputItemListResponse {
   }
 
   export namespace OpenAIResponseMessage {
+    /**
+     * Text content for input messages in OpenAI response format.
+     */
     export interface OpenAIResponseInputMessageContentText {
+      /**
+       * The text content of the input message
+       */
       text: string;
 
+      /**
+       * Content type identifier, always "input_text"
+       */
       type: 'input_text';
     }
 
+    /**
+     * Image content for input messages in OpenAI response format.
+     */
     export interface OpenAIResponseInputMessageContentImage {
+      /**
+       * Level of detail for image processing, can be "low", "high", or "auto"
+       */
       detail: 'low' | 'high' | 'auto';
 
+      /**
+       * Content type identifier, always "input_image"
+       */
       type: 'input_image';
 
+      /**
+       * (Optional) URL of the image content
+       */
       image_url?: string;
     }
 
@@ -141,25 +222,58 @@ export namespace InputItemListResponse {
     }
 
     export namespace UnionMember2 {
+      /**
+       * File citation annotation for referencing specific files in response content.
+       */
       export interface OpenAIResponseAnnotationFileCitation {
+        /**
+         * Unique identifier of the referenced file
+         */
         file_id: string;
 
+        /**
+         * Name of the referenced file
+         */
         filename: string;
 
+        /**
+         * Position index of the citation within the content
+         */
         index: number;
 
+        /**
+         * Annotation type identifier, always "file_citation"
+         */
         type: 'file_citation';
       }
 
+      /**
+       * URL citation annotation for referencing external web resources.
+       */
       export interface OpenAIResponseAnnotationCitation {
+        /**
+         * End position of the citation span in the content
+         */
         end_index: number;
 
+        /**
+         * Start position of the citation span in the content
+         */
         start_index: number;
 
+        /**
+         * Title of the referenced web resource
+         */
         title: string;
 
+        /**
+         * Annotation type identifier, always "url_citation"
+         */
         type: 'url_citation';
 
+        /**
+         * URL of the referenced web resource
+         */
         url: string;
       }