@scenario-labs/sdk 3.1.0 → 3.2.0

package/src/resources/models/examples.ts

@@ -299,6 +299,64 @@ export namespace ExampleUpdateResponse {
        */
       originalFileUrl?: string;
 
+      /**
+       * The mime type of the original file url.
+       *
+       * The original file is stored under a key that carries no extension, so this is
+       * the only way to know which format `originalFileUrl` serves (e.g. an HDRi skybox
+       * exposes a JPEG preview as `url` and its `.exr` or `.hdr` file as the original).
+       * Omitted when the stored format could not be determined.
+       */
+      originalMimeType?:
+        | 'application/gzip'
+        | 'application/json'
+        | 'application/octet-stream'
+        | 'application/pdf'
+        | 'application/safetensors'
+        | 'application/vnd.autodesk.fbx'
+        | 'application/x-authorware-bin'
+        | 'application/x-zip-compressed'
+        | 'application/x.autodesk.fbx'
+        | 'application/zip'
+        | 'audio/m4a'
+        | 'audio/mpeg'
+        | 'audio/ogg'
+        | 'audio/wav'
+        | 'image/aces'
+        | 'image/avif'
+        | 'image/bmp'
+        | 'image/gif'
+        | 'image/heic'
+        | 'image/jpeg'
+        | 'image/png'
+        | 'image/svg+xml'
+        | 'image/tiff'
+        | 'image/vnd.radiance'
+        | 'image/webp'
+        | 'image/x-exr'
+        | 'model/glb'
+        | 'model/gltf+json'
+        | 'model/gltf-binary'
+        | 'model/ksplat'
+        | 'model/mtl'
+        | 'model/obj'
+        | 'model/ply'
+        | 'model/sog'
+        | 'model/splat'
+        | 'model/spz'
+        | 'model/stl'
+        | 'model/vnd.collada+xml'
+        | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+        | 'model/x-3d-vox'
+        | 'model/x-fbx'
+        | 'model/x-maya-ascii'
+        | 'model/x-maya-binary'
+        | 'model/x3d+xml'
+        | 'text/plain'
+        | 'video/mp4'
+        | 'video/quicktime'
+        | 'video/webm';
+
       /**
        * The output index of the asset within a job This index is an positive integer
        * that starts at 0 It is used to differentiate between multiple outputs of the
@@ -314,12 +372,12 @@ export namespace ExampleUpdateResponse {
       preview?: Asset.Preview;
 
       /**
-       * SlopGuard detection result, computed asynchronously after generation.
+       * Quality Gate result, computed asynchronously after generation.
        *
        * `details` (the per-dimension reasons and suggestions) is returned only when the
-       * asset is read with `withSlopGuardDetails=true`.
+       * asset is read with `withQualityGateDetails=true`.
        */
-      slopGuard?: Asset.SlopGuard;
+      qualityGate?: Asset.QualityGate;
 
       /**
        * The asset's thumbnail.
@@ -1238,12 +1296,12 @@ export namespace ExampleUpdateResponse {
       }
 
       /**
-       * SlopGuard detection result, computed asynchronously after generation.
+       * Quality Gate result, computed asynchronously after generation.
        *
        * `details` (the per-dimension reasons and suggestions) is returned only when the
-       * asset is read with `withSlopGuardDetails=true`.
+       * asset is read with `withQualityGateDetails=true`.
        */
-      export interface SlopGuard {
+      export interface QualityGate {
         /**
          * ISO-8601 timestamp of when scoring ran
          */
@@ -1277,13 +1335,13 @@ export namespace ExampleUpdateResponse {
         /**
          * Per-dimension reasons and suggestions, as produced by the detector.
          *
-         * Returned only when the asset is read with `withSlopGuardDetails=true` by the
+         * Returned only when the asset is read with `withQualityGateDetails=true` by the
          * project that owns it — the brief-compliance text paraphrases that project's
          * brief, so a cross-project read of a public asset gets the summary alone. Also
          * omitted when the archived verdict is unavailable (asset scored by an older
          * version, or an unreadable archive).
          */
-        details?: SlopGuard.Details;
+        details?: QualityGate.Details;
 
         /**
          * Error message when status is 'error' (truncated)
@@ -1306,11 +1364,11 @@ export namespace ExampleUpdateResponse {
         verdict?: 'fail' | 'pass' | 'warn';
       }
 
-      export namespace SlopGuard {
+      export namespace QualityGate {
         /**
          * Per-dimension reasons and suggestions, as produced by the detector.
          *
-         * Returned only when the asset is read with `withSlopGuardDetails=true` by the
+         * Returned only when the asset is read with `withQualityGateDetails=true` by the
          * project that owns it — the brief-compliance text paraphrases that project's
          * brief, so a cross-project read of a public asset gets the summary alone. Also
          * omitted when the archived verdict is unavailable (asset scored by an older
@@ -2099,7 +2157,9 @@ export namespace ExampleUpdateResponse {
              * 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';
 
@@ -2127,8 +2187,9 @@ export namespace ExampleUpdateResponse {
             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;
 
@@ -2145,8 +2206,9 @@ export namespace ExampleUpdateResponse {
             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;
 
@@ -2326,7 +2388,9 @@ export namespace ExampleUpdateResponse {
                * 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';
 
@@ -2354,8 +2418,9 @@ export namespace ExampleUpdateResponse {
               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;
 
@@ -2372,8 +2437,9 @@ export namespace ExampleUpdateResponse {
               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;
 
@@ -2678,7 +2744,7 @@ export namespace ExampleUpdateResponse {
 
         /**
          * 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.
@@ -2708,7 +2774,7 @@ export namespace ExampleUpdateResponse {
       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.
@@ -2728,7 +2794,7 @@ export namespace ExampleUpdateResponse {
         export interface CuCostDetails {
           'ip-detection'?: number;
 
-          'slop-detection'?: number;
+          'quality-gate'?: number;
         }
       }
     }
@@ -3000,6 +3066,64 @@ export namespace ExampleListResponse {
        */
       originalFileUrl?: string;
 
+      /**
+       * The mime type of the original file url.
+       *
+       * The original file is stored under a key that carries no extension, so this is
+       * the only way to know which format `originalFileUrl` serves (e.g. an HDRi skybox
+       * exposes a JPEG preview as `url` and its `.exr` or `.hdr` file as the original).
+       * Omitted when the stored format could not be determined.
+       */
+      originalMimeType?:
+        | 'application/gzip'
+        | 'application/json'
+        | 'application/octet-stream'
+        | 'application/pdf'
+        | 'application/safetensors'
+        | 'application/vnd.autodesk.fbx'
+        | 'application/x-authorware-bin'
+        | 'application/x-zip-compressed'
+        | 'application/x.autodesk.fbx'
+        | 'application/zip'
+        | 'audio/m4a'
+        | 'audio/mpeg'
+        | 'audio/ogg'
+        | 'audio/wav'
+        | 'image/aces'
+        | 'image/avif'
+        | 'image/bmp'
+        | 'image/gif'
+        | 'image/heic'
+        | 'image/jpeg'
+        | 'image/png'
+        | 'image/svg+xml'
+        | 'image/tiff'
+        | 'image/vnd.radiance'
+        | 'image/webp'
+        | 'image/x-exr'
+        | 'model/glb'
+        | 'model/gltf+json'
+        | 'model/gltf-binary'
+        | 'model/ksplat'
+        | 'model/mtl'
+        | 'model/obj'
+        | 'model/ply'
+        | 'model/sog'
+        | 'model/splat'
+        | 'model/spz'
+        | 'model/stl'
+        | 'model/vnd.collada+xml'
+        | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+        | 'model/x-3d-vox'
+        | 'model/x-fbx'
+        | 'model/x-maya-ascii'
+        | 'model/x-maya-binary'
+        | 'model/x3d+xml'
+        | 'text/plain'
+        | 'video/mp4'
+        | 'video/quicktime'
+        | 'video/webm';
+
       /**
        * The output index of the asset within a job This index is an positive integer
        * that starts at 0 It is used to differentiate between multiple outputs of the
@@ -3015,12 +3139,12 @@ export namespace ExampleListResponse {
       preview?: Asset.Preview;
 
       /**
-       * SlopGuard detection result, computed asynchronously after generation.
+       * Quality Gate result, computed asynchronously after generation.
        *
        * `details` (the per-dimension reasons and suggestions) is returned only when the
-       * asset is read with `withSlopGuardDetails=true`.
+       * asset is read with `withQualityGateDetails=true`.
        */
-      slopGuard?: Asset.SlopGuard;
+      qualityGate?: Asset.QualityGate;
 
       /**
        * The asset's thumbnail.
@@ -3939,12 +4063,12 @@ export namespace ExampleListResponse {
       }
 
       /**
-       * SlopGuard detection result, computed asynchronously after generation.
+       * Quality Gate result, computed asynchronously after generation.
        *
        * `details` (the per-dimension reasons and suggestions) is returned only when the
-       * asset is read with `withSlopGuardDetails=true`.
+       * asset is read with `withQualityGateDetails=true`.
        */
-      export interface SlopGuard {
+      export interface QualityGate {
         /**
          * ISO-8601 timestamp of when scoring ran
          */
@@ -3978,13 +4102,13 @@ export namespace ExampleListResponse {
         /**
          * Per-dimension reasons and suggestions, as produced by the detector.
          *
-         * Returned only when the asset is read with `withSlopGuardDetails=true` by the
+         * Returned only when the asset is read with `withQualityGateDetails=true` by the
          * project that owns it — the brief-compliance text paraphrases that project's
          * brief, so a cross-project read of a public asset gets the summary alone. Also
          * omitted when the archived verdict is unavailable (asset scored by an older
          * version, or an unreadable archive).
          */
-        details?: SlopGuard.Details;
+        details?: QualityGate.Details;
 
         /**
          * Error message when status is 'error' (truncated)
@@ -4007,11 +4131,11 @@ export namespace ExampleListResponse {
         verdict?: 'fail' | 'pass' | 'warn';
       }
 
-      export namespace SlopGuard {
+      export namespace QualityGate {
         /**
          * Per-dimension reasons and suggestions, as produced by the detector.
          *
-         * Returned only when the asset is read with `withSlopGuardDetails=true` by the
+         * Returned only when the asset is read with `withQualityGateDetails=true` by the
          * project that owns it — the brief-compliance text paraphrases that project's
          * brief, so a cross-project read of a public asset gets the summary alone. Also
          * omitted when the archived verdict is unavailable (asset scored by an older
@@ -4800,7 +4924,9 @@ export namespace ExampleListResponse {
              * 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';
 
@@ -4828,8 +4954,9 @@ export namespace ExampleListResponse {
             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;
 
@@ -4846,8 +4973,9 @@ export namespace ExampleListResponse {
             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;
 
@@ -5027,7 +5155,9 @@ export namespace ExampleListResponse {
                * 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';
 
@@ -5055,8 +5185,9 @@ export namespace ExampleListResponse {
               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;
 
@@ -5073,8 +5204,9 @@ export namespace ExampleListResponse {
               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;
 
@@ -5379,7 +5511,7 @@ export namespace ExampleListResponse {
 
         /**
          * 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.
@@ -5409,7 +5541,7 @@ export namespace ExampleListResponse {
       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.
@@ -5429,7 +5561,7 @@ export namespace ExampleListResponse {
         export interface CuCostDetails {
           'ip-detection'?: number;
 
-          'slop-detection'?: number;
+          'quality-gate'?: number;
         }
       }
     }