@scenario-labs/sdk 3.1.0 → 3.3.0

package/resources/models/models.d.ts

@@ -3,6 +3,12 @@ import * as DescriptionAPI from "./description.js";
 import { Description, DescriptionRetrieveParams, DescriptionRetrieveResponse, DescriptionUpdateParams, DescriptionUpdateResponse } from "./description.js";
 import * as ExamplesAPI from "./examples.js";
 import { ExampleListParams, ExampleListResponse, ExampleUpdateParams, ExampleUpdateResponse, Examples } from "./examples.js";
+import * as PresetsAPI from "./presets.js";
+import { PresetCreateParams, PresetCreateResponse, PresetDeleteParams, PresetDeleteResponse, PresetListParams, PresetListResponse, PresetUpdateParams, PresetUpdateResponse, Presets } from "./presets.js";
+import * as PromptGuideAPI from "./prompt-guide.js";
+import { PromptGuide, PromptGuideRetrieveParams, PromptGuideRetrieveResponse, PromptGuideUpdateParams, PromptGuideUpdateResponse } from "./prompt-guide.js";
+import * as ScoresAPI from "./scores.js";
+import { ScoreRetrievePromptParams, ScoreRetrievePromptResponse, ScoreRetrieveTrainingDatasetParams, ScoreRetrieveTrainingDatasetResponse, Scores } from "./scores.js";
 import * as TrainAPI from "./train.js";
 import { Train, TrainActionParams, TrainActionResponse, TrainTriggerParams, TrainTriggerResponse } from "./train.js";
 import * as TrainingImagesAPI from "./training-images.js";
