@scenario-labs/sdk 0.1.2

package/resources/models/train.d.mts

@@ -0,0 +1,2334 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Train extends APIResource {
+    /**
+     * Trigger an action on a model training: cancel
+     */
+    action(modelID: string, body: TrainActionParams, options?: RequestOptions): APIPromise<TrainActionResponse>;
+    /**
+     * Trigger the given `modelId` training
+     */
+    trigger(modelID: string, params: TrainTriggerParams, options?: RequestOptions): APIPromise<TrainTriggerResponse>;
+}
+export interface TrainActionResponse {
+    model: TrainActionResponse.Model;
+}
+export declare namespace TrainActionResponse {
+    interface Model {
+        /**
+         * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+         */
+        id: string;
+        /**
+         * List of model capabilities (example: ["txt2img", "img2img",
+         * "txt2img_ip_adapter", ...])
+         */
+        capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video2img' | 'video2video'>;
+        /**
+         * A list of CollectionId this model belongs to
+         */
+        collectionIds: Array<string>;
+        /**
+         * The model creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+         */
+        createdAt: string;
+        /**
+         * Whether the model is a custom model and can be used only with POST
+         * /generate/custom/{modelId} endpoint
+         */
+        custom: boolean;
+        /**
+         * List of all example asset IDs setup by the model owner
+         */
+        exampleAssetIds: Array<string>;
+        /**
+         * The privacy of the model (default: private)
+         */
+        privacy: 'private' | 'public' | 'unlisted';
+        /**
+         * The source of the model
+         */
+        source: 'civitai' | 'huggingface' | 'other' | 'scenario';
+        /**
+         * The model status
+         */
+        status: 'copying' | 'failed' | 'new' | 'trained' | 'training' | 'training-canceled';
+        /**
+         * The associated tags (example: ["sci-fi", "landscape"])
+         */
+        tags: Array<string>;
+        /**
+         * The total number of training images
+         */
+        trainingImagesNumber: number;
+        /**
+         * The model type (example: "flux.1-lora")
+         */
+        type: 'custom' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora';
+        /**
+         * The model last update date as an ISO string (example:
+         * "2023-02-03T11:19:41.579Z")
+         */
+        updatedAt: string;
+        /**
+         * The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
+         * 75: Team plan 100: Enterprise plan
+         */
+        accessRestrictions?: number;
+        /**
+         * The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
+         */
+        authorId?: string;
+        /**
+         * The class of the model
+         */
+        class?: Model.Class;
+        /**
+         * Compliance and regulatory metadata for the model
+         */
+        complianceMetadata?: Model.ComplianceMetadata;
+        /**
+         * List of base model IDs compliant with the model (example: ["flux.1-dev",
+         * "flux.1-schnell"]) This attribute is mainly used for Flux LoRA models
+         */
+        compliantModelIds?: Array<string>;
+        /**
+         * The concepts is required for the type model: composition
+         */
+        concepts?: Array<Model.Concept>;
+        /**
+         * The epoch of the model. Only available for Flux Lora Trained models. If not set,
+         * uses the final model epoch (latest)
+         */
+        epoch?: string;
+        /**
+         * The epochs of the model. Only available for Flux Lora Trained models.
+         */
+        epochs?: Array<Model.Epoch>;
+        /**
+         * The inputs of the model. Only used for custom models. To retrieve this list, get
+         * it by modelId with GET /models/{modelId}
+         */
+        inputs?: Array<Model.Input>;
+        /**
+         * The model keyword, this is a legacy parameter, please use conceptPrompt in
+         * parameters
+         */
+        modelKeyword?: string;
+        /**
+         * The model name (example: "Cinematic Realism")
+         */
+        name?: string;
+        /**
+         * Fine-tune the model's inferences with negative prompt embedding
+         */
+        negativePromptEmbedding?: string;
+        /**
+         * The owner ID (example: "team_VFhihHKMRZyDDnZAJwLb2Q")
+         */
+        ownerId?: string;
+        /**
+         * The parameters of the model
+         */
+        parameters?: Model.Parameters;
+        /**
+         * The id of the parent model
+         */
+        parentModelId?: string;
+        /**
+         * Fine-tune the model's inferences with prompt embedding
+         */
+        promptEmbedding?: string;
+        /**
+         * The model short description (example: "This model generates highly detailed
+         * cinematic scenes.")
+         */
+        shortDescription?: string;
+        /**
+         * The date when the model will be soft deleted (only for Free plan)
+         */
+        softDeletionOn?: string;
+        /**
+         * A thumbnail for your model
+         */
+        thumbnail?: Model.Thumbnail;
+        /**
+         * Array of training image pairs
+         */
+        trainingImagePairs?: Array<Model.TrainingImagePair>;
+        /**
+         * The URLs of the first 3 training images of the model. To retrieve the full set
+         * of images, get it by modelId
+         */
+        trainingImages?: Array<Model.TrainingImage>;
+        /**
+         * Additional information about the training progress of the model
+         */
+        trainingProgress?: Model.TrainingProgress;
+        /**
+         * Additional information about the model's training
+         */
+        trainingStats?: Model.TrainingStats;
+        /**
+         * The UI configuration for the model
+         */
+        uiConfig?: Model.UiConfig;
+        /**
+         * (Deprecated) The user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
+         */
+        userId?: string;
+    }
+    namespace Model {
+        /**
+         * The class of the model
+         */
+        interface Class {
+            /**
+             * The category slug of the class (example: "art-style")
+             */
+            category: string;
+            /**
+             * The concept prompt of the class (example: "a sks character design")
+             */
+            conceptPrompt: string;
+            /**
+             * The model ID of the class (example: "stable-diffusion-v1-5")
+             */
+            modelId: string;
+            /**
+             * The class name (example: "Character Design")
+             */
+            name: string;
+            /**
+             * The class prompt (example: "a character design")
+             */
+            prompt: string;
+            /**
+             * The class slug (example: "art-style-character-design")
+             */
+            slug: string;
+            /**
+             * The class status (only published classes are listed, but unpublished classes can
+             * still appear in existing models)
+             */
+            status: 'published' | 'unpublished';
+            /**
+             * Some example images URLs to showcase the class
+             */
+            thumbnails: Array<string>;
+        }
+        /**
+         * Compliance and regulatory metadata for the model
+         */
+        interface ComplianceMetadata {
+            /**
+             * Data processing comment (e.g., zeroRetention, temporaryRetention, etc.)
+             */
+            dataProcessingComment?: 'researchOnly' | 'serviceImprovement' | 'temporaryRetention' | 'zeroRetention';
+            /**
+             * URL to license terms
+             */
+            licenseTerms?: string;
+            /**
+             * The maintainer of the model
+             */
+            maintainer?: 'Fal' | 'Provider' | 'Replicate' | 'Scenario';
+            /**
+             * The provider of the model (examples: 'Google', 'AWS', 'BFL', 'Meshy', etc.)
+             */
+            modelProvider?: string;
+            /**
+             * The sub-processor used for the model
+             */
+            subProcessor?: 'AWS' | 'Fal' | 'Modal' | 'Provider' | 'Replicate';
+        }
+        interface Concept {
+            /**
+             * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+             */
+            modelId: string;
+            /**
+             * The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
+             * is between 0 and 2.
+             */
+            scale: number;
+            /**
+             * The epoch of the model (example: "000001") Only available for Flux Lora Trained
+             * models
+             */
+            modelEpoch?: string;
+        }
+        interface Epoch {
+            /**
+             * The epoch hash to identify the epoch
+             */
+            epoch: string;
+            /**
+             * The assets of the epoch if sample prompts as been supplied during training
+             */
+            assets?: Array<Epoch.Asset>;
+        }
+        namespace Epoch {
+            interface Asset {
+                /**
+                 * The AssetId of the image during training (example:
+                 * "asset_GTrL3mq4SXWyMxkOHRxlpw")
+                 */
+                assetId: string;
+                /**
+                 * The url of the asset
+                 */
+                url: string;
+            }
+        }
+        /**
+         * Defines the input parameters for a model. Use this to understand the available
+         * input parameters for a given `modelId` when calling
+         * `POST /generate/custom/{modelId}`. See {@link
+         * https://docs.scenario.com/docs/video-generation} for examples.
+         */
+        interface Input {
+            /**
+             * The name that must be user to call the model through the API
+             */
+            name: string;
+            /**
+             * The data type of the input
+             */
+            type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
+            /**
+             * The allowed values for the input. For \`string\` or \`number\` types, creates a
+             * single-select dropdown. For \`string_array\` type, creates a multi-select
+             * dropdown.
+             */
+            allowedValues?: Array<unknown>;
+            /**
+             * Specifies the background behavior for the input. Only available for \`file\` and
+             * \`file_array\` input types with kind \`image\`.
+             */
+            backgroundBehavior?: 'opaque' | 'transparent';
+            /**
+             * Whether the input is a color or not. Only available for \`string\` input type.
+             */
+            color?: boolean;
+            /**
+             * Whether this input affects the model's cost calculation
+             */
+            costImpact?: boolean;
+            /**
+             * Help text displayed in the UI to provide additional information about the input
+             */
+            description?: string;
+            /**
+             * Used to visually group inputs together in the UI. Inputs with the same group
+             * value appear consecutively in the UI.
+             */
+            group?: string;
+            /**
+             * Hint text displayed in the UI as a tooltip to guide the user
+             */
+            hint?: string;
+            /**
+             * The list of inputs which form an object within a container array. All inputs are
+             * the same as the current object. This is only available for type inputs_array
+             * inputs.
+             */
+            inputs?: Array<unknown>;
+            /**
+             * The asset kind of the input. Only taken into account for \`file\` and
+             * \`file_array\` input types.
+             */
+            kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+            /**
+             * The label displayed in the UI for this input
+             */
+            label?: string;
+            /**
+             * The name of the file input field to use as the mask source
+             */
+            maskFrom?: string;
+            /**
+             * The maximum allowed value. Only available for \`number\` and \`array\` input
+             * types.
+             */
+            max?: number;
+            /**
+             * The maximum allowed length for \`string\` inputs. Also applies to each item in
+             * \`string_array\`.
+             */
+            maxLength?: number;
+            /**
+             * The minimum allowed value. Only available for \`number\` and array input types.
+             */
+            min?: number;
+            /**
+             * The minimum allowed length for string inputs. Also applies to each item in
+             * \`string_array\`.
+             */
+            minLength?: number;
+            /**
+             * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
+             * available for \`model_array\` input type.
+             */
+            modelTypes?: Array<'custom' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora'>;
+            /**
+             * Whether this input represents a parent asset to assign to the produced assets.
+             * Only available for \`file\` and \`file_array\` input types.
+             *
+             * For \`file_array\`, the parent asset is the first item in the array.
+             */
+            parent?: boolean;
+            /**
+             * Placeholder text for the input. Only available for 'string' input type.
+             */
+            placeholder?: string;
+            /**
+             * Whether the input is a prompt. When true, displays as a text area with prompt
+             * spark feature. Only available for \`string\` input type.
+             */
+            prompt?: boolean;
+            /**
+             * Whether the input is used with prompt spark. Only available for \`string\` input
+             * type.
+             */
+            promptSpark?: boolean;
+            /**
+             * Set of rules that describes when this input is required:
+             *
+             * - \`always\`: Input is always required
+             * - \`ifNotDefined\`: Input is required when another specified input is not
+             *   defined
+             * - \`ifDefined\`: Input is required when another specified input is defined
+             * - \`conditionalValues\`: Input is required when another input has a specific
+             *   value
+             *
+             * By default, the input is not required.
+             */
+            required?: Input.Required;
+            /**
+             * The step increment for numeric inputs. Only available for \`number\` input type.
+             */
+            step?: number;
+        }
+        namespace Input {
+            /**
+             * Set of rules that describes when this input is required:
+             *
+             * - \`always\`: Input is always required
+             * - \`ifNotDefined\`: Input is required when another specified input is not
+             *   defined
+             * - \`ifDefined\`: Input is required when another specified input is defined
+             * - \`conditionalValues\`: Input is required when another input has a specific
+             *   value
+             *
+             * By default, the input is not required.
+             */
+            interface Required {
+                /**
+                 * Whether the input is always required
+                 */
+                always?: boolean;
+                /**
+                 * Makes this input required when another input has a specific value:
+                 *
+                 * - Key: name of the input to check
+                 * - Value: operation and allowed values that trigger the requirement
+                 */
+                conditionalValues?: unknown;
+                /**
+                 * Makes this input required when another input is defined:
+                 *
+                 * - Key: name of the input that must be defined
+                 * - Value: message to display when this input is required
+                 */
+                ifDefined?: unknown;
+                /**
+                 * Makes this input required when another input is not defined:
+                 *
+                 * - Key: name of the input that must be undefined
+                 * - Value: message to display when this input is required
+                 */
+                ifNotDefined?: unknown;
+            }
+        }
+        /**
+         * The parameters of the model
+         */
+        interface Parameters {
+            /**
+             * The batch size Less steps, and will increase the learning rate
+             *
+             * Only available for Flux LoRA training
+             */
+            batchSize?: number;
+            /**
+             * The prompt to specify images in the same class as provided instance images
+             *
+             * Only available for SD15 training
+             */
+            classPrompt?: string;
+            /**
+             * 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: ""
+             */
+            conceptPrompt?: string;
+            /**
+             * 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
+             */
+            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]
+             */
+            learningRateTextEncoder?: number;
+            /**
+             * Initial learning rate (after the potential warmup period) for the UNet
+             *
+             * Only available for SDXL LoRA training
+             */
+            learningRateUnet?: number;
+            /**
+             * The scheduler type to use (default: "constant")
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
+            /**
+             * 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;
+            /**
+             * The number of epochs to train for
+             *
+             * Only available for Flux LoRA training
+             */
+            nbEpochs?: number;
+            /**
+             * The number of times to repeat the training
+             *
+             * Only available for Flux LoRA training
+             */
+            nbRepeats?: number;
+            /**
+             * The number of training steps for the text encoder
+             *
+             * Only available for SDXL LoRA training
+             */
+            numTextTrainSteps?: number;
+            /**
+             * The number of training steps for the UNet
+             *
+             * Only available for SDXL LoRA training
+             */
+            numUNetTrainSteps?: number;
+            /**
+             * Optimize the model training task for a specific type of input images. The
+             * available values are:
+             *
+             * - "likeness": optimize training for likeness or portrait (targets specific
+             *   transformer blocks)
+             * - "all": train all transformer blocks
+             * - "none": train no specific transformer blocks
+             *
+             * This parameter controls which double and single transformer blocks are trained
+             * during the LoRA training process.
+             *
+             * Only available for Flux LoRA training
+             */
+            optimizeFor?: 'likeness';
+            /**
+             * The weight of prior preservation loss
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            priorLossWeight?: number;
+            /**
+             * Whether to random crop or center crop images before resizing to the working
+             * resolution
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            randomCrop?: boolean;
+            /**
+             * Ratio of random crops
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            randomCropRatio?: number;
+            /**
+             * Scale of random crops
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            randomCropScale?: number;
+            /**
+             * The dimension of the LoRA update matrices
+             *
+             * Only available for SDXL and Flux LoRA training
+             *
+             * Default value varies depending on the model type:
+             *
+             * - For SDXL: 64
+             * - For Flux: 16
+             */
+            rank?: number;
+            /**
+             * The prompts to use for each epoch Only available for Flux LoRA training
+             */
+            samplePrompts?: Array<string>;
+            /**
+             * The sample prompt images (AssetIds) paired with samplePrompts Only available for
+             * Flux LoRA training Must be the same length as samplePrompts
+             */
+            sampleSourceImages?: Array<string>;
+            /**
+             * Whether to scale the learning rate
+             *
+             * Note: Legacy parameter, will be ignored
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            scaleLr?: boolean;
+            /**
+             * Used to reproduce previous results. Default: randomly generated number.
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            seed?: number;
+            /**
+             * Whether to train the text encoder or not
+             *
+             * Example: For 100 steps and a value of 0.2, it means that the text encoder will
+             * be trained for 20 steps and then the UNet for 80 steps
+             *
+             * Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            textEncoderTrainingRatio?: number;
+            /**
+             * Validation frequency. Cannot be greater than maxTrainSteps value
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            validationFrequency?: number;
+            /**
+             * Validation prompt
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            validationPrompt?: string;
+            /**
+             * The Weights And Bias key to use for logging. The maximum length is 40 characters
+             */
+            wandbKey?: string;
+        }
+        /**
+         * A thumbnail for your model
+         */
+        interface Thumbnail {
+            /**
+             * The AssetId of the image used as a thumbnail for your model (example:
+             * "asset_GTrL3mq4SXWyMxkOHRxlpw")
+             */
+            assetId: string;
+            /**
+             * The url of the image used as a thumbnail for your model
+             */
+            url: string;
+        }
+        interface TrainingImagePair {
+            /**
+             * The instruction for the image pair, source to target
+             */
+            instruction?: string;
+            /**
+             * The source asset ID (must be a training asset)
+             */
+            sourceId?: string;
+            /**
+             * The target asset ID (must be a training asset)
+             */
+            targetId?: string;
+        }
+        interface TrainingImage {
+            /**
+             * The training image ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+             */
+            id: string;
+            /**
+             * Automatic captioning of the image
+             */
+            automaticCaptioning: string;
+            /**
+             * The training image upload date as an ISO string (example:
+             * "2023-02-03T11:19:41.579Z")
+             */
+            createdAt: string;
+            /**
+             * Description for the image
+             */
+            description: string;
+            /**
+             * The URL of the image
+             */
+            downloadUrl: string;
+            /**
+             * The original file name of the image (example: "my-training-image.jpg")
+             */
+            name: string;
+        }
+        /**
+         * Additional information about the training progress of the model
+         */
+        interface TrainingProgress {
+            /**
+             * The stage of the request
+             */
+            stage: 'pending' | 'queued-for-train' | 'running-train' | 'starting-train';
+            /**
+             * Timestamp in milliseconds of the last time the training progress was updated
+             */
+            updatedAt: number;
+            /**
+             * Position of the job in the queue (ie. the number of job in the queue before this
+             * one)
+             */
+            position?: number;
+            /**
+             * The progress of the job
+             */
+            progress?: number;
+            /**
+             * The remaining time in milliseconds
+             */
+            remainingTimeMs?: number;
+            /**
+             * The timestamp in millisecond marking the start of the process
+             */
+            startedAt?: number;
+        }
+        /**
+         * Additional information about the model's training
+         */
+        interface TrainingStats {
+            /**
+             * The training end time as an ISO date string
+             */
+            endedAt?: string;
+            /**
+             * The training queued duration in seconds
+             */
+            queueDuration?: number;
+            /**
+             * The training start time as an ISO date string
+             */
+            startedAt?: string;
+            /**
+             * The training duration in seconds
+             */
+            trainDuration?: number;
+        }
+        /**
+         * The UI configuration for the model
+         */
+        interface UiConfig {
+            /**
+             * Configuration for the input properties
+             */
+            inputProperties?: {
+                [key: string]: UiConfig.InputProperties;
+            };
+            /**
+             * Configuration for the loras component
+             */
+            lorasComponent?: UiConfig.LorasComponent;
+            /**
+             * Configuration for the presets
+             */
+            presets?: Array<UiConfig.Preset>;
+            /**
+             * Configuration for the resolution component
+             */
+            resolutionComponent?: UiConfig.ResolutionComponent;
+            /**
+             * Configuration for the selects
+             */
+            selects?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Configuration for the trigger generate button
+             */
+            triggerGenerate?: UiConfig.TriggerGenerate;
+        }
+        namespace UiConfig {
+            interface InputProperties {
+                collapsed?: boolean;
+            }
+            /**
+             * Configuration for the loras component
+             */
+            interface LorasComponent {
+                /**
+                 * The label of the component
+                 */
+                label: string;
+                /**
+                 * The input name of the model (model_array)
+                 */
+                modelInput: string;
+                /**
+                 * The input name of the scale (number_array)
+                 */
+                scaleInput: string;
+                /**
+                 * The input model id (example: a composition or a single LoRA modelId) If
+                 * specified, the model id will be attached to the output asset as a metadata If
+                 * the model-decomposer parser is specified on it, modelInput and scaleInput will
+                 * be automatically populated
+                 */
+                modelIdInput?: string;
+            }
+            interface Preset {
+                fields: Array<string>;
+                presets: unknown;
+            }
+            /**
+             * Configuration for the resolution component
+             */
+            interface ResolutionComponent {
+                /**
+                 * The input name of the height
+                 */
+                heightInput: string;
+                /**
+                 * The label of the component
+                 */
+                label: string;
+                /**
+                 * The resolution presets
+                 */
+                presets: Array<ResolutionComponent.Preset>;
+                /**
+                 * The input name of the width
+                 */
+                widthInput: string;
+            }
+            namespace ResolutionComponent {
+                interface Preset {
+                    height: number;
+                    label: string;
+                    width: number;
+                }
+            }
+            /**
+             * Configuration for the trigger generate button
+             */
+            interface TriggerGenerate {
+                label: string;
+                /**
+                 * The 'name' of the input where the trigger generate button will be displayed
+                 * (after the input). Do not specify both position and after.
+                 */
+                after?: string;
+                /**
+                 * The position of the trigger generate button. If position specified, the button
+                 * will be displayed at the specified position. Do not specify both position and
+                 * after.
+                 */
+                position?: 'bottom' | 'top';
+            }
+        }
+    }
+}
+export interface TrainTriggerResponse {
+    job: TrainTriggerResponse.Job;
+    model: TrainTriggerResponse.Model;
+    /**
+     * The Creative Units cost for the request billed
+     */
+    creativeUnitsCost?: number;
+    /**
+     * The Creative Units discount for the request billed
+     */
+    creativeUnitsDiscount?: number;
+}
+export declare namespace TrainTriggerResponse {
+    interface Job {
+        /**
+         * The job creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+         */
+        createdAt: string;
+        /**
+         * The job ID (example: "job_ocZCnG1Df35XRL1QyCZSRxAG8")
+         */
+        jobId: string;
+        /**
+         * The type of job
+         */
+        jobType: 'assets-download' | 'canvas-export' | 'caption' | 'caption-llava' | 'custom' | 'describe-style' | 'detection' | 'embed' | 'flux' | 'flux-model-training' | 'generate-prompt' | 'image-generation' | 'image-prompt-editing' | 'inference' | 'mesh-preview-rendering' | 'model-download' | 'model-import' | 'model-training' | 'openai-image-generation' | 'patch-image' | 'pixelate' | 'reframe' | 'remove-background' | 'repaint' | 'restyle' | 'segment' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-upscale-360' | 'texture' | 'translate' | 'upload' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'vectorize' | 'workflow';
+        /**
+         * Metadata of the job with some additional information
+         */
+        metadata: Job.Metadata;
+        /**
+         * Progress of the job (between 0 and 1)
+         */
+        progress: number;
+        /**
+         * The current status of the job
+         */
+        status: 'canceled' | 'failure' | 'finalizing' | 'in-progress' | 'pending' | 'queued' | 'success' | 'warming-up';
+        /**
+         * The history of the different statuses the job went through with the ISO string
+         * date of when the job reached each statuses.
+         */
+        statusHistory: Array<Job.StatusHistory>;
+        /**
+         * The job last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+         */
+        updatedAt: string;
+        /**
+         * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+         */
+        authorId?: string;
+        /**
+         * The billing of the job
+         */
+        billing?: Job.Billing;
+        /**
+         * The owner ID (example: "team_U3Qmc8PCdWXwAQJ4Dvw4tV6D")
+         */
+        ownerId?: string;
+    }
+    namespace Job {
+        /**
+         * Metadata of the job with some additional information
+         */
+        interface Metadata {
+            /**
+             * List of produced assets for this job
+             */
+            assetIds?: Array<string>;
+            /**
+             * The flow of the job. Only available for workflow jobs.
+             */
+            flow?: Array<Metadata.Flow>;
+            /**
+             * The inputs for the job
+             */
+            input?: unknown;
+            /**
+             * The output of the job
+             */
+            output?: unknown;
+            /**
+             * The workflow ID of the job if job is part of a workflow.
+             */
+            workflowId?: string;
+            /**
+             * The workflow job ID of the job if job is part of a workflow job.
+             */
+            workflowJobId?: string;
+        }
+        namespace Metadata {
+            interface Flow {
+                /**
+                 * The id of the node.
+                 */
+                id: string;
+                /**
+                 * The status of the node. Only available for WorkflowJob nodes.
+                 */
+                status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+                /**
+                 * The type of the job for the node.
+                 */
+                type: 'custom-model' | 'generate-prompt' | 'logic' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
+                /**
+                 * List of produced assets for this node.
+                 */
+                assets?: Array<Flow.Asset>;
+                /**
+                 * The nodes that this node depends on. Only available for nodes that have
+                 * dependencies. Mainly used for user approval nodes.
+                 */
+                dependsOn?: Array<string>;
+                /**
+                 * The inputs of the node.
+                 */
+                inputs?: Array<Flow.Input>;
+                /**
+                 * If the flow is part of a WorkflowJob, this is the jobId for the node. jobId is
+                 * only available for nodes started. A node "Pending" for a running workflow job is
+                 * not started.
+                 */
+                jobId?: string;
+                /**
+                 * The logic of the node. Only available for logic nodes.
+                 */
+                logic?: Flow.Logic;
+                /**
+                 * The type of the logic for the node. Only available for logic nodes.
+                 */
+                logicType?: 'if-else';
+                /**
+                 * The model id for the node. Mainly used for custom model tasks.
+                 */
+                modelId?: string;
+                /**
+                 * The workflow id for the node. Mainly used for workflow tasks.
+                 */
+                workflowId?: string;
+            }
+            namespace Flow {
+                interface Asset {
+                    assetId: string;
+                    url: string;
+                }
+                /**
+                 * This is used to run the flow.
+                 */
+                interface Input {
+                    /**
+                     * The name that must be user to call the model through the API
+                     */
+                    name: string;
+                    /**
+                     * The data type of the input
+                     */
+                    type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
+                    /**
+                     * The allowed values for the input. For \`string\` or \`number\` types, creates a
+                     * single-select dropdown. For \`string_array\` type, creates a multi-select
+                     * dropdown.
+                     */
+                    allowedValues?: Array<unknown>;
+                    /**
+                     * Specifies the background behavior for the input. Only available for \`file\` and
+                     * \`file_array\` input types with kind \`image\`.
+                     */
+                    backgroundBehavior?: 'opaque' | 'transparent';
+                    /**
+                     * Whether the input is a color or not. Only available for \`string\` input type.
+                     */
+                    color?: boolean;
+                    /**
+                     * Whether this input affects the model's cost calculation
+                     */
+                    costImpact?: boolean;
+                    /**
+                     * Help text displayed in the UI to provide additional information about the input
+                     */
+                    description?: string;
+                    /**
+                     * Used to visually group inputs together in the UI. Inputs with the same group
+                     * value appear consecutively in the UI.
+                     */
+                    group?: string;
+                    /**
+                     * Hint text displayed in the UI as a tooltip to guide the user
+                     */
+                    hint?: string;
+                    /**
+                     * The list of inputs which form an object within a container array. All inputs are
+                     * the same as the current object. This is only available for type inputs_array
+                     * inputs.
+                     */
+                    inputs?: Array<unknown>;
+                    /**
+                     * The asset kind of the input. Only taken into account for \`file\` and
+                     * \`file_array\` input types.
+                     */
+                    kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+                    /**
+                     * The label displayed in the UI for this input
+                     */
+                    label?: string;
+                    /**
+                     * The name of the file input field to use as the mask source
+                     */
+                    maskFrom?: string;
+                    /**
+                     * The maximum allowed value. Only available for \`number\` and \`array\` input
+                     * types.
+                     */
+                    max?: number;
+                    /**
+                     * The maximum allowed length for \`string\` inputs. Also applies to each item in
+                     * \`string_array\`.
+                     */
+                    maxLength?: number;
+                    /**
+                     * The minimum allowed value. Only available for \`number\` and array input types.
+                     */
+                    min?: number;
+                    /**
+                     * The minimum allowed length for string inputs. Also applies to each item in
+                     * \`string_array\`.
+                     */
+                    minLength?: number;
+                    /**
+                     * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
+                     * available for \`model_array\` input type.
+                     */
+                    modelTypes?: Array<'custom' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora'>;
+                    /**
+                     * Whether this input represents a parent asset to assign to the produced assets.
+                     * Only available for \`file\` and \`file_array\` input types.
+                     *
+                     * For \`file_array\`, the parent asset is the first item in the array.
+                     */
+                    parent?: boolean;
+                    /**
+                     * Placeholder text for the input. Only available for 'string' input type.
+                     */
+                    placeholder?: string;
+                    /**
+                     * Whether the input is a prompt. When true, displays as a text area with prompt
+                     * spark feature. Only available for \`string\` input type.
+                     */
+                    prompt?: boolean;
+                    /**
+                     * Whether the input is used with prompt spark. Only available for \`string\` input
+                     * type.
+                     */
+                    promptSpark?: boolean;
+                    /**
+                     * The reference to another input or output of the same workflow. Must have at
+                     * least one of node or conditional.
+                     */
+                    ref?: Input.Ref;
+                    /**
+                     * Set of rules that describes when this input is required:
+                     *
+                     * - \`always\`: Input is always required
+                     * - \`ifNotDefined\`: Input is required when another specified input is not
+                     *   defined
+                     * - \`ifDefined\`: Input is required when another specified input is defined
+                     * - \`conditionalValues\`: Input is required when another input has a specific
+                     *   value
+                     *
+                     * By default, the input is not required.
+                     */
+                    required?: Input.Required;
+                    /**
+                     * The step increment for numeric inputs. Only available for \`number\` input type.
+                     */
+                    step?: number;
+                }
+                namespace Input {
+                    /**
+                     * The reference to another input or output of the same workflow. Must have at
+                     * least one of node or conditional.
+                     */
+                    interface Ref {
+                        /**
+                         * The conditional nodes to reference. If the conditional nodes are successful, the
+                         * node will be successful. If the conditional nodes are skipped, the node will be
+                         * skipped. Contains an array of node ids used to check the status of the nodes.
+                         */
+                        conditional?: Array<string>;
+                        /**
+                         * This is the desired node output value if ref is an if/else node.
+                         */
+                        equal?: string;
+                        /**
+                         * The name of the input or output to reference. If the type is 'workflow', the
+                         * name is the name of the input of the workflow is required If the type is 'node',
+                         * the name is not mandatory, except if you want all outputs of the node. To get
+                         * all outputs of a node, you can use the name 'all'.
+                         */
+                        name?: string;
+                        /**
+                         * The node id or 'workflow' if the source is a workflow input.
+                         */
+                        node?: string;
+                    }
+                    /**
+                     * Set of rules that describes when this input is required:
+                     *
+                     * - \`always\`: Input is always required
+                     * - \`ifNotDefined\`: Input is required when another specified input is not
+                     *   defined
+                     * - \`ifDefined\`: Input is required when another specified input is defined
+                     * - \`conditionalValues\`: Input is required when another input has a specific
+                     *   value
+                     *
+                     * By default, the input is not required.
+                     */
+                    interface Required {
+                        /**
+                         * Whether the input is always required
+                         */
+                        always?: boolean;
+                        /**
+                         * Makes this input required when another input has a specific value:
+                         *
+                         * - Key: name of the input to check
+                         * - Value: operation and allowed values that trigger the requirement
+                         */
+                        conditionalValues?: unknown;
+                        /**
+                         * Makes this input required when another input is defined:
+                         *
+                         * - Key: name of the input that must be defined
+                         * - Value: message to display when this input is required
+                         */
+                        ifDefined?: unknown;
+                        /**
+                         * Makes this input required when another input is not defined:
+                         *
+                         * - Key: name of the input that must be undefined
+                         * - Value: message to display when this input is required
+                         */
+                        ifNotDefined?: unknown;
+                    }
+                }
+                /**
+                 * The logic of the node. Only available for logic nodes.
+                 */
+                interface Logic {
+                    /**
+                     * The cases of the logic. Only available for if/else nodes.
+                     */
+                    cases?: Array<Logic.Case>;
+                    /**
+                     * The default case of the logic. Contains the id/output of the node to execute if
+                     * no case is matched. Only available for if/else nodes.
+                     */
+                    default?: string;
+                    /**
+                     * The transform of the logic. Only available for transform nodes.
+                     */
+                    transform?: string;
+                }
+                namespace Logic {
+                    interface Case {
+                        condition: string;
+                        value: string;
+                    }
+                }
+            }
+        }
+        interface StatusHistory {
+            date: string;
+            status: 'canceled' | 'failure' | 'finalizing' | 'in-progress' | 'pending' | 'queued' | 'success' | 'warming-up';
+        }
+        /**
+         * The billing of the job
+         */
+        interface Billing {
+            cuCost: number;
+            cuDiscount: number;
+        }
+    }
+    interface Model {
+        /**
+         * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+         */
+        id: string;
+        /**
+         * List of model capabilities (example: ["txt2img", "img2img",
+         * "txt2img_ip_adapter", ...])
+         */
+        capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video2img' | 'video2video'>;
+        /**
+         * A list of CollectionId this model belongs to
+         */
+        collectionIds: Array<string>;
+        /**
+         * The model creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+         */
+        createdAt: string;
+        /**
+         * Whether the model is a custom model and can be used only with POST
+         * /generate/custom/{modelId} endpoint
+         */
+        custom: boolean;
+        /**
+         * List of all example asset IDs setup by the model owner
+         */
+        exampleAssetIds: Array<string>;
+        /**
+         * The privacy of the model (default: private)
+         */
+        privacy: 'private' | 'public' | 'unlisted';
+        /**
+         * The source of the model
+         */
+        source: 'civitai' | 'huggingface' | 'other' | 'scenario';
+        /**
+         * The model status
+         */
+        status: 'copying' | 'failed' | 'new' | 'trained' | 'training' | 'training-canceled';
+        /**
+         * The associated tags (example: ["sci-fi", "landscape"])
+         */
+        tags: Array<string>;
+        /**
+         * The total number of training images
+         */
+        trainingImagesNumber: number;
+        /**
+         * The model type (example: "flux.1-lora")
+         */
+        type: 'custom' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora';
+        /**
+         * The model last update date as an ISO string (example:
+         * "2023-02-03T11:19:41.579Z")
+         */
+        updatedAt: string;
+        /**
+         * The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
+         * 75: Team plan 100: Enterprise plan
+         */
+        accessRestrictions?: number;
+        /**
+         * The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
+         */
+        authorId?: string;
+        /**
+         * The class of the model
+         */
+        class?: Model.Class;
+        /**
+         * Compliance and regulatory metadata for the model
+         */
+        complianceMetadata?: Model.ComplianceMetadata;
+        /**
+         * List of base model IDs compliant with the model (example: ["flux.1-dev",
+         * "flux.1-schnell"]) This attribute is mainly used for Flux LoRA models
+         */
+        compliantModelIds?: Array<string>;
+        /**
+         * The concepts is required for the type model: composition
+         */
+        concepts?: Array<Model.Concept>;
+        /**
+         * The epoch of the model. Only available for Flux Lora Trained models. If not set,
+         * uses the final model epoch (latest)
+         */
+        epoch?: string;
+        /**
+         * The epochs of the model. Only available for Flux Lora Trained models.
+         */
+        epochs?: Array<Model.Epoch>;
+        /**
+         * The inputs of the model. Only used for custom models. To retrieve this list, get
+         * it by modelId with GET /models/{modelId}
+         */
+        inputs?: Array<Model.Input>;
+        /**
+         * The model keyword, this is a legacy parameter, please use conceptPrompt in
+         * parameters
+         */
+        modelKeyword?: string;
+        /**
+         * The model name (example: "Cinematic Realism")
+         */
+        name?: string;
+        /**
+         * Fine-tune the model's inferences with negative prompt embedding
+         */
+        negativePromptEmbedding?: string;
+        /**
+         * The owner ID (example: "team_VFhihHKMRZyDDnZAJwLb2Q")
+         */
+        ownerId?: string;
+        /**
+         * The parameters of the model
+         */
+        parameters?: Model.Parameters;
+        /**
+         * The id of the parent model
+         */
+        parentModelId?: string;
+        /**
+         * Fine-tune the model's inferences with prompt embedding
+         */
+        promptEmbedding?: string;
+        /**
+         * The model short description (example: "This model generates highly detailed
+         * cinematic scenes.")
+         */
+        shortDescription?: string;
+        /**
+         * The date when the model will be soft deleted (only for Free plan)
+         */
+        softDeletionOn?: string;
+        /**
+         * A thumbnail for your model
+         */
+        thumbnail?: Model.Thumbnail;
+        /**
+         * Array of training image pairs
+         */
+        trainingImagePairs?: Array<Model.TrainingImagePair>;
+        /**
+         * The URLs of the first 3 training images of the model. To retrieve the full set
+         * of images, get it by modelId
+         */
+        trainingImages?: Array<Model.TrainingImage>;
+        /**
+         * Additional information about the training progress of the model
+         */
+        trainingProgress?: Model.TrainingProgress;
+        /**
+         * Additional information about the model's training
+         */
+        trainingStats?: Model.TrainingStats;
+        /**
+         * The UI configuration for the model
+         */
+        uiConfig?: Model.UiConfig;
+        /**
+         * (Deprecated) The user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
+         */
+        userId?: string;
+    }
+    namespace Model {
+        /**
+         * The class of the model
+         */
+        interface Class {
+            /**
+             * The category slug of the class (example: "art-style")
+             */
+            category: string;
+            /**
+             * The concept prompt of the class (example: "a sks character design")
+             */
+            conceptPrompt: string;
+            /**
+             * The model ID of the class (example: "stable-diffusion-v1-5")
+             */
+            modelId: string;
+            /**
+             * The class name (example: "Character Design")
+             */
+            name: string;
+            /**
+             * The class prompt (example: "a character design")
+             */
+            prompt: string;
+            /**
+             * The class slug (example: "art-style-character-design")
+             */
+            slug: string;
+            /**
+             * The class status (only published classes are listed, but unpublished classes can
+             * still appear in existing models)
+             */
+            status: 'published' | 'unpublished';
+            /**
+             * Some example images URLs to showcase the class
+             */
+            thumbnails: Array<string>;
+        }
+        /**
+         * Compliance and regulatory metadata for the model
+         */
+        interface ComplianceMetadata {
+            /**
+             * Data processing comment (e.g., zeroRetention, temporaryRetention, etc.)
+             */
+            dataProcessingComment?: 'researchOnly' | 'serviceImprovement' | 'temporaryRetention' | 'zeroRetention';
+            /**
+             * URL to license terms
+             */
+            licenseTerms?: string;
+            /**
+             * The maintainer of the model
+             */
+            maintainer?: 'Fal' | 'Provider' | 'Replicate' | 'Scenario';
+            /**
+             * The provider of the model (examples: 'Google', 'AWS', 'BFL', 'Meshy', etc.)
+             */
+            modelProvider?: string;
+            /**
+             * The sub-processor used for the model
+             */
+            subProcessor?: 'AWS' | 'Fal' | 'Modal' | 'Provider' | 'Replicate';
+        }
+        interface Concept {
+            /**
+             * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+             */
+            modelId: string;
+            /**
+             * The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
+             * is between 0 and 2.
+             */
+            scale: number;
+            /**
+             * The epoch of the model (example: "000001") Only available for Flux Lora Trained
+             * models
+             */
+            modelEpoch?: string;
+        }
+        interface Epoch {
+            /**
+             * The epoch hash to identify the epoch
+             */
+            epoch: string;
+            /**
+             * The assets of the epoch if sample prompts as been supplied during training
+             */
+            assets?: Array<Epoch.Asset>;
+        }
+        namespace Epoch {
+            interface Asset {
+                /**
+                 * The AssetId of the image during training (example:
+                 * "asset_GTrL3mq4SXWyMxkOHRxlpw")
+                 */
+                assetId: string;
+                /**
+                 * The url of the asset
+                 */
+                url: string;
+            }
+        }
+        /**
+         * Defines the input parameters for a model. Use this to understand the available
+         * input parameters for a given `modelId` when calling
+         * `POST /generate/custom/{modelId}`. See {@link
+         * https://docs.scenario.com/docs/video-generation} for examples.
+         */
+        interface Input {
+            /**
+             * The name that must be user to call the model through the API
+             */
+            name: string;
+            /**
+             * The data type of the input
+             */
+            type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
+            /**
+             * The allowed values for the input. For \`string\` or \`number\` types, creates a
+             * single-select dropdown. For \`string_array\` type, creates a multi-select
+             * dropdown.
+             */
+            allowedValues?: Array<unknown>;
+            /**
+             * Specifies the background behavior for the input. Only available for \`file\` and
+             * \`file_array\` input types with kind \`image\`.
+             */
+            backgroundBehavior?: 'opaque' | 'transparent';
+            /**
+             * Whether the input is a color or not. Only available for \`string\` input type.
+             */
+            color?: boolean;
+            /**
+             * Whether this input affects the model's cost calculation
+             */
+            costImpact?: boolean;
+            /**
+             * Help text displayed in the UI to provide additional information about the input
+             */
+            description?: string;
+            /**
+             * Used to visually group inputs together in the UI. Inputs with the same group
+             * value appear consecutively in the UI.
+             */
+            group?: string;
+            /**
+             * Hint text displayed in the UI as a tooltip to guide the user
+             */
+            hint?: string;
+            /**
+             * The list of inputs which form an object within a container array. All inputs are
+             * the same as the current object. This is only available for type inputs_array
+             * inputs.
+             */
+            inputs?: Array<unknown>;
+            /**
+             * The asset kind of the input. Only taken into account for \`file\` and
+             * \`file_array\` input types.
+             */
+            kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+            /**
+             * The label displayed in the UI for this input
+             */
+            label?: string;
+            /**
+             * The name of the file input field to use as the mask source
+             */
+            maskFrom?: string;
+            /**
+             * The maximum allowed value. Only available for \`number\` and \`array\` input
+             * types.
+             */
+            max?: number;
+            /**
+             * The maximum allowed length for \`string\` inputs. Also applies to each item in
+             * \`string_array\`.
+             */
+            maxLength?: number;
+            /**
+             * The minimum allowed value. Only available for \`number\` and array input types.
+             */
+            min?: number;
+            /**
+             * The minimum allowed length for string inputs. Also applies to each item in
+             * \`string_array\`.
+             */
+            minLength?: number;
+            /**
+             * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
+             * available for \`model_array\` input type.
+             */
+            modelTypes?: Array<'custom' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora'>;
+            /**
+             * Whether this input represents a parent asset to assign to the produced assets.
+             * Only available for \`file\` and \`file_array\` input types.
+             *
+             * For \`file_array\`, the parent asset is the first item in the array.
+             */
+            parent?: boolean;
+            /**
+             * Placeholder text for the input. Only available for 'string' input type.
+             */
+            placeholder?: string;
+            /**
+             * Whether the input is a prompt. When true, displays as a text area with prompt
+             * spark feature. Only available for \`string\` input type.
+             */
+            prompt?: boolean;
+            /**
+             * Whether the input is used with prompt spark. Only available for \`string\` input
+             * type.
+             */
+            promptSpark?: boolean;
+            /**
+             * Set of rules that describes when this input is required:
+             *
+             * - \`always\`: Input is always required
+             * - \`ifNotDefined\`: Input is required when another specified input is not
+             *   defined
+             * - \`ifDefined\`: Input is required when another specified input is defined
+             * - \`conditionalValues\`: Input is required when another input has a specific
+             *   value
+             *
+             * By default, the input is not required.
+             */
+            required?: Input.Required;
+            /**
+             * The step increment for numeric inputs. Only available for \`number\` input type.
+             */
+            step?: number;
+        }
+        namespace Input {
+            /**
+             * Set of rules that describes when this input is required:
+             *
+             * - \`always\`: Input is always required
+             * - \`ifNotDefined\`: Input is required when another specified input is not
+             *   defined
+             * - \`ifDefined\`: Input is required when another specified input is defined
+             * - \`conditionalValues\`: Input is required when another input has a specific
+             *   value
+             *
+             * By default, the input is not required.
+             */
+            interface Required {
+                /**
+                 * Whether the input is always required
+                 */
+                always?: boolean;
+                /**
+                 * Makes this input required when another input has a specific value:
+                 *
+                 * - Key: name of the input to check
+                 * - Value: operation and allowed values that trigger the requirement
+                 */
+                conditionalValues?: unknown;
+                /**
+                 * Makes this input required when another input is defined:
+                 *
+                 * - Key: name of the input that must be defined
+                 * - Value: message to display when this input is required
+                 */
+                ifDefined?: unknown;
+                /**
+                 * Makes this input required when another input is not defined:
+                 *
+                 * - Key: name of the input that must be undefined
+                 * - Value: message to display when this input is required
+                 */
+                ifNotDefined?: unknown;
+            }
+        }
+        /**
+         * The parameters of the model
+         */
+        interface Parameters {
+            /**
+             * The batch size Less steps, and will increase the learning rate
+             *
+             * Only available for Flux LoRA training
+             */
+            batchSize?: number;
+            /**
+             * The prompt to specify images in the same class as provided instance images
+             *
+             * Only available for SD15 training
+             */
+            classPrompt?: string;
+            /**
+             * 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: ""
+             */
+            conceptPrompt?: string;
+            /**
+             * 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
+             */
+            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]
+             */
+            learningRateTextEncoder?: number;
+            /**
+             * Initial learning rate (after the potential warmup period) for the UNet
+             *
+             * Only available for SDXL LoRA training
+             */
+            learningRateUnet?: number;
+            /**
+             * The scheduler type to use (default: "constant")
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
+            /**
+             * 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;
+            /**
+             * The number of epochs to train for
+             *
+             * Only available for Flux LoRA training
+             */
+            nbEpochs?: number;
+            /**
+             * The number of times to repeat the training
+             *
+             * Only available for Flux LoRA training
+             */
+            nbRepeats?: number;
+            /**
+             * The number of training steps for the text encoder
+             *
+             * Only available for SDXL LoRA training
+             */
+            numTextTrainSteps?: number;
+            /**
+             * The number of training steps for the UNet
+             *
+             * Only available for SDXL LoRA training
+             */
+            numUNetTrainSteps?: number;
+            /**
+             * Optimize the model training task for a specific type of input images. The
+             * available values are:
+             *
+             * - "likeness": optimize training for likeness or portrait (targets specific
+             *   transformer blocks)
+             * - "all": train all transformer blocks
+             * - "none": train no specific transformer blocks
+             *
+             * This parameter controls which double and single transformer blocks are trained
+             * during the LoRA training process.
+             *
+             * Only available for Flux LoRA training
+             */
+            optimizeFor?: 'likeness';
+            /**
+             * The weight of prior preservation loss
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            priorLossWeight?: number;
+            /**
+             * Whether to random crop or center crop images before resizing to the working
+             * resolution
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            randomCrop?: boolean;
+            /**
+             * Ratio of random crops
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            randomCropRatio?: number;
+            /**
+             * Scale of random crops
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            randomCropScale?: number;
+            /**
+             * The dimension of the LoRA update matrices
+             *
+             * Only available for SDXL and Flux LoRA training
+             *
+             * Default value varies depending on the model type:
+             *
+             * - For SDXL: 64
+             * - For Flux: 16
+             */
+            rank?: number;
+            /**
+             * The prompts to use for each epoch Only available for Flux LoRA training
+             */
+            samplePrompts?: Array<string>;
+            /**
+             * The sample prompt images (AssetIds) paired with samplePrompts Only available for
+             * Flux LoRA training Must be the same length as samplePrompts
+             */
+            sampleSourceImages?: Array<string>;
+            /**
+             * Whether to scale the learning rate
+             *
+             * Note: Legacy parameter, will be ignored
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            scaleLr?: boolean;
+            /**
+             * Used to reproduce previous results. Default: randomly generated number.
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            seed?: number;
+            /**
+             * Whether to train the text encoder or not
+             *
+             * Example: For 100 steps and a value of 0.2, it means that the text encoder will
+             * be trained for 20 steps and then the UNet for 80 steps
+             *
+             * Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            textEncoderTrainingRatio?: number;
+            /**
+             * Validation frequency. Cannot be greater than maxTrainSteps value
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            validationFrequency?: number;
+            /**
+             * Validation prompt
+             *
+             * Only available for SD15 and SDXL LoRA training
+             */
+            validationPrompt?: string;
+            /**
+             * The Weights And Bias key to use for logging. The maximum length is 40 characters
+             */
+            wandbKey?: string;
+        }
+        /**
+         * A thumbnail for your model
+         */
+        interface Thumbnail {
+            /**
+             * The AssetId of the image used as a thumbnail for your model (example:
+             * "asset_GTrL3mq4SXWyMxkOHRxlpw")
+             */
+            assetId: string;
+            /**
+             * The url of the image used as a thumbnail for your model
+             */
+            url: string;
+        }
+        interface TrainingImagePair {
+            /**
+             * The instruction for the image pair, source to target
+             */
+            instruction?: string;
+            /**
+             * The source asset ID (must be a training asset)
+             */
+            sourceId?: string;
+            /**
+             * The target asset ID (must be a training asset)
+             */
+            targetId?: string;
+        }
+        interface TrainingImage {
+            /**
+             * The training image ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+             */
+            id: string;
+            /**
+             * Automatic captioning of the image
+             */
+            automaticCaptioning: string;
+            /**
+             * The training image upload date as an ISO string (example:
+             * "2023-02-03T11:19:41.579Z")
+             */
+            createdAt: string;
+            /**
+             * Description for the image
+             */
+            description: string;
+            /**
+             * The URL of the image
+             */
+            downloadUrl: string;
+            /**
+             * The original file name of the image (example: "my-training-image.jpg")
+             */
+            name: string;
+        }
+        /**
+         * Additional information about the training progress of the model
+         */
+        interface TrainingProgress {
+            /**
+             * The stage of the request
+             */
+            stage: 'pending' | 'queued-for-train' | 'running-train' | 'starting-train';
+            /**
+             * Timestamp in milliseconds of the last time the training progress was updated
+             */
+            updatedAt: number;
+            /**
+             * Position of the job in the queue (ie. the number of job in the queue before this
+             * one)
+             */
+            position?: number;
+            /**
+             * The progress of the job
+             */
+            progress?: number;
+            /**
+             * The remaining time in milliseconds
+             */
+            remainingTimeMs?: number;
+            /**
+             * The timestamp in millisecond marking the start of the process
+             */
+            startedAt?: number;
+        }
+        /**
+         * Additional information about the model's training
+         */
+        interface TrainingStats {
+            /**
+             * The training end time as an ISO date string
+             */
+            endedAt?: string;
+            /**
+             * The training queued duration in seconds
+             */
+            queueDuration?: number;
+            /**
+             * The training start time as an ISO date string
+             */
+            startedAt?: string;
+            /**
+             * The training duration in seconds
+             */
+            trainDuration?: number;
+        }
+        /**
+         * The UI configuration for the model
+         */
+        interface UiConfig {
+            /**
+             * Configuration for the input properties
+             */
+            inputProperties?: {
+                [key: string]: UiConfig.InputProperties;
+            };
+            /**
+             * Configuration for the loras component
+             */
+            lorasComponent?: UiConfig.LorasComponent;
+            /**
+             * Configuration for the presets
+             */
+            presets?: Array<UiConfig.Preset>;
+            /**
+             * Configuration for the resolution component
+             */
+            resolutionComponent?: UiConfig.ResolutionComponent;
+            /**
+             * Configuration for the selects
+             */
+            selects?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Configuration for the trigger generate button
+             */
+            triggerGenerate?: UiConfig.TriggerGenerate;
+        }
+        namespace UiConfig {
+            interface InputProperties {
+                collapsed?: boolean;
+            }
+            /**
+             * Configuration for the loras component
+             */
+            interface LorasComponent {
+                /**
+                 * The label of the component
+                 */
+                label: string;
+                /**
+                 * The input name of the model (model_array)
+                 */
+                modelInput: string;
+                /**
+                 * The input name of the scale (number_array)
+                 */
+                scaleInput: string;
+                /**
+                 * The input model id (example: a composition or a single LoRA modelId) If
+                 * specified, the model id will be attached to the output asset as a metadata If
+                 * the model-decomposer parser is specified on it, modelInput and scaleInput will
+                 * be automatically populated
+                 */
+                modelIdInput?: string;
+            }
+            interface Preset {
+                fields: Array<string>;
+                presets: unknown;
+            }
+            /**
+             * Configuration for the resolution component
+             */
+            interface ResolutionComponent {
+                /**
+                 * The input name of the height
+                 */
+                heightInput: string;
+                /**
+                 * The label of the component
+                 */
+                label: string;
+                /**
+                 * The resolution presets
+                 */
+                presets: Array<ResolutionComponent.Preset>;
+                /**
+                 * The input name of the width
+                 */
+                widthInput: string;
+            }
+            namespace ResolutionComponent {
+                interface Preset {
+                    height: number;
+                    label: string;
+                    width: number;
+                }
+            }
+            /**
+             * Configuration for the trigger generate button
+             */
+            interface TriggerGenerate {
+                label: string;
+                /**
+                 * The 'name' of the input where the trigger generate button will be displayed
+                 * (after the input). Do not specify both position and after.
+                 */
+                after?: string;
+                /**
+                 * The position of the trigger generate button. If position specified, the button
+                 * will be displayed at the specified position. Do not specify both position and
+                 * after.
+                 */
+                position?: 'bottom' | 'top';
+            }
+        }
+    }
+}
+export interface TrainActionParams {
+    /**
+     * The action to perform on the model training
+     */
+    action: 'cancel';
+}
+export interface TrainTriggerParams {
+    /**
+     * Query param
+     */
+    dryRun?: string;
+    /**
+     * Query param: If set to true, returns the original asset without transformation
+     */
+    originalAssets?: string;
+    /**
+     * Body param
+     */
+    parameters?: TrainTriggerParams.Parameters;
+}
+export declare namespace TrainTriggerParams {
+    interface Parameters {
+        /**
+         * The batch size Less steps, and will increase the learning rate
+         *
+         * Only available for Flux LoRA training
+         */
+        batchSize?: number;
+        /**
+         * The prompt to specify images in the same class as provided instance images
+         *
+         * Only available for SD15 training
+         */
+        classPrompt?: string;
+        /**
+         * 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: ""
+         */
+        conceptPrompt?: string;
+        /**
+         * 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
+         */
+        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]
+         */
+        learningRateTextEncoder?: number;
+        /**
+         * Initial learning rate (after the potential warmup period) for the UNet
+         *
+         * Only available for SDXL LoRA training
+         */
+        learningRateUnet?: number;
+        /**
+         * The scheduler type to use (default: "constant")
+         *
+         * Only available for SD15 and SDXL LoRA training
+         */
+        lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
+        /**
+         * 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;
+        /**
+         * The number of epochs to train for
+         *
+         * Only available for Flux LoRA training
+         */
+        nbEpochs?: number;
+        /**
+         * The number of times to repeat the training
+         *
+         * Only available for Flux LoRA training
+         */
+        nbRepeats?: number;
+        /**
+         * The number of training steps for the text encoder
+         *
+         * Only available for SDXL LoRA training
+         */
+        numTextTrainSteps?: number;
+        /**
+         * The number of training steps for the UNet
+         *
+         * Only available for SDXL LoRA training
+         */
+        numUNetTrainSteps?: number;
+        /**
+         * Optimize the model training task for a specific type of input images. The
+         * available values are:
+         *
+         * - "likeness": optimize training for likeness or portrait (targets specific
+         *   transformer blocks)
+         * - "all": train all transformer blocks
+         * - "none": train no specific transformer blocks
+         *
+         * This parameter controls which double and single transformer blocks are trained
+         * during the LoRA training process.
+         *
+         * Only available for Flux LoRA training
+         */
+        optimizeFor?: 'likeness';
+        /**
+         * The weight of prior preservation loss
+         *
+         * Only available for SD15 and SDXL LoRA training
+         */
+        priorLossWeight?: number;
+        /**
+         * Whether to random crop or center crop images before resizing to the working
+         * resolution
+         *
+         * Only available for SD15 and SDXL LoRA training
+         */
+        randomCrop?: boolean;
+        /**
+         * Ratio of random crops
+         *
+         * Only available for SD15 and SDXL LoRA training
+         */
+        randomCropRatio?: number;
+        /**
+         * Scale of random crops
+         *
+         * Only available for SD15 and SDXL LoRA training
+         */
+        randomCropScale?: number;
+        /**
+         * The dimension of the LoRA update matrices
+         *
+         * Only available for SDXL and Flux LoRA training
+         *
+         * Default value varies depending on the model type:
+         *
+         * - For SDXL: 64
+         * - For Flux: 16
+         */
+        rank?: number;
+        /**
+         * The prompts to use for each epoch Only available for Flux LoRA training
+         */
+        samplePrompts?: Array<string>;
+        /**
+         * The sample prompt images (AssetIds) paired with samplePrompts Only available for
+         * Flux LoRA training Must be the same length as samplePrompts
+         */
+        sampleSourceImages?: Array<string>;
+        /**
+         * Whether to scale the learning rate
+         *
+         * Note: Legacy parameter, will be ignored
+         *
+         * Only available for SD15 and SDXL LoRA training
+         */
+        scaleLr?: boolean;
+        /**
+         * Used to reproduce previous results. Default: randomly generated number.
+         *
+         * Only available for SD15 and SDXL LoRA training
+         */
+        seed?: number;
+        /**
+         * Whether to train the text encoder or not
+         *
+         * Example: For 100 steps and a value of 0.2, it means that the text encoder will
+         * be trained for 20 steps and then the UNet for 80 steps
+         *
+         * Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
+         *
+         * Only available for SD15 and SDXL LoRA training
+         */
+        textEncoderTrainingRatio?: number;
+        /**
+         * Validation frequency. Cannot be greater than maxTrainSteps value
+         *
+         * Only available for SD15 and SDXL LoRA training
+         */
+        validationFrequency?: number;
+        /**
+         * Validation prompt
+         *
+         * Only available for SD15 and SDXL LoRA training
+         */
+        validationPrompt?: string;
+        /**
+         * The Weights And Bias key to use for logging. The maximum length is 40 characters
+         */
+        wandbKey?: string;
+    }
+}
+export declare namespace Train {
+    export { type TrainActionResponse as TrainActionResponse, type TrainTriggerResponse as TrainTriggerResponse, type TrainActionParams as TrainActionParams, type TrainTriggerParams as TrainTriggerParams, };
+}
+//# sourceMappingURL=train.d.mts.map