@scenario-labs/sdk 3.1.0 → 3.3.0

package/src/resources/models/models.ts

@@ -17,6 +17,34 @@ import {
   ExampleUpdateResponse,
   Examples,
 } from './examples';
+import * as PresetsAPI from './presets';
+import {
+  PresetCreateParams,
+  PresetCreateResponse,
+  PresetDeleteParams,
+  PresetDeleteResponse,
+  PresetListParams,
+  PresetListResponse,
+  PresetUpdateParams,
+  PresetUpdateResponse,
+  Presets,
+} from './presets';
+import * as PromptGuideAPI from './prompt-guide';
+import {
+  PromptGuide,
+  PromptGuideRetrieveParams,
+  PromptGuideRetrieveResponse,
+  PromptGuideUpdateParams,
+  PromptGuideUpdateResponse,
+} from './prompt-guide';
+import * as ScoresAPI from './scores';
+import {
+  ScoreRetrievePromptParams,
+  ScoreRetrievePromptResponse,
+  ScoreRetrieveTrainingDatasetParams,
+  ScoreRetrieveTrainingDatasetResponse,
+  Scores,
+} from './scores';
 import * as TrainAPI from './train';
 import {
   Train,
@@ -41,10 +69,14 @@ import { APIPromise } from '../../core/api-promise';
 import { ModelsCursor, type ModelsCursorParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
+import { omitUndefined } from '../../internal/utils/values';
 
 export class Models extends APIResource {
   description: DescriptionAPI.Description = new DescriptionAPI.Description(this._client);
   examples: ExamplesAPI.Examples = new ExamplesAPI.Examples(this._client);
+  presets: PresetsAPI.Presets = new PresetsAPI.Presets(this._client);
+  promptGuide: PromptGuideAPI.PromptGuide = new PromptGuideAPI.PromptGuide(this._client);
+  scores: ScoresAPI.Scores = new ScoresAPI.Scores(this._client);
   train: TrainAPI.Train = new TrainAPI.Train(this._client);
   trainingImages: TrainingImagesAPI.TrainingImages = new TrainingImagesAPI.TrainingImages(this._client);
 
@@ -53,7 +85,11 @@ export class Models extends APIResource {
    */
   create(params: ModelCreateParams, options?: RequestOptions): APIPromise<ModelCreateResponse> {
     const { originalAssets, projectId, ...body } = params;
-    return this._client.post('/models', { query: { originalAssets, projectId }, body, ...options });
+    return this._client.post('/models', {
+      body,
+      ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -67,7 +103,10 @@ export class Models extends APIResource {
     query: ModelRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ModelRetrieveResponse> {
-    return this._client.get(path`/models/${modelID}`, { query, ...options });
+    return this._client.get(path`/models/${modelID}`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -80,9 +119,9 @@ export class Models extends APIResource {
   ): APIPromise<ModelUpdateResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.put(path`/models/${modelID}`, {
-      query: { originalAssets, projectId },
       body,
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -94,7 +133,10 @@ export class Models extends APIResource {
     query: ModelListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<ModelListResponsesModelsCursor, ModelListResponse> {
-    return this._client.getAPIList('/models', ModelsCursor<ModelListResponse>, { query, ...options });
+    return this._client.getAPIList('/models', ModelsCursor<ModelListResponse>, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -106,7 +148,10 @@ export class Models extends APIResource {
     options?: RequestOptions,
   ): APIPromise<unknown> {
     const { projectId } = params ?? {};
-    return this._client.delete(path`/models/${modelID}`, { query: { projectId }, ...options });
+    return this._client.delete(path`/models/${modelID}`, {
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -116,9 +161,9 @@ export class Models extends APIResource {
   copy(modelID: string, params: ModelCopyParams, options?: RequestOptions): APIPromise<ModelCopyResponse> {
     const { originalAssets, projectId, ...body } = params;
     return this._client.post(path`/models/${modelID}/copy`, {
-      query: { originalAssets, projectId },
       body,
       ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
     });
   }
 
@@ -131,7 +176,10 @@ export class Models extends APIResource {
     options?: RequestOptions,
   ): APIPromise<unknown> {
     const { ids, projectId } = params;
-    return this._client.delete(path`/models/${modelID}/images`, { query: { ids, projectId }, ...options });
+    return this._client.delete(path`/models/${modelID}/images`, {
+      ...options,
+      query: { ids, projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -142,8 +190,12 @@ export class Models extends APIResource {
     params: ModelDownloadParams,
     options?: RequestOptions,
   ): APIPromise<ModelDownloadResponse> {
-    const { projectId, ...body } = params;
-    return this._client.post(path`/models/${modelID}/download`, { query: { projectId }, body, ...options });
+    const { dryRun, projectId, ...body } = params;
+    return this._client.post(path`/models/${modelID}/download`, {
+      body,
+      ...options,
+      query: { dryRun, projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -151,7 +203,11 @@ export class Models extends APIResource {
    */
   getBulk(params: ModelGetBulkParams, options?: RequestOptions): APIPromise<ModelGetBulkResponse> {
     const { originalAssets, projectId, ...body } = params;
-    return this._client.post('/models/get-bulk', { query: { originalAssets, projectId }, body, ...options });
+    return this._client.post('/models/get-bulk', {
+      body,
+      ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -164,7 +220,11 @@ export class Models extends APIResource {
     options?: RequestOptions,
   ): APIPromise<ModelTransferResponse> {
     const { projectId, ...body } = params;
-    return this._client.post(path`/models/${modelID}/transfer`, { query: { projectId }, body, ...options });
+    return this._client.post(path`/models/${modelID}/transfer`, {
+      body,
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
   }
 
   /**
@@ -176,7 +236,11 @@ export class Models extends APIResource {
     options?: RequestOptions,
   ): APIPromise<ModelUpdateTagsResponse> {
     const { projectId, ...body } = params;
-    return this._client.put(path`/models/${modelID}/tags`, { query: { projectId }, body, ...options });
+    return this._client.put(path`/models/${modelID}/tags`, {
+      body,
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
   }
 }
 
@@ -322,8 +386,8 @@ export 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;
 
@@ -372,6 +436,12 @@ export namespace ModelCreateResponse {
      */
     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
@@ -636,7 +706,9 @@ export 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';
 
@@ -664,8 +736,9 @@ export 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;
 
@@ -682,8 +755,9 @@ export 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;
 
@@ -757,8 +831,7 @@ export 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.
        */
@@ -778,8 +851,7 @@ export 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.
        */
@@ -790,12 +862,9 @@ export 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:
@@ -813,6 +882,26 @@ export namespace ModelCreateResponse {
          */
         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';
+        }
+      }
     }
 
     /**
@@ -1379,6 +1468,11 @@ export namespace ModelCreateResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -1433,6 +1527,10 @@ export namespace ModelCreateResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -1637,8 +1735,8 @@ export 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;
 
@@ -1687,6 +1785,12 @@ export namespace ModelRetrieveResponse {
      */
     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
@@ -1951,7 +2055,9 @@ export 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';
 
@@ -1979,8 +2085,9 @@ export 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;
 
@@ -1997,8 +2104,9 @@ export 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;
 
@@ -2072,8 +2180,7 @@ export 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.
        */
@@ -2093,8 +2200,7 @@ export 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.
        */
@@ -2105,12 +2211,9 @@ export 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:
@@ -2128,6 +2231,26 @@ export namespace ModelRetrieveResponse {
          */
         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';
+        }
+      }
     }
 
     /**
@@ -2694,6 +2817,11 @@ export namespace ModelRetrieveResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -2748,6 +2876,10 @@ export namespace ModelRetrieveResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -2952,8 +3084,8 @@ export 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;
 
@@ -3002,6 +3134,12 @@ export namespace ModelUpdateResponse {
      */
     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
@@ -3266,7 +3404,9 @@ export 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';
 
@@ -3294,8 +3434,9 @@ export 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;
 
@@ -3312,8 +3453,9 @@ export 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;
 
@@ -3387,8 +3529,7 @@ export 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.
        */
@@ -3408,8 +3549,7 @@ export 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.
        */
@@ -3420,12 +3560,9 @@ export 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:
@@ -3443,6 +3580,26 @@ export namespace ModelUpdateResponse {
          */
         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';
+        }
+      }
     }
 
     /**
@@ -4009,6 +4166,11 @@ export namespace ModelUpdateResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -4063,6 +4225,10 @@ export namespace ModelUpdateResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -4262,8 +4428,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;
 
@@ -4312,6 +4478,12 @@ export interface ModelListResponse {
    */
   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
@@ -4576,7 +4748,9 @@ export 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';
 
@@ -4604,8 +4778,9 @@ export 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;
 
@@ -4622,8 +4797,9 @@ export 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;
 
@@ -4697,8 +4873,7 @@ export 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.
      */
@@ -4718,8 +4893,7 @@ export 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.
      */
@@ -4730,12 +4904,9 @@ export 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:
@@ -4753,6 +4924,26 @@ export namespace ModelListResponse {
        */
       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';
+      }
+    }
   }
 
   /**
@@ -5319,6 +5510,11 @@ export namespace ModelListResponse {
      */
     lorasComponent?: UiConfig.LorasComponent;
 
+    /**
+     * Configuration for the provider outputs exposed by `exposeOutput`
+     */
+    outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
     /**
      * Configuration for the presets
      */
@@ -5373,6 +5569,10 @@ export namespace ModelListResponse {
       modelIdInput?: string;
     }
 
+    export interface OutputProperties {
+      label: string;
+    }
+
     export interface Preset {
       fields: Array<string>;
 
@@ -5578,8 +5778,8 @@ export 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;
 
@@ -5628,6 +5828,12 @@ export namespace ModelCopyResponse {
      */
     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
@@ -5892,7 +6098,9 @@ export 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';
 
@@ -5920,8 +6128,9 @@ export 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;
 
@@ -5938,8 +6147,9 @@ export 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;
 
@@ -6013,8 +6223,7 @@ export 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.
        */
@@ -6034,8 +6243,7 @@ export 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.
        */
@@ -6046,12 +6254,9 @@ export 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:
@@ -6069,6 +6274,26 @@ export namespace ModelCopyResponse {
          */
         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';
+        }
+      }
     }
 
     /**
@@ -6635,6 +6860,11 @@ export namespace ModelCopyResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -6689,6 +6919,10 @@ export namespace ModelCopyResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -6815,8 +7049,8 @@ export namespace ModelGetBulkResponse {
       | '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;
 
@@ -6926,6 +7160,12 @@ export namespace ModelGetBulkResponse {
      */
     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
@@ -7216,7 +7456,9 @@ export 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';
 
@@ -7244,8 +7486,9 @@ export 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;
 
@@ -7262,8 +7505,9 @@ export 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;
 
@@ -7337,8 +7581,7 @@ export 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.
        */
@@ -7358,8 +7601,7 @@ export 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.
        */
@@ -7370,12 +7612,9 @@ export 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:
@@ -7393,6 +7632,26 @@ export namespace ModelGetBulkResponse {
          */
         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';
+        }
+      }
     }
 
     /**
@@ -7959,6 +8218,11 @@ export namespace ModelGetBulkResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -8013,6 +8277,10 @@ export namespace ModelGetBulkResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -8217,8 +8485,8 @@ export 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;
 
@@ -8267,6 +8535,12 @@ export namespace ModelTransferResponse {
      */
     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
@@ -8531,7 +8805,9 @@ export 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';
 
@@ -8559,8 +8835,9 @@ export 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;
 
@@ -8577,8 +8854,9 @@ export 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;
 
@@ -8652,8 +8930,7 @@ export 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.
        */
@@ -8673,8 +8950,7 @@ export 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.
        */
@@ -8685,12 +8961,9 @@ export 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:
@@ -8708,6 +8981,26 @@ export namespace ModelTransferResponse {
          */
         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';
+        }
+      }
     }
 
     /**
@@ -9274,6 +9567,11 @@ export namespace ModelTransferResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -9328,6 +9626,10 @@ export namespace ModelTransferResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -10181,6 +10483,12 @@ export interface ModelDeleteImagesParams {
 }
 
 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)
@@ -10297,6 +10605,9 @@ export interface ModelUpdateTagsParams {
 
 Models.Description = Description;
 Models.Examples = Examples;
+Models.Presets = Presets;
+Models.PromptGuide = PromptGuide;
+Models.Scores = Scores;
 Models.Train = Train;
 Models.TrainingImages = TrainingImages;
 
@@ -10343,6 +10654,34 @@ export declare namespace Models {
     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,