@scenario-labs/sdk 3.1.0 → 3.3.0

package/resources/models/train.d.ts

@@ -72,8 +72,8 @@ export declare namespace TrainActionResponse {
          */
         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;
         /**
@@ -113,6 +113,11 @@ export declare namespace TrainActionResponse {
          * 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
@@ -326,7 +331,9 @@ export declare namespace TrainActionResponse {
              * 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';
             /**
@@ -349,8 +356,9 @@ export declare namespace TrainActionResponse {
              */
             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;
             /**
@@ -364,8 +372,9 @@ export declare namespace TrainActionResponse {
              */
             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;
             /**
@@ -401,8 +410,7 @@ export declare namespace TrainActionResponse {
              * - \`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.
              */
@@ -420,8 +428,7 @@ export declare namespace TrainActionResponse {
              * - \`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.
              */
@@ -431,12 +438,9 @@ export declare namespace TrainActionResponse {
                  */
                 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:
                  *
@@ -452,6 +456,24 @@ export declare namespace TrainActionResponse {
                  */
                 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
@@ -927,6 +949,12 @@ export declare namespace TrainActionResponse {
              * 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
              */
@@ -974,6 +1002,9 @@ export declare namespace TrainActionResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -1032,8 +1063,8 @@ export interface TrainTriggerResponse {
     /**
      * Compute Units cost per billing action for this request, after discount. Values
      * sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
-     * charge appear. Lets clients split the total (e.g. generation vs
-     * `slop-detection`) — including on dryRun estimates.
+     * charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
+     * — including on dryRun estimates.
      */
     costDetails?: TrainTriggerResponse.CostDetails;
     /**
@@ -1158,7 +1189,7 @@ export declare namespace TrainTriggerResponse {
                 /**
                  * The type of the job for the node.
                  */
-                type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
+                type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
                 /**
                  * List of produced assets for this node.
                  */
@@ -1183,13 +1214,14 @@ export declare namespace TrainTriggerResponse {
                  */
                 includeOutputsInWorkflowJob?: true;
                 /**
-                 * The inputs of the node.
+                 * The inputs of the node. For a user-selection node, the array input's `min`/`max`
+                 * bound how many items the user may pick (defaults: 1 and 100); conditional
+                 * connections may be present as additional inputs.
                  */
                 inputs?: Array<Flow.Input>;
                 /**
-                 * Statically-configured items for a List node. The node outputs this array as-is
-                 * when executed. Only available for List nodes. The values can be strings,
-                 * numbers, or asset IDs.
+                 * Statically-configured items for a List node, or the frozen candidate list of a
+                 * UserSelection node. The values can be strings, numbers, or asset IDs.
                  */
                 items?: Array<string>;
                 /**
@@ -1306,7 +1338,9 @@ export declare namespace TrainTriggerResponse {
                      * 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';
                     /**
@@ -1329,8 +1363,9 @@ export declare namespace TrainTriggerResponse {
                      */
                     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;
                     /**
@@ -1344,8 +1379,9 @@ export declare namespace TrainTriggerResponse {
                      */
                     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;
                     /**
@@ -1386,8 +1422,7 @@ export declare namespace TrainTriggerResponse {
                      * - \`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.
                      */
@@ -1464,7 +1499,9 @@ export declare namespace TrainTriggerResponse {
                          * 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';
                         /**
@@ -1487,8 +1524,9 @@ export declare namespace TrainTriggerResponse {
                          */
                         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;
                         /**
@@ -1502,8 +1540,9 @@ export declare namespace TrainTriggerResponse {
                          */
                         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;
                         /**
@@ -1544,8 +1583,7 @@ export declare namespace TrainTriggerResponse {
                          * - \`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.
                          */
@@ -1595,8 +1633,7 @@ export declare namespace TrainTriggerResponse {
                          * - \`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.
                          */
@@ -1606,12 +1643,9 @@ export declare namespace TrainTriggerResponse {
                              */
                             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:
                              *
@@ -1627,6 +1661,24 @@ export declare namespace TrainTriggerResponse {
                              */
                             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 reference to another input or output of the same workflow. Must have at
@@ -1662,8 +1714,7 @@ export declare namespace TrainTriggerResponse {
                      * - \`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.
                      */
@@ -1673,12 +1724,9 @@ export declare namespace TrainTriggerResponse {
                          */
                         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:
                          *
@@ -1694,6 +1742,24 @@ export declare namespace TrainTriggerResponse {
                          */
                         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 logic of the node. Only available for logic nodes.
@@ -1733,7 +1799,7 @@ export declare namespace TrainTriggerResponse {
             cuDiscount: number;
             /**
              * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
-             * top of the generation itself, such as `slop-detection`.
+             * top of the generation itself, such as `quality-gate`.
              *
              * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
              * values here.
@@ -1761,7 +1827,7 @@ export declare namespace TrainTriggerResponse {
         namespace Billing {
             /**
              * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
-             * top of the generation itself, such as `slop-detection`.
+             * top of the generation itself, such as `quality-gate`.
              *
              * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
              * values here.
@@ -1780,7 +1846,7 @@ export declare namespace TrainTriggerResponse {
              */
             interface CuCostDetails {
                 'ip-detection'?: number;
-                'slop-detection'?: number;
+                'quality-gate'?: number;
             }
         }
     }
@@ -1841,8 +1907,8 @@ export declare namespace TrainTriggerResponse {
          */
         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;
         /**
@@ -1882,6 +1948,11 @@ export declare namespace TrainTriggerResponse {
          * 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
@@ -2095,7 +2166,9 @@ export declare namespace TrainTriggerResponse {
              * 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';
             /**
@@ -2118,8 +2191,9 @@ export declare namespace TrainTriggerResponse {
              */
             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;
             /**
@@ -2133,8 +2207,9 @@ export declare namespace TrainTriggerResponse {
              */
             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;
             /**
@@ -2170,8 +2245,7 @@ export declare namespace TrainTriggerResponse {
              * - \`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.
              */
@@ -2189,8 +2263,7 @@ export declare namespace TrainTriggerResponse {
              * - \`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.
              */
@@ -2200,12 +2273,9 @@ export declare namespace TrainTriggerResponse {
                  */
                 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:
                  *
@@ -2221,6 +2291,24 @@ export declare namespace TrainTriggerResponse {
                  */
                 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
@@ -2696,6 +2784,12 @@ export declare namespace TrainTriggerResponse {
              * 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
              */
@@ -2743,6 +2837,9 @@ export declare namespace TrainTriggerResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -2797,8 +2894,8 @@ export declare namespace TrainTriggerResponse {
     /**
      * Compute Units cost per billing action for this request, after discount. Values
      * sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
-     * charge appear. Lets clients split the total (e.g. generation vs
-     * `slop-detection`) — including on dryRun estimates.
+     * charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
+     * — including on dryRun estimates.
      */
     interface CostDetails {
         'assistant-message'?: number;
@@ -2812,13 +2909,13 @@ export declare namespace TrainTriggerResponse {
         'ip-detection'?: number;
         pixelate?: number;
         prompt?: number;
+        'quality-gate'?: number;
         'remove-background'?: number;
         repaint?: number;
         restyle?: number;
         segmentation?: number;
         'skybox-base-360'?: number;
         'skybox-upscale-360'?: number;
-        'slop-detection'?: number;
         texture?: number;
         'train-model'?: number;
         translate?: number;
@@ -2834,8 +2931,15 @@ export declare namespace TrainTriggerResponse {
          */
         action: 'allowed' | 'blocked' | 'flagged';
         /**
-         * IP-detection CU fee, separate from creativeUnitsCost: a fixed base fee plus a
-         * per-image fee for each analyzed input image.
+         * Number of images the detectors actually analyzed — a video counts as each of its
+         * extracted frames, and an image that could not be read is excluded (and not
+         * billed). Each of them is priced once per enabled filter.
+         */
+        analyzedImagesCount: number;
+        /**
+         * IP-detection CU fee, separate from creativeUnitsCost: it follows the provider
+         * tokens the run sends — the prompt plus every analyzed image, once per enabled
+         * filter — with a 1 CU minimum per run.
          */
         creativeUnitsCharged: number;
         /**
@@ -2847,7 +2951,8 @@ export declare namespace TrainTriggerResponse {
          */
         findings: Array<IPDetection.Finding>;
         /**
-         * Convenience flag; always true when action is not 'allowed'.
+         * Whether a filter considered the inputs an IP risk. Independent of `action`: a
+         * request blocked because a detector errored is `blocked` and NOT flagged.
          */
         flagged: boolean;
         /**
@@ -2896,10 +3001,6 @@ export interface TrainActionParams {
      * Body param: The action to perform on the model training
      */
     action: 'cancel';
-    /**
-     * Query param: If set to true, returns the original asset without transformation
-     */
-    originalAssets?: boolean;
     /**
      * Query param: The projectId used for ownership resource management. Either to
      * assert ownership or to set the owner of the resource(s)
@@ -2908,9 +3009,10 @@ export interface TrainActionParams {
 }
 export interface TrainTriggerParams {
     /**
-     * Query param
+     * 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?: unknown;
+    dryRun?: 'true' | 'api';
     /**
      * Query param: If set to true, returns the original asset without transformation
      */
@@ -2921,7 +3023,8 @@ export interface TrainTriggerParams {
      */
     projectId?: string;
     /**
-     * Query param: Simulate the number of training images, used for dryRun purpose
+     * Query param: Simulate the number of training images, used for dryRun purpose.
+     * Ignored if the model already has training images.
      */
     trainingImagesCount?: number;
     /**