@scenario-labs/sdk 3.1.0 → 3.3.0

package/src/resources/models/train.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
+import { omitUndefined } from '../../internal/utils/values';
 
 export class Train extends APIResource {
   /**
@@ -14,11 +15,11 @@ export class Train extends APIResource {
     params: TrainActionParams,
     options?: RequestOptions,
   ): APIPromise<TrainActionResponse> {
-    const { originalAssets, projectId, ...body } = params;
+    const { projectId, ...body } = params;
     return this._client.post(path`/models/${modelID}/train/action`, {
-      query: { originalAssets, projectId },
       body,
       ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -32,9 +33,9 @@ export class Train extends APIResource {
   ): APIPromise<TrainTriggerResponse> {
     const { dryRun, originalAssets, projectId, trainingImagesCount, ...body } = params;
     return this._client.put(path`/models/${modelID}/train`, {
-      query: { dryRun, originalAssets, projectId, trainingImagesCount },
       body,
       ...options,
+      query: { dryRun, originalAssets, projectId, trainingImagesCount, ...omitUndefined(options?.query) },
     });
   }
 }
@@ -179,8 +180,8 @@ export 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;
 
@@ -229,6 +230,12 @@ export namespace TrainActionResponse {
      */
     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
@@ -493,7 +500,9 @@ export 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';
 
@@ -521,8 +530,9 @@ export 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;
 
@@ -539,8 +549,9 @@ export 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;
 
@@ -614,8 +625,7 @@ export 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.
        */
@@ -635,8 +645,7 @@ export 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.
        */
@@ -647,12 +656,9 @@ export 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:
@@ -670,6 +676,26 @@ export namespace TrainActionResponse {
          */
         ifNotDefined?: unknown;
       }
+
+      export namespace Required {
+        /**
+         * Makes this input required when other inputs have one of the listed values
+         */
+        export 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';
+        }
+      }
     }
 
     /**
@@ -1236,6 +1262,11 @@ export namespace TrainActionResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -1290,6 +1321,10 @@ export namespace TrainActionResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -1362,8 +1397,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;
 
@@ -1568,6 +1603,7 @@ export namespace TrainTriggerResponse {
           | 'remove-background'
           | 'transform'
           | 'user-approval'
+          | 'user-selection'
           | 'workflow';
 
         /**
@@ -1598,14 +1634,15 @@ export 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>;
 
@@ -1754,7 +1791,9 @@ export 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';
 
@@ -1782,8 +1821,9 @@ export 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;
 
@@ -1800,8 +1840,9 @@ export 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;
 
@@ -1881,8 +1922,7 @@ export 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.
            */
@@ -1981,7 +2021,9 @@ export 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';
 
@@ -2009,8 +2051,9 @@ export 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;
 
@@ -2027,8 +2070,9 @@ export 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;
 
@@ -2108,8 +2152,7 @@ export 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.
              */
@@ -2166,8 +2209,7 @@ export 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.
              */
@@ -2178,12 +2220,9 @@ export 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:
@@ -2201,6 +2240,26 @@ export namespace TrainTriggerResponse {
                */
               ifNotDefined?: unknown;
             }
+
+            export namespace Required {
+              /**
+               * Makes this input required when other inputs have one of the listed values
+               */
+              export 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';
+              }
+            }
           }
 
           /**
@@ -2241,8 +2300,7 @@ export 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.
            */
@@ -2253,12 +2311,9 @@ export 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:
@@ -2276,6 +2331,26 @@ export namespace TrainTriggerResponse {
              */
             ifNotDefined?: unknown;
           }
+
+          export namespace Required {
+            /**
+             * Makes this input required when other inputs have one of the listed values
+             */
+            export 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';
+            }
+          }
         }
 
         /**
@@ -2333,7 +2408,7 @@ export namespace TrainTriggerResponse {
 
       /**
        * 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.
@@ -2363,7 +2438,7 @@ export namespace TrainTriggerResponse {
     export 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.
@@ -2383,7 +2458,7 @@ export namespace TrainTriggerResponse {
       export interface CuCostDetails {
         'ip-detection'?: number;
 
-        'slop-detection'?: number;
+        'quality-gate'?: number;
       }
     }
   }
@@ -2523,8 +2598,8 @@ export 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;
 
@@ -2573,6 +2648,12 @@ export namespace TrainTriggerResponse {
      */
     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
@@ -2837,7 +2918,9 @@ export 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';
 
@@ -2865,8 +2948,9 @@ export 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;
 
@@ -2883,8 +2967,9 @@ export 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;
 
@@ -2958,8 +3043,7 @@ export 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.
        */
@@ -2979,8 +3063,7 @@ export 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.
        */
@@ -2991,12 +3074,9 @@ export 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:
@@ -3014,6 +3094,26 @@ export namespace TrainTriggerResponse {
          */
         ifNotDefined?: unknown;
       }
+
+      export namespace Required {
+        /**
+         * Makes this input required when other inputs have one of the listed values
+         */
+        export 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';
+        }
+      }
     }
 
     /**
@@ -3580,6 +3680,11 @@ export namespace TrainTriggerResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -3634,6 +3739,10 @@ export namespace TrainTriggerResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -3700,8 +3809,8 @@ export 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.
    */
   export interface CostDetails {
     'assistant-message'?: number;
@@ -3726,6 +3835,8 @@ export namespace TrainTriggerResponse {
 
     prompt?: number;
 
+    'quality-gate'?: number;
+
     'remove-background'?: number;
 
     repaint?: number;
@@ -3738,8 +3849,6 @@ export namespace TrainTriggerResponse {
 
     'skybox-upscale-360'?: number;
 
-    'slop-detection'?: number;
-
     texture?: number;
 
     'train-model'?: number;
@@ -3761,8 +3870,16 @@ export 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;
 
@@ -3777,7 +3894,8 @@ export 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;
 
@@ -3836,11 +3954,6 @@ export interface TrainActionParams {
    */
   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)
@@ -3850,9 +3963,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
@@ -3866,7 +3980,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;