@@ -13,6 +19,9 @@ import { RequestOptions } from "../../internal/request-options.js";
 export declare class Models extends APIResource {
     description: DescriptionAPI.Description;
     examples: ExamplesAPI.Examples;
+    presets: PresetsAPI.Presets;
+    promptGuide: PromptGuideAPI.PromptGuide;
+    scores: ScoresAPI.Scores;
     train: TrainAPI.Train;
     trainingImages: TrainingImagesAPI.TrainingImages;
     /**
@@ -128,8 +137,8 @@ export declare namespace ModelCreateResponse {
          */
         updatedAt: string;
         /**
-         * The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
-         * 75: Team plan 100: Enterprise plan
+         * 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;
         /**
@@ -169,6 +178,11 @@ export declare namespace ModelCreateResponse {
          * it by modelId with GET /models/{modelId}
          */
         inputs?: Array<Model.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
@@ -382,7 +396,9 @@ export declare namespace ModelCreateResponse {
              * 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
+             * 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';
             /**
@@ -405,8 +421,9 @@ export declare namespace ModelCreateResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -420,8 +437,9 @@ export declare namespace ModelCreateResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -457,8 +475,7 @@ export declare namespace ModelCreateResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -476,8 +493,7 @@ export declare namespace ModelCreateResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -487,12 +503,9 @@ export declare namespace ModelCreateResponse {
                  */
                 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
+                 * Makes this input required when other inputs have one of the listed values
                  */
-                conditionalValues?: unknown;
+                conditional?: Required.Conditional;
                 /**
                  * Makes this input required when another input is defined:
                  *
@@ -508,6 +521,24 @@ export declare namespace ModelCreateResponse {
                  */
                 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
@@ -983,6 +1014,12 @@ export declare namespace ModelCreateResponse {
              * 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
              */
@@ -1030,6 +1067,9 @@ export declare namespace ModelCreateResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -1143,8 +1183,8 @@ export declare namespace ModelRetrieveResponse {
          */
         updatedAt: string;
         /**
-         * The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
-         * 75: Team plan 100: Enterprise plan
+         * 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;
         /**
@@ -1184,6 +1224,11 @@ export declare namespace ModelRetrieveResponse {
          * it by modelId with GET /models/{modelId}
          */
         inputs?: Array<Model.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
@@ -1397,7 +1442,9 @@ export declare namespace ModelRetrieveResponse {
              * 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
+             * 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';
             /**
@@ -1420,8 +1467,9 @@ export declare namespace ModelRetrieveResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -1435,8 +1483,9 @@ export declare namespace ModelRetrieveResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -1472,8 +1521,7 @@ export declare namespace ModelRetrieveResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -1491,8 +1539,7 @@ export declare namespace ModelRetrieveResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -1502,12 +1549,9 @@ export declare namespace ModelRetrieveResponse {
                  */
                 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
+                 * Makes this input required when other inputs have one of the listed values
                  */
-                conditionalValues?: unknown;
+                conditional?: Required.Conditional;
                 /**
                  * Makes this input required when another input is defined:
                  *
@@ -1523,6 +1567,24 @@ export declare namespace ModelRetrieveResponse {
                  */
                 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
@@ -1998,6 +2060,12 @@ export declare namespace ModelRetrieveResponse {
              * 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
              */
@@ -2045,6 +2113,9 @@ export declare namespace ModelRetrieveResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -2158,8 +2229,8 @@ export declare namespace ModelUpdateResponse {
          */
         updatedAt: string;
         /**
-         * The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
-         * 75: Team plan 100: Enterprise plan
+         * 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;
         /**
@@ -2199,6 +2270,11 @@ export declare namespace ModelUpdateResponse {
          * it by modelId with GET /models/{modelId}
          */
         inputs?: Array<Model.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
@@ -2412,7 +2488,9 @@ export declare namespace ModelUpdateResponse {
              * 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
+             * 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';
             /**
@@ -2435,8 +2513,9 @@ export declare namespace ModelUpdateResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -2450,8 +2529,9 @@ export declare namespace ModelUpdateResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -2487,8 +2567,7 @@ export declare namespace ModelUpdateResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -2506,8 +2585,7 @@ export declare namespace ModelUpdateResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -2517,12 +2595,9 @@ export declare namespace ModelUpdateResponse {
                  */
                 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
+                 * Makes this input required when other inputs have one of the listed values
                  */
-                conditionalValues?: unknown;
+                conditional?: Required.Conditional;
                 /**
                  * Makes this input required when another input is defined:
                  *
@@ -2538,6 +2613,24 @@ export declare namespace ModelUpdateResponse {
                  */
                 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
@@ -3013,6 +3106,12 @@ export declare namespace ModelUpdateResponse {
              * 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
              */
@@ -3060,6 +3159,9 @@ export declare namespace ModelUpdateResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -3169,8 +3271,8 @@ export interface ModelListResponse {
      */
     updatedAt: string;
     /**
-     * The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
-     * 75: Team plan 100: Enterprise plan
+     * 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;
     /**
@@ -3210,6 +3312,11 @@ export interface ModelListResponse {
      * it by modelId with GET /models/{modelId}
      */
     inputs?: Array<ModelListResponse.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
@@ -3423,7 +3530,9 @@ export declare namespace ModelListResponse {
          * 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
+         * 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';
         /**
@@ -3446,8 +3555,9 @@ export declare namespace ModelListResponse {
          */
         maxDuration?: number;
         /**
-         * The maximum allowed length for \`string\` inputs. Also applies to each item in
-         * \`string_array\`.
+         * 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;
         /**
@@ -3461,8 +3571,9 @@ export declare namespace ModelListResponse {
          */
         min?: number;
         /**
-         * The minimum allowed length for string inputs. Also applies to each item in
-         * \`string_array\`.
+         * 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;
         /**
@@ -3498,8 +3609,7 @@ export declare namespace ModelListResponse {
          * - \`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
+         * - \`conditional\`: Input is required when other inputs have specific values
          *
          * By default, the input is not required.
          */
@@ -3517,8 +3627,7 @@ export declare namespace ModelListResponse {
          * - \`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
+         * - \`conditional\`: Input is required when other inputs have specific values
          *
          * By default, the input is not required.
          */
@@ -3528,12 +3637,9 @@ export declare namespace ModelListResponse {
              */
             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
+             * Makes this input required when other inputs have one of the listed values
              */
-            conditionalValues?: unknown;
+            conditional?: Required.Conditional;
             /**
              * Makes this input required when another input is defined:
              *
@@ -3549,6 +3655,24 @@ export declare namespace ModelListResponse {
              */
             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
@@ -4024,6 +4148,12 @@ export declare namespace ModelListResponse {
          * 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
          */
@@ -4071,6 +4201,9 @@ export declare namespace ModelListResponse {
              */
             modelIdInput?: string;
         }
+        interface OutputProperties {
+            label: string;
+        }
         interface Preset {
             fields: Array<string>;
             presets: unknown;
@@ -4184,8 +4317,8 @@ export declare namespace ModelCopyResponse {
          */
         updatedAt: string;
         /**
-         * The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
-         * 75: Team plan 100: Enterprise plan
+         * 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;
         /**
@@ -4225,6 +4358,11 @@ export declare namespace ModelCopyResponse {
          * it by modelId with GET /models/{modelId}
          */
         inputs?: Array<Model.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
@@ -4438,7 +4576,9 @@ export declare namespace ModelCopyResponse {
              * 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
+             * 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';
             /**
@@ -4461,8 +4601,9 @@ export declare namespace ModelCopyResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -4476,8 +4617,9 @@ export declare namespace ModelCopyResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -4513,8 +4655,7 @@ export declare namespace ModelCopyResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -4532,8 +4673,7 @@ export declare namespace ModelCopyResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -4543,12 +4683,9 @@ export declare namespace ModelCopyResponse {
                  */
                 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
+                 * Makes this input required when other inputs have one of the listed values
                  */
-                conditionalValues?: unknown;
+                conditional?: Required.Conditional;
                 /**
                  * Makes this input required when another input is defined:
                  *
@@ -4564,6 +4701,24 @@ export declare namespace ModelCopyResponse {
                  */
                 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
@@ -5039,6 +5194,12 @@ export declare namespace ModelCopyResponse {
              * 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
              */
@@ -5086,6 +5247,9 @@ export declare namespace ModelCopyResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -5163,8 +5327,8 @@ export declare namespace ModelGetBulkResponse {
          */
         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 access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
-         * 75: Team plan 100: Enterprise plan
+         * 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;
         /**
@@ -5226,6 +5390,11 @@ export declare namespace ModelGetBulkResponse {
          * it by modelId with GET /models/{modelId}
          */
         inputs?: Array<Model.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
@@ -5460,7 +5629,9 @@ export declare namespace ModelGetBulkResponse {
              * 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
+             * 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';
             /**
@@ -5483,8 +5654,9 @@ export declare namespace ModelGetBulkResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -5498,8 +5670,9 @@ export declare namespace ModelGetBulkResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -5535,8 +5708,7 @@ export declare namespace ModelGetBulkResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -5554,8 +5726,7 @@ export declare namespace ModelGetBulkResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -5565,12 +5736,9 @@ export declare namespace ModelGetBulkResponse {
                  */
                 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
+                 * Makes this input required when other inputs have one of the listed values
                  */
-                conditionalValues?: unknown;
+                conditional?: Required.Conditional;
                 /**
                  * Makes this input required when another input is defined:
                  *
@@ -5586,6 +5754,24 @@ export declare namespace ModelGetBulkResponse {
                  */
                 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
@@ -6061,6 +6247,12 @@ export declare namespace ModelGetBulkResponse {
              * 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
              */
@@ -6108,6 +6300,9 @@ export declare namespace ModelGetBulkResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -6221,8 +6416,8 @@ export declare namespace ModelTransferResponse {
          */
         updatedAt: string;
         /**
-         * The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
-         * 75: Team plan 100: Enterprise plan
+         * 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;
         /**
@@ -6262,6 +6457,11 @@ export declare namespace ModelTransferResponse {
          * it by modelId with GET /models/{modelId}
          */
         inputs?: Array<Model.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
@@ -6475,7 +6675,9 @@ export declare namespace ModelTransferResponse {
              * 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
+             * 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';
             /**
@@ -6498,8 +6700,9 @@ export declare namespace ModelTransferResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -6513,8 +6716,9 @@ export declare namespace ModelTransferResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * 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;
             /**
@@ -6550,8 +6754,7 @@ export declare namespace ModelTransferResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -6569,8 +6772,7 @@ export declare namespace ModelTransferResponse {
              * - \`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
+             * - \`conditional\`: Input is required when other inputs have specific values
              *
              * By default, the input is not required.
              */
@@ -6580,12 +6782,9 @@ export declare namespace ModelTransferResponse {
                  */
                 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
+                 * Makes this input required when other inputs have one of the listed values
                  */
-                conditionalValues?: unknown;
+                conditional?: Required.Conditional;
                 /**
                  * Makes this input required when another input is defined:
                  *
@@ -6601,6 +6800,24 @@ export declare namespace ModelTransferResponse {
                  */
                 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
@@ -7076,6 +7293,12 @@ export declare namespace ModelTransferResponse {
              * 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
              */
@@ -7123,6 +7346,9 @@ export declare namespace ModelTransferResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -7745,6 +7971,11 @@ export interface ModelDeleteImagesParams {
     projectId?: string;
 }
 export interface ModelDownloadParams {
+    /**
+     * Query param: Estimate the operation instead of running it: the call returns a
+     * 269 response carrying the creative units cost. `api` estimates at the API tier.
+     */
+    dryRun?: 'true' | 'api';
     /**
      * Query param: The projectId used for ownership resource management. Either to
      * assert ownership or to set the owner of the resource(s)
@@ -7846,6 +8077,9 @@ export declare namespace Models {
     export { type ModelCreateResponse as ModelCreateResponse, type ModelRetrieveResponse as ModelRetrieveResponse, type ModelUpdateResponse as ModelUpdateResponse, type ModelListResponse as ModelListResponse, type ModelDeleteResponse as ModelDeleteResponse, type ModelCopyResponse as ModelCopyResponse, type ModelDeleteImagesResponse as ModelDeleteImagesResponse, type ModelDownloadResponse as ModelDownloadResponse, type ModelGetBulkResponse as ModelGetBulkResponse, type ModelTransferResponse as ModelTransferResponse, type ModelUpdateTagsResponse as ModelUpdateTagsResponse, type ModelListResponsesModelsCursor as ModelListResponsesModelsCursor, type ModelCreateParams as ModelCreateParams, type ModelRetrieveParams as ModelRetrieveParams, type ModelUpdateParams as ModelUpdateParams, type ModelListParams as ModelListParams, type ModelDeleteParams as ModelDeleteParams, type ModelCopyParams as ModelCopyParams, type ModelDeleteImagesParams as ModelDeleteImagesParams, type ModelDownloadParams as ModelDownloadParams, type ModelGetBulkParams as ModelGetBulkParams, type ModelTransferParams as ModelTransferParams, type ModelUpdateTagsParams as ModelUpdateTagsParams, };
     export { Description as Description, type DescriptionRetrieveResponse as DescriptionRetrieveResponse, type DescriptionUpdateResponse as DescriptionUpdateResponse, type DescriptionRetrieveParams as DescriptionRetrieveParams, type DescriptionUpdateParams as DescriptionUpdateParams, };
     export { Examples as Examples, type ExampleUpdateResponse as ExampleUpdateResponse, type ExampleListResponse as ExampleListResponse, type ExampleUpdateParams as ExampleUpdateParams, type ExampleListParams as ExampleListParams, };
+    export { Presets as Presets, type PresetCreateResponse as PresetCreateResponse, type PresetUpdateResponse as PresetUpdateResponse, type PresetListResponse as PresetListResponse, type PresetDeleteResponse as PresetDeleteResponse, type PresetCreateParams as PresetCreateParams, type PresetUpdateParams as PresetUpdateParams, type PresetListParams as PresetListParams, type PresetDeleteParams as PresetDeleteParams, };
+    export { PromptGuide as PromptGuide, type PromptGuideRetrieveResponse as PromptGuideRetrieveResponse, type PromptGuideUpdateResponse as PromptGuideUpdateResponse, type PromptGuideRetrieveParams as PromptGuideRetrieveParams, type PromptGuideUpdateParams as PromptGuideUpdateParams, };
+    export { Scores as Scores, type ScoreRetrievePromptResponse as ScoreRetrievePromptResponse, type ScoreRetrieveTrainingDatasetResponse as ScoreRetrieveTrainingDatasetResponse, type ScoreRetrievePromptParams as ScoreRetrievePromptParams, type ScoreRetrieveTrainingDatasetParams as ScoreRetrieveTrainingDatasetParams, };
     export { Train as Train, type TrainActionResponse as TrainActionResponse, type TrainTriggerResponse as TrainTriggerResponse, type TrainActionParams as TrainActionParams, type TrainTriggerParams as TrainTriggerParams, };
     export { TrainingImages as TrainingImages, type TrainingImageDeleteResponse as TrainingImageDeleteResponse, type TrainingImageAddResponse as TrainingImageAddResponse, type TrainingImageReplaceResponse as TrainingImageReplaceResponse, type TrainingImageReplacePairsResponse as TrainingImageReplacePairsResponse, type TrainingImageDeleteParams as TrainingImageDeleteParams, type TrainingImageAddParams as TrainingImageAddParams, type TrainingImageReplaceParams as TrainingImageReplaceParams, type TrainingImageReplacePairsParams as TrainingImageReplacePairsParams, };
 }