@scenario-labs/sdk 3.2.0 → 3.3.0

package/resources/recommendations.d.ts

@@ -0,0 +1,1107 @@
+import { APIResource } from "../core/resource.js";
+import { PagePromise, RecommendationsCursor, type RecommendationsCursorParams } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Recommendations extends APIResource {
+    /**
+     * List recommended models matching the given filters
+     */
+    listModels(query?: RecommendationListModelsParams | null | undefined, options?: RequestOptions): PagePromise<RecommendationListModelsResponsesRecommendationsCursor, RecommendationListModelsResponse>;
+}
+export type RecommendationListModelsResponsesRecommendationsCursor = RecommendationsCursor<RecommendationListModelsResponse>;
+export interface RecommendationListModelsResponse {
+    /**
+     * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+     */
+    id: string;
+    /**
+     * List of model capabilities (example: ["txt2img", "img2img",
+     * "txt2img_ip_adapter", ...])
+     */
+    capabilities: Array<'3d23d' | 'audio2audio' | 'audio2txt' | 'audio2video' | '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' | 'video23d' | 'video2audio' | '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' | 'elevenlabs-voice' | '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' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-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: Starter plan 50: Pro plan
+     * 75: Max plan 100: Enterprise plan
+     */
+    accessRestrictions?: 0 | 100 | 25 | 50 | 75;
+    /**
+     * The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
+     */
+    authorId?: string;
+    /**
+     * The class of the model
+     */
+    class?: RecommendationListModelsResponse.Class;
+    /**
+     * 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<RecommendationListModelsResponse.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)
+     */
+    epoch?: string;
+    /**
+     * The epochs of the model. Only available for Flux Lora Trained models.
+     */
+    epochs?: Array<RecommendationListModelsResponse.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<RecommendationListModelsResponse.Input>;
+    /**
+     * The ID of the job that trained the model, returned to the model owner only
+     * (example: "job_ocZCnG1Df35XRL1QyCZSRxAG8")
+     */
+    jobId?: string;
+    /**
+     * 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?: RecommendationListModelsResponse.Parameters;
+    /**
+     * The id of the parent model
+     */
+    parentModelId?: string;
+    /**
+     * Aggregated performance stats
+     */
+    performanceStats?: RecommendationListModelsResponse.PerformanceStats;
+    /**
+     * 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?: RecommendationListModelsResponse.Thumbnail;
+    /**
+     * Array of training image pairs
+     */
+    trainingImagePairs?: Array<RecommendationListModelsResponse.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<RecommendationListModelsResponse.TrainingImage>;
+    /**
+     * Additional information about the training progress of the model
+     */
+    trainingProgress?: RecommendationListModelsResponse.TrainingProgress;
+    /**
+     * Additional information about the model's training
+     */
+    trainingStats?: RecommendationListModelsResponse.TrainingStats;
+    /**
+     * The UI configuration for the model
+     */
+    uiConfig?: RecommendationListModelsResponse.UiConfig;
+    /**
+     * (Deprecated) The user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
+     */
+    userId?: string;
+}
+export declare namespace RecommendationListModelsResponse {
+    /**
+     * 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. Only available for legacy models.
+         */
+        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>;
+    }
+    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/get-started/generation/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;
+        /**
+         * The default value for the input
+         */
+        default?: unknown;
+        /**
+         * 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<{
+            [key: string]: unknown;
+        }>;
+        /**
+         * The asset kind of the input. Only taken into account for \`file\` and
+         * \`file_array\` input types. If model provides multiple kinds, the input will be
+         * not able to create the asset on the flight on API side with dataurl without
+         * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+         * a model does not declare one, \`image\` is returned, which is the kind used at
+         * generation time.
+         */
+        kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | '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 media duration in seconds. Only applies to \`file\` and
+         * \`file_array\` input types for video and audio assets. Validated against
+         * \`asset.properties.duration\` at job creation time.
+         */
+        maxDuration?: number;
+        /**
+         * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+         * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+         * ITEMS instead — the length of each item is not constrained.
+         */
+        maxLength?: number;
+        /**
+         * The maximum allowed file size in bytes. Only applies to \`file\` and
+         * \`file_array\` input types. Validated against \`asset.properties.size\` at job
+         * creation time.
+         */
+        maxSize?: number;
+        /**
+         * The minimum allowed value. Only available for \`number\` and array input types.
+         */
+        min?: number;
+        /**
+         * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+         * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+         * ITEMS instead — the length of each item is not constrained.
+         */
+        minLength?: number;
+        /**
+         * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
+         * available for \`model_array\` input type.
+         */
+        modelTypes?: Array<'custom' | 'elevenlabs-voice' | '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' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-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
+         * - \`conditional\`: Input is required when other inputs have specific values
+         *
+         * 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
+         * - \`conditional\`: Input is required when other inputs have specific values
+         *
+         * By default, the input is not required.
+         */
+        interface Required {
+            /**
+             * Whether the input is always required
+             */
+            always?: boolean;
+            /**
+             * Makes this input required when other inputs have one of the listed values
+             */
+            conditional?: Required.Conditional;
+            /**
+             * 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;
+        }
+        namespace Required {
+            /**
+             * Makes this input required when other inputs have one of the listed values
+             */
+            interface Conditional {
+                /**
+                 * The conditions to check:
+                 *
+                 * - Key: name of the input to check
+                 * - Value: values of that input that satisfy the condition
+                 */
+                values: unknown;
+                /**
+                 * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
+                 */
+                operator?: 'and' | 'or';
+            }
+        }
+    }
+    /**
+     * The parameters of the model
+     */
+    interface Parameters {
+        /**
+         * Age group of the voice (for professional cloning)
+         *
+         * Only available for ElevenLabs voice training
+         */
+        age?: string;
+        /**
+         * 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
+         *
+         * Deprecated legacy training parameter.
+         */
+        classPrompt?: string;
+        /**
+         * Type of voice cloning: "instant" (fast) or "professional" (higher quality,
+         * requires captcha)
+         *
+         * Only available for ElevenLabs voice training
+         */
+        cloneType?: 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 Flux LoRA, the default is
+         * an empty string.
+         */
+        conceptPrompt?: string;
+        /**
+         * Gender of the voice (for professional cloning)
+         *
+         * Only available for ElevenLabs voice training
+         */
+        gender?: string;
+        /**
+         * Language of the audio samples (ISO 639-1 code)
+         *
+         * Only available for ElevenLabs voice training
+         */
+        language?: string;
+        /**
+         * Initial learning rate (after the potential warmup period)
+         *
+         * 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 [Flux LoRA: 0.00001] Minimum [Flux LoRA:
+         * 0.000001]
+         */
+        learningRateTextEncoder?: number;
+        /**
+         * Initial learning rate (after the potential warmup period) for the UNet
+         *
+         * Deprecated legacy training parameter.
+         */
+        learningRateUnet?: number;
+        /**
+         * The scheduler type to use (default: "constant")
+         *
+         * Deprecated legacy training parameter.
+         */
+        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)
+         *
+         * Default value varies depending on the model type:
+         *
+         * - For Flux: number of training images \* 100
+         *
+         * Maximum value varies depending on the model type:
+         *
+         * - 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
+         *
+         * Deprecated legacy training parameter.
+         */
+        numTextTrainSteps?: number;
+        /**
+         * The number of training steps for the UNet
+         *
+         * Deprecated legacy training parameter.
+         */
+        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
+         *
+         * Deprecated legacy training parameter.
+         */
+        priorLossWeight?: number;
+        /**
+         * Whether to random crop or center crop images before resizing to the working
+         * resolution
+         *
+         * Deprecated legacy training parameter.
+         */
+        randomCrop?: boolean;
+        /**
+         * Ratio of random crops
+         *
+         * Deprecated legacy training parameter.
+         */
+        randomCropRatio?: number;
+        /**
+         * Scale of random crops
+         *
+         * Deprecated legacy training parameter.
+         */
+        randomCropScale?: number;
+        /**
+         * The dimension of the LoRA update matrices
+         *
+         * Only available for Flux LoRA and Musubi training
+         *
+         * Default value varies depending on the model type:
+         *
+         * - For Flux: 16
+         * - For Musubi: 64
+         *
+         * Each trainer enforces its own tighter limit (Flux LoRA: [2; 64], Musubi: [2;
+         * 128])
+         */
+        rank?: number;
+        /**
+         * Whether to remove background noise from audio samples before cloning. When
+         * enabled, each sample must be at least 5 seconds long.
+         *
+         * Only available for ElevenLabs voice training
+         */
+        removeBackgroundNoise?: boolean;
+        /**
+         * 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
+         *
+         * Deprecated legacy training parameter.
+         */
+        scaleLr?: boolean;
+        /**
+         * Used to reproduce previous results. Default: randomly generated number.
+         *
+         * Deprecated legacy training parameter.
+         */
+        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`
+         *
+         * Deprecated legacy training parameter.
+         */
+        textEncoderTrainingRatio?: number;
+        /**
+         * Validation frequency. Cannot be greater than maxTrainSteps value
+         *
+         * Deprecated legacy training parameter.
+         */
+        validationFrequency?: number;
+        /**
+         * Validation prompt
+         *
+         * Deprecated legacy training parameter.
+         */
+        validationPrompt?: string;
+        /**
+         * Description of the voice characteristics
+         *
+         * Only available for ElevenLabs voice training
+         */
+        voiceDescription?: string;
+        /**
+         * The Weights And Bias key to use for logging. The maximum length is 40 characters
+         */
+        wandbKey?: string;
+    }
+    /**
+     * Aggregated performance stats
+     */
+    interface PerformanceStats {
+        /**
+         * Performance metrics per variant
+         */
+        variants: Array<PerformanceStats.Variant>;
+        /**
+         * Default variant key for quick model comparison
+         */
+        default?: string;
+    }
+    namespace PerformanceStats {
+        /**
+         * Performance stats for a model variant
+         */
+        interface Variant {
+            /**
+             * The generation capability (example: "txt2img", "img2video", "txt2audio")
+             */
+            capability: string;
+            /**
+             * When these stats were last computed (ISO date)
+             */
+            computedAt: string;
+            /**
+             * Unique variant identifier (example: "txt2img:1K", "img2video:2K", "txt2audio")
+             */
+            variantKey: string;
+            /**
+             * External quality score from arena.ai leaderboard
+             */
+            arenaScore?: Variant.ArenaScore;
+            /**
+             * Maximum cost per output asset (CU)
+             */
+            costPerAssetMaxCU?: number;
+            /**
+             * Minimum cost per output asset (CU)
+             */
+            costPerAssetMinCU?: number;
+            /**
+             * Median cost per output asset (CU)
+             */
+            costPerAssetP50CU?: number;
+            /**
+             * Inference latency P50 per output asset (seconds)
+             */
+            inferenceLatencyP50Sec?: number;
+            /**
+             * Inference latency P75 per output asset (seconds)
+             */
+            inferenceLatencyP75Sec?: number;
+            /**
+             * The resolution bucket (example: "0.5K", "1K", "2K", "4K")
+             */
+            resolution?: string;
+            /**
+             * Total latency P50 per output asset, including queue time (seconds)
+             */
+            totalLatencyP50Sec?: number;
+            /**
+             * Total latency P75 per output asset, including queue time (seconds)
+             */
+            totalLatencyP75Sec?: number;
+        }
+        namespace Variant {
+            /**
+             * External quality score from arena.ai leaderboard
+             */
+            interface ArenaScore {
+                /**
+                 * Arena category (example: "text_to_image", "image_to_video")
+                 */
+                arenaCategory: string;
+                /**
+                 * Model name on arena.ai
+                 */
+                arenaModelName: string;
+                /**
+                 * When this score was last fetched (ISO date)
+                 */
+                fetchedAt: string;
+                /**
+                 * Rank in the arena category
+                 */
+                rank: number;
+                /**
+                 * ELO rating
+                 */
+                rating: number;
+                /**
+                 * ELO rating confidence interval lower bound
+                 */
+                ratingLower: number;
+                /**
+                 * ELO rating confidence interval upper bound
+                 */
+                ratingUpper: number;
+                /**
+                 * Number of human votes
+                 */
+                votes: number;
+            }
+        }
+    }
+    /**
+     * 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' | 'pending-captcha' | 'queued-for-train' | 'ready-for-captcha' | 'running-train' | 'starting-train';
+        /**
+         * Timestamp in milliseconds of the last time the training progress was updated
+         */
+        updatedAt: number;
+        /**
+         * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+         * present when stage === 'pending-captcha'. Overwritten on each retry.
+         */
+        captchaImageUrl?: string;
+        /**
+         * 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;
+        /**
+         * Last recoverable failure message during PVC. Present when the model has bounced
+         * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+         * captcha rejected, time limit exceeded). Surface above the retry button so the
+         * user understands why they're back here.
+         */
+        retryableError?: string;
+        /**
+         * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+         * model is marked Failed when this reaches the platform's max retries.
+         */
+        retryCount?: 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 provider outputs exposed by `exposeOutput`
+         */
+        outputProperties?: {
+            [key: string]: UiConfig.OutputProperties;
+        };
+        /**
+         * 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 OutputProperties {
+            label: 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 RecommendationListModelsParams extends RecommendationsCursorParams {
+    /**
+     * Filter models by capabilities. Multiple values comma-separated. Can be any of
+     * the following values: txt2img, txt2img_ip_adapter, txt2img_texture, img2img,
+     * img2img_ip_adapter, img2img_texture, inpaint, outpaint, inpaint_ip_adapter,
+     * controlnet, controlnet_ip_adapter, reference, reference_texture,
+     * controlnet_reference, controlnet_img2img, controlnet_inpaint,
+     * controlnet_inpaint_ip_adapter, controlnet_texture, img23d, txt23d, video23d,
+     * 3d23d, img2video, txt2video, video2video, video2img, txt2audio, audio2audio,
+     * audio2video, video2audio, txt2txt, img2txt, audio2txt. Examples: `txt2img`,
+     * `img2img`. Also accepts prefixes or suffixes values such as `txt2`, `img2`,
+     * `inpaint`, `control`. Default: no filter
+     */
+    capabilities?: Array<'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'inpaint' | 'outpaint' | 'inpaint_ip_adapter' | 'controlnet' | 'controlnet_ip_adapter' | 'reference' | 'reference_texture' | 'controlnet_reference' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_texture' | 'img23d' | 'txt23d' | 'video23d' | '3d23d' | 'img2video' | 'txt2video' | 'video2video' | 'video2img' | 'txt2audio' | 'audio2audio' | 'audio2video' | 'video2audio' | 'txt2txt' | 'img2txt' | 'audio2txt'>;
+    /**
+     * Exclude specific models by their IDs. Multiple IDs comma-separated. Example:
+     * `model1,model2,model3`. Default: no exclusions
+     */
+    excludeModelIds?: string;
+    /**
+     * Exclude models by type. Multiple types comma-separated. Example:
+     * `flux.1,flux.1-lora`. Default: no exclusions
+     */
+    excludeTypes?: string;
+    /**
+     * The maximum number of models to return. Default: `10`, Maximum: `30`
+     */
+    limit?: number;
+    /**
+     * If set to true, returns the original asset without transformation
+     */
+    originalAssets?: boolean;
+    /**
+     * Filter models by privacy level. Default: `private`. Values: `private`, `public`
+     */
+    privacy?: 'private' | 'public';
+    /**
+     * The projectId used for ownership resource management. Either to assert ownership
+     * or to set the owner of the resource(s)
+     */
+    projectId?: string;
+    /**
+     * Filter models by tags. Multiple tags comma-separated. Example:
+     * `anime,portrait,style`. Default: no filter
+     */
+    tags?: string;
+    /**
+     * Filter models by type. Examples: `flux.1`, `flux.1-lora`, etc. Default: no
+     * filter
+     */
+    type?: 'flux.1' | 'flux.1-lora' | 'flux.1-kontext-dev' | 'flux.1-krea-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-lora' | 'flux.1-composition' | 'flux.1-pro' | 'flux1.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-lora' | 'flux.2-dev-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-9b-edit-lora' | 'gpt-image-1' | 'qwen-image-lora' | 'qwen-image-2512-lora' | 'qwen-image-edit-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'zimage-lora' | 'zimage-turbo-lora' | 'zimage-de-turbo-lora' | 'custom' | 'elevenlabs-voice';
+}
+export declare namespace Recommendations {
+    export { type RecommendationListModelsResponse as RecommendationListModelsResponse, type RecommendationListModelsResponsesRecommendationsCursor as RecommendationListModelsResponsesRecommendationsCursor, type RecommendationListModelsParams as RecommendationListModelsParams, };
+}
+//# sourceMappingURL=recommendations.d.ts.map