@scenario-labs/sdk 2.4.0-alpha.1 → 2.5.0

package/src/resources/models/train.ts

@@ -168,12 +168,6 @@ export namespace TrainActionResponse {
       | 'qwen-image-edit-2511-lora'
       | 'qwen-image-edit-lora'
       | 'qwen-image-lora'
-      | 'sd-1_5'
-      | 'sd-1_5-composition'
-      | 'sd-1_5-lora'
-      | 'sd-xl'
-      | 'sd-xl-composition'
-      | 'sd-xl-lora'
       | 'zimage-de-turbo-lora'
       | 'zimage-lora'
       | 'zimage-turbo-lora';
@@ -211,6 +205,13 @@ export namespace TrainActionResponse {
      */
     concepts?: Array<Model.Concept>;
 
+    /**
+     * When true, credits spent on a generation with this model are not automatically
+     * refunded if the generation fails. Absent or false means failed generations are
+     * refunded as usual.
+     */
+    disableRefund?: boolean;
+
     /**
      * The epoch of the model. Only available for Flux Lora Trained models. If not set,
      * uses the final model epoch (latest)
@@ -333,7 +334,7 @@ export namespace TrainActionResponse {
       conceptPrompt: string;
 
       /**
-       * The model ID of the class (example: "stable-diffusion-v1-5")
+       * The model ID of the class. Only available for legacy models.
        */
       modelId: string;
 
@@ -576,12 +577,6 @@ export namespace TrainActionResponse {
         | 'qwen-image-edit-2511-lora'
         | 'qwen-image-edit-lora'
         | 'qwen-image-lora'
-        | 'sd-1_5'
-        | 'sd-1_5-composition'
-        | 'sd-1_5-lora'
-        | 'sd-xl'
-        | 'sd-xl-composition'
-        | 'sd-xl-lora'
         | 'zimage-de-turbo-lora'
         | 'zimage-lora'
         | 'zimage-turbo-lora'
@@ -698,7 +693,7 @@ export namespace TrainActionResponse {
       /**
        * The prompt to specify images in the same class as provided instance images
        *
-       * Only available for SD15 training
+       * Deprecated legacy training parameter.
        */
       classPrompt?: string;
 
@@ -714,11 +709,8 @@ export namespace TrainActionResponse {
        * The prompt with identifier specifying the instance (or subject) of the class
        * (example: "a daiton dog")
        *
-       * Default value varies depending on the model type:
-       *
-       * - For SD1.5: "daiton" if no class is associated with the model
-       * - For SDXL: "daiton"
-       * - For Flux: ""
+       * Default value varies depending on the model type. For Flux LoRA, the default is
+       * an empty string.
        */
       conceptPrompt?: string;
 
@@ -739,32 +731,30 @@ export namespace TrainActionResponse {
       /**
        * Initial learning rate (after the potential warmup period)
        *
-       * Default value varies depending on the model type:
-       *
-       * - For SD1.5 and SDXL: 0.000005
-       * - For Flux: 0.0001
+       * Default value varies depending on the model type. For Flux LoRA, the default is
+       * 0.0001.
        */
       learningRate?: number;
 
       /**
        * Initial learning rate (after the potential warmup period) for the text encoder
        *
-       * Maximum [Flux LoRA: 0.001] Default [SDXL: 0.00005 | Flux LoRA: 0.00001] Minimum
-       * [SDXL: 0 | Flux LoRA: 0.000001]
+       * Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
+       * 0.000001]
        */
       learningRateTextEncoder?: number;
 
       /**
        * Initial learning rate (after the potential warmup period) for the UNet
        *
-       * Only available for SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       learningRateUnet?: number;
 
       /**
        * The scheduler type to use (default: "constant")
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       lrScheduler?:
         | 'constant'
@@ -778,18 +768,12 @@ export namespace TrainActionResponse {
        * Maximum number of training steps to execute (default: varies depending on the
        * model type)
        *
-       * For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
-       * instead
-       *
        * Default value varies depending on the model type:
        *
-       * - For SD1.5: round((number of training images \* 225) / 3)
-       * - For SDXL: number of training images \* 175
        * - For Flux: number of training images \* 100
        *
        * Maximum value varies depending on the model type:
        *
-       * - For SD1.5 and SDXL: [0, 40000]
        * - For Flux: [0, 10000]
        */
       maxTrainSteps?: number;
@@ -811,14 +795,14 @@ export namespace TrainActionResponse {
       /**
        * The number of training steps for the text encoder
        *
-       * Only available for SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       numTextTrainSteps?: number;
 
       /**
        * The number of training steps for the UNet
        *
-       * Only available for SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       numUNetTrainSteps?: number;
 
@@ -841,7 +825,7 @@ export namespace TrainActionResponse {
       /**
        * The weight of prior preservation loss
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       priorLossWeight?: number;
 
@@ -849,32 +833,31 @@ export namespace TrainActionResponse {
        * Whether to random crop or center crop images before resizing to the working
        * resolution
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       randomCrop?: boolean;
 
       /**
        * Ratio of random crops
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       randomCropRatio?: number;
 
       /**
        * Scale of random crops
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       randomCropScale?: number;
 
       /**
        * The dimension of the LoRA update matrices
        *
-       * Only available for SDXL (deprecated), Flux LoRA and Musubi training
+       * Only available for Flux LoRA and Musubi training
        *
        * Default value varies depending on the model type:
        *
-       * - For SDXL (deprecated): 64
        * - For Flux: 16
        * - For Musubi: 64
        *
@@ -907,14 +890,14 @@ export namespace TrainActionResponse {
        *
        * Note: Legacy parameter, will be ignored
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       scaleLr?: boolean;
 
       /**
        * Used to reproduce previous results. Default: randomly generated number.
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       seed?: number;
 
@@ -926,21 +909,21 @@ export namespace TrainActionResponse {
        *
        * Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       textEncoderTrainingRatio?: number;
 
       /**
        * Validation frequency. Cannot be greater than maxTrainSteps value
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       validationFrequency?: number;
 
       /**
        * Validation prompt
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       validationPrompt?: string;
 
@@ -1377,12 +1360,12 @@ export interface TrainTriggerResponse {
   model: TrainTriggerResponse.Model;
 
   /**
-   * The Creative Units cost for the request billed
+   * The Compute Units cost for the request billed
    */
   creativeUnitsCost?: number;
 
   /**
-   * The Creative Units discount for the request billed
+   * The Compute Units discount for the request billed
    */
   creativeUnitsDiscount?: number;
 
@@ -1439,6 +1422,7 @@ export namespace TrainTriggerResponse {
       | 'skybox-base-360'
       | 'skybox-hdri'
       | 'skybox-upscale-360'
+      | 'splat'
       | 'texture'
       | 'translate'
       | 'upload'
@@ -1846,12 +1830,6 @@ export namespace TrainTriggerResponse {
             | 'qwen-image-edit-2511-lora'
             | 'qwen-image-edit-lora'
             | 'qwen-image-lora'
-            | 'sd-1_5'
-            | 'sd-1_5-composition'
-            | 'sd-1_5-lora'
-            | 'sd-xl'
-            | 'sd-xl-composition'
-            | 'sd-xl-lora'
             | 'zimage-de-turbo-lora'
             | 'zimage-lora'
             | 'zimage-turbo-lora'
@@ -2079,12 +2057,6 @@ export namespace TrainTriggerResponse {
               | 'qwen-image-edit-2511-lora'
               | 'qwen-image-edit-lora'
               | 'qwen-image-lora'
-              | 'sd-1_5'
-              | 'sd-1_5-composition'
-              | 'sd-1_5-lora'
-              | 'sd-xl'
-              | 'sd-xl-composition'
-              | 'sd-xl-lora'
               | 'zimage-de-turbo-lora'
               | 'zimage-lora'
               | 'zimage-turbo-lora'
@@ -2350,6 +2322,13 @@ export namespace TrainTriggerResponse {
       cuCost: number;
 
       cuDiscount: number;
+
+      /**
+       * When true, the credits charged for this job are not automatically refunded if
+       * the generation fails, because the model used does not support refund-on-failure.
+       * Absent or false means a failed generation is refunded as usual.
+       */
+      disableRefund?: boolean;
     }
   }
 
@@ -2477,12 +2456,6 @@ export namespace TrainTriggerResponse {
       | 'qwen-image-edit-2511-lora'
       | 'qwen-image-edit-lora'
       | 'qwen-image-lora'
-      | 'sd-1_5'
-      | 'sd-1_5-composition'
-      | 'sd-1_5-lora'
-      | 'sd-xl'
-      | 'sd-xl-composition'
-      | 'sd-xl-lora'
       | 'zimage-de-turbo-lora'
       | 'zimage-lora'
       | 'zimage-turbo-lora';
@@ -2520,6 +2493,13 @@ export namespace TrainTriggerResponse {
      */
     concepts?: Array<Model.Concept>;
 
+    /**
+     * When true, credits spent on a generation with this model are not automatically
+     * refunded if the generation fails. Absent or false means failed generations are
+     * refunded as usual.
+     */
+    disableRefund?: boolean;
+
     /**
      * The epoch of the model. Only available for Flux Lora Trained models. If not set,
      * uses the final model epoch (latest)
@@ -2642,7 +2622,7 @@ export namespace TrainTriggerResponse {
       conceptPrompt: string;
 
       /**
-       * The model ID of the class (example: "stable-diffusion-v1-5")
+       * The model ID of the class. Only available for legacy models.
        */
       modelId: string;
 
@@ -2885,12 +2865,6 @@ export namespace TrainTriggerResponse {
         | 'qwen-image-edit-2511-lora'
         | 'qwen-image-edit-lora'
         | 'qwen-image-lora'
-        | 'sd-1_5'
-        | 'sd-1_5-composition'
-        | 'sd-1_5-lora'
-        | 'sd-xl'
-        | 'sd-xl-composition'
-        | 'sd-xl-lora'
         | 'zimage-de-turbo-lora'
         | 'zimage-lora'
         | 'zimage-turbo-lora'
@@ -3007,7 +2981,7 @@ export namespace TrainTriggerResponse {
       /**
        * The prompt to specify images in the same class as provided instance images
        *
-       * Only available for SD15 training
+       * Deprecated legacy training parameter.
        */
       classPrompt?: string;
 
@@ -3023,11 +2997,8 @@ export namespace TrainTriggerResponse {
        * The prompt with identifier specifying the instance (or subject) of the class
        * (example: "a daiton dog")
        *
-       * Default value varies depending on the model type:
-       *
-       * - For SD1.5: "daiton" if no class is associated with the model
-       * - For SDXL: "daiton"
-       * - For Flux: ""
+       * Default value varies depending on the model type. For Flux LoRA, the default is
+       * an empty string.
        */
       conceptPrompt?: string;
 
@@ -3048,32 +3019,30 @@ export namespace TrainTriggerResponse {
       /**
        * Initial learning rate (after the potential warmup period)
        *
-       * Default value varies depending on the model type:
-       *
-       * - For SD1.5 and SDXL: 0.000005
-       * - For Flux: 0.0001
+       * Default value varies depending on the model type. For Flux LoRA, the default is
+       * 0.0001.
        */
       learningRate?: number;
 
       /**
        * Initial learning rate (after the potential warmup period) for the text encoder
        *
-       * Maximum [Flux LoRA: 0.001] Default [SDXL: 0.00005 | Flux LoRA: 0.00001] Minimum
-       * [SDXL: 0 | Flux LoRA: 0.000001]
+       * Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
+       * 0.000001]
        */
       learningRateTextEncoder?: number;
 
       /**
        * Initial learning rate (after the potential warmup period) for the UNet
        *
-       * Only available for SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       learningRateUnet?: number;
 
       /**
        * The scheduler type to use (default: "constant")
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       lrScheduler?:
         | 'constant'
@@ -3087,18 +3056,12 @@ export namespace TrainTriggerResponse {
        * Maximum number of training steps to execute (default: varies depending on the
        * model type)
        *
-       * For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
-       * instead
-       *
        * Default value varies depending on the model type:
        *
-       * - For SD1.5: round((number of training images \* 225) / 3)
-       * - For SDXL: number of training images \* 175
        * - For Flux: number of training images \* 100
        *
        * Maximum value varies depending on the model type:
        *
-       * - For SD1.5 and SDXL: [0, 40000]
        * - For Flux: [0, 10000]
        */
       maxTrainSteps?: number;
@@ -3120,14 +3083,14 @@ export namespace TrainTriggerResponse {
       /**
        * The number of training steps for the text encoder
        *
-       * Only available for SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       numTextTrainSteps?: number;
 
       /**
        * The number of training steps for the UNet
        *
-       * Only available for SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       numUNetTrainSteps?: number;
 
@@ -3150,7 +3113,7 @@ export namespace TrainTriggerResponse {
       /**
        * The weight of prior preservation loss
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       priorLossWeight?: number;
 
@@ -3158,32 +3121,31 @@ export namespace TrainTriggerResponse {
        * Whether to random crop or center crop images before resizing to the working
        * resolution
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       randomCrop?: boolean;
 
       /**
        * Ratio of random crops
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       randomCropRatio?: number;
 
       /**
        * Scale of random crops
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       randomCropScale?: number;
 
       /**
        * The dimension of the LoRA update matrices
        *
-       * Only available for SDXL (deprecated), Flux LoRA and Musubi training
+       * Only available for Flux LoRA and Musubi training
        *
        * Default value varies depending on the model type:
        *
-       * - For SDXL (deprecated): 64
        * - For Flux: 16
        * - For Musubi: 64
        *
@@ -3216,14 +3178,14 @@ export namespace TrainTriggerResponse {
        *
        * Note: Legacy parameter, will be ignored
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       scaleLr?: boolean;
 
       /**
        * Used to reproduce previous results. Default: randomly generated number.
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       seed?: number;
 
@@ -3235,21 +3197,21 @@ export namespace TrainTriggerResponse {
        *
        * Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       textEncoderTrainingRatio?: number;
 
       /**
        * Validation frequency. Cannot be greater than maxTrainSteps value
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       validationFrequency?: number;
 
       /**
        * Validation prompt
        *
-       * Only available for SD15 and SDXL LoRA training
+       * Deprecated legacy training parameter.
        */
       validationPrompt?: string;
 
@@ -3811,7 +3773,7 @@ export namespace TrainTriggerParams {
     /**
      * The prompt to specify images in the same class as provided instance images
      *
-     * Only available for SD15 training
+     * Deprecated legacy training parameter.
      */
     classPrompt?: string;
 
@@ -3827,11 +3789,8 @@ export namespace TrainTriggerParams {
      * The prompt with identifier specifying the instance (or subject) of the class
      * (example: "a daiton dog")
      *
-     * Default value varies depending on the model type:
-     *
-     * - For SD1.5: "daiton" if no class is associated with the model
-     * - For SDXL: "daiton"
-     * - For Flux: ""
+     * Default value varies depending on the model type. For Flux LoRA, the default is
+     * an empty string.
      */
     conceptPrompt?: string;
 
@@ -3852,32 +3811,30 @@ export namespace TrainTriggerParams {
     /**
      * Initial learning rate (after the potential warmup period)
      *
-     * Default value varies depending on the model type:
-     *
-     * - For SD1.5 and SDXL: 0.000005
-     * - For Flux: 0.0001
+     * Default value varies depending on the model type. For Flux LoRA, the default is
+     * 0.0001.
      */
     learningRate?: number;
 
     /**
      * Initial learning rate (after the potential warmup period) for the text encoder
      *
-     * Maximum [Flux LoRA: 0.001] Default [SDXL: 0.00005 | Flux LoRA: 0.00001] Minimum
-     * [SDXL: 0 | Flux LoRA: 0.000001]
+     * Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
+     * 0.000001]
      */
     learningRateTextEncoder?: number;
 
     /**
      * Initial learning rate (after the potential warmup period) for the UNet
      *
-     * Only available for SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     learningRateUnet?: number;
 
     /**
      * The scheduler type to use (default: "constant")
      *
-     * Only available for SD15 and SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     lrScheduler?:
       | 'constant'
@@ -3891,18 +3848,12 @@ export namespace TrainTriggerParams {
      * Maximum number of training steps to execute (default: varies depending on the
      * model type)
      *
-     * For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
-     * instead
-     *
      * Default value varies depending on the model type:
      *
-     * - For SD1.5: round((number of training images \* 225) / 3)
-     * - For SDXL: number of training images \* 175
      * - For Flux: number of training images \* 100
      *
      * Maximum value varies depending on the model type:
      *
-     * - For SD1.5 and SDXL: [0, 40000]
      * - For Flux: [0, 10000]
      */
     maxTrainSteps?: number;
@@ -3924,14 +3875,14 @@ export namespace TrainTriggerParams {
     /**
      * The number of training steps for the text encoder
      *
-     * Only available for SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     numTextTrainSteps?: number;
 
     /**
      * The number of training steps for the UNet
      *
-     * Only available for SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     numUNetTrainSteps?: number;
 
@@ -3954,7 +3905,7 @@ export namespace TrainTriggerParams {
     /**
      * The weight of prior preservation loss
      *
-     * Only available for SD15 and SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     priorLossWeight?: number;
 
@@ -3962,32 +3913,31 @@ export namespace TrainTriggerParams {
      * Whether to random crop or center crop images before resizing to the working
      * resolution
      *
-     * Only available for SD15 and SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     randomCrop?: boolean;
 
     /**
      * Ratio of random crops
      *
-     * Only available for SD15 and SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     randomCropRatio?: number;
 
     /**
      * Scale of random crops
      *
-     * Only available for SD15 and SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     randomCropScale?: number;
 
     /**
      * The dimension of the LoRA update matrices
      *
-     * Only available for SDXL (deprecated), Flux LoRA and Musubi training
+     * Only available for Flux LoRA and Musubi training
      *
      * Default value varies depending on the model type:
      *
-     * - For SDXL (deprecated): 64
      * - For Flux: 16
      * - For Musubi: 64
      *
@@ -4020,14 +3970,14 @@ export namespace TrainTriggerParams {
      *
      * Note: Legacy parameter, will be ignored
      *
-     * Only available for SD15 and SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     scaleLr?: boolean;
 
     /**
      * Used to reproduce previous results. Default: randomly generated number.
      *
-     * Only available for SD15 and SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     seed?: number;
 
@@ -4039,21 +3989,21 @@ export namespace TrainTriggerParams {
      *
      * Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
      *
-     * Only available for SD15 and SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     textEncoderTrainingRatio?: number;
 
     /**
      * Validation frequency. Cannot be greater than maxTrainSteps value
      *
-     * Only available for SD15 and SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     validationFrequency?: number;
 
     /**
      * Validation prompt
      *
-     * Only available for SD15 and SDXL LoRA training
+     * Deprecated legacy training parameter.
      */
     validationPrompt?: string;