@scenario-labs/sdk 2.1.0 → 2.2.1

package/src/resources/models/description.ts

@@ -72,7 +72,7 @@ export namespace DescriptionRetrieveResponse {
       /**
        * The kind of asset
        */
-      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * The mime type of the asset (example: "image/png")
@@ -108,6 +108,7 @@ export namespace DescriptionRetrieveResponse {
         | '3d:texture:normal'
         | '3d:texture:roughness'
         | 'audio2audio'
+        | 'audio2txt'
         | 'audio2video'
         | 'background-removal'
         | 'canvas'
@@ -118,6 +119,7 @@ export namespace DescriptionRetrieveResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2txt'
         | 'img2video'
         | 'inference-control-net'
         | 'inference-control-net-img'
@@ -157,12 +159,14 @@ export namespace DescriptionRetrieveResponse {
         | 'txt23d'
         | 'txt2audio'
         | 'txt2img'
+        | 'txt2txt'
         | 'txt2video'
         | 'unknown'
         | 'uploaded'
         | 'uploaded-3d'
         | 'uploaded-audio'
         | 'uploaded-avatar'
+        | 'uploaded-text'
         | 'uploaded-video'
         | 'upscale'
         | 'upscale-skybox'
@@ -231,6 +235,13 @@ export namespace DescriptionRetrieveResponse {
          */
         channels?: number;
 
+        /**
+         * Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
+         * counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
+         * several).
+         */
+        charCount?: number;
+
         /**
          * Classification of the audio
          */
@@ -276,6 +287,14 @@ export namespace DescriptionRetrieveResponse {
          */
         hasAnimations?: boolean;
 
+        /**
+         * True when `preview` holds the entire content unmodified — consumers can use it
+         * directly without fetching `asset.url`. False or undefined means the content
+         * exceeds the preview budget and consumers must fetch the full body from S3 to
+         * read past the preview.
+         */
+        hasFullPreview?: boolean;
+
         /**
          * Whether the mesh has normal vectors
          */
@@ -298,6 +317,15 @@ export namespace DescriptionRetrieveResponse {
          */
         nbFrames?: number;
 
+        /**
+         * Leading slice of the content used for inline UI display and as a search
+         * shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
+         * code-point boundary so no character is split. Number of characters in the
+         * preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
+         * emoji-heavy text at the default 1 KB budget).
+         */
+        preview?: string;
+
         /**
          * Sample rate of the media in Hz
          */
@@ -314,6 +342,11 @@ export namespace DescriptionRetrieveResponse {
         vertexCount?: number;
 
         width?: number;
+
+        /**
+         * Number of whitespace-separated words in the text
+         */
+        wordCount?: number;
       }
 
       export namespace Properties {
@@ -463,7 +496,7 @@ export namespace DescriptionUpdateResponse {
       /**
        * The kind of asset
        */
-      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * The mime type of the asset (example: "image/png")
@@ -499,6 +532,7 @@ export namespace DescriptionUpdateResponse {
         | '3d:texture:normal'
         | '3d:texture:roughness'
         | 'audio2audio'
+        | 'audio2txt'
         | 'audio2video'
         | 'background-removal'
         | 'canvas'
@@ -509,6 +543,7 @@ export namespace DescriptionUpdateResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2txt'
         | 'img2video'
         | 'inference-control-net'
         | 'inference-control-net-img'
@@ -548,12 +583,14 @@ export namespace DescriptionUpdateResponse {
         | 'txt23d'
         | 'txt2audio'
         | 'txt2img'
+        | 'txt2txt'
         | 'txt2video'
         | 'unknown'
         | 'uploaded'
         | 'uploaded-3d'
         | 'uploaded-audio'
         | 'uploaded-avatar'
+        | 'uploaded-text'
         | 'uploaded-video'
         | 'upscale'
         | 'upscale-skybox'
@@ -622,6 +659,13 @@ export namespace DescriptionUpdateResponse {
          */
         channels?: number;
 
+        /**
+         * Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
+         * counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
+         * several).
+         */
+        charCount?: number;
+
         /**
          * Classification of the audio
          */
@@ -667,6 +711,14 @@ export namespace DescriptionUpdateResponse {
          */
         hasAnimations?: boolean;
 
+        /**
+         * True when `preview` holds the entire content unmodified — consumers can use it
+         * directly without fetching `asset.url`. False or undefined means the content
+         * exceeds the preview budget and consumers must fetch the full body from S3 to
+         * read past the preview.
+         */
+        hasFullPreview?: boolean;
+
         /**
          * Whether the mesh has normal vectors
          */
@@ -689,6 +741,15 @@ export namespace DescriptionUpdateResponse {
          */
         nbFrames?: number;
 
+        /**
+         * Leading slice of the content used for inline UI display and as a search
+         * shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
+         * code-point boundary so no character is split. Number of characters in the
+         * preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
+         * emoji-heavy text at the default 1 KB budget).
+         */
+        preview?: string;
+
         /**
          * Sample rate of the media in Hz
          */
@@ -705,6 +766,11 @@ export namespace DescriptionUpdateResponse {
         vertexCount?: number;
 
         width?: number;
+
+        /**
+         * Number of whitespace-separated words in the text
+         */
+        wordCount?: number;
       }
 
       export namespace Properties {

package/src/resources/models/examples.ts

@@ -111,7 +111,7 @@ export namespace ExampleUpdateResponse {
       /**
        * The kind of asset
        */
-      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * Metadata of the asset with some additional information
@@ -152,6 +152,7 @@ export namespace ExampleUpdateResponse {
         | '3d:texture:normal'
         | '3d:texture:roughness'
         | 'audio2audio'
+        | 'audio2txt'
         | 'audio2video'
         | 'background-removal'
         | 'canvas'
@@ -162,6 +163,7 @@ export namespace ExampleUpdateResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2txt'
         | 'img2video'
         | 'inference-control-net'
         | 'inference-control-net-img'
@@ -201,12 +203,14 @@ export namespace ExampleUpdateResponse {
         | 'txt23d'
         | 'txt2audio'
         | 'txt2img'
+        | 'txt2txt'
         | 'txt2video'
         | 'unknown'
         | 'uploaded'
         | 'uploaded-3d'
         | 'uploaded-audio'
         | 'uploaded-avatar'
+        | 'uploaded-text'
         | 'uploaded-video'
         | 'upscale'
         | 'upscale-skybox'
@@ -321,7 +325,7 @@ export namespace ExampleUpdateResponse {
        * Metadata of the asset with some additional information
        */
       export interface Metadata {
-        kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+        kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
         /**
          * The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
@@ -337,6 +341,7 @@ export namespace ExampleUpdateResponse {
           | '3d23d'
           | '3d23d-texture'
           | 'audio2audio'
+          | 'audio2txt'
           | 'audio2video'
           | 'background-removal'
           | 'canvas'
@@ -347,6 +352,7 @@ export namespace ExampleUpdateResponse {
           | 'image-prompt-editing'
           | 'img23d'
           | 'img2img'
+          | 'img2txt'
           | 'img2video'
           | 'inference-controlnet'
           | 'inference-controlnet-img2img'
@@ -386,12 +392,14 @@ export namespace ExampleUpdateResponse {
           | 'txt23d'
           | 'txt2audio'
           | 'txt2img'
+          | 'txt2txt'
           | 'txt2video'
           | 'unknown'
           | 'uploaded'
           | 'uploaded-3d'
           | 'uploaded-audio'
           | 'uploaded-avatar'
+          | 'uploaded-text'
           | 'uploaded-video'
           | 'upscale'
           | 'upscale-skybox'
@@ -415,10 +423,6 @@ export namespace ExampleUpdateResponse {
          */
         aspectRatio?: string;
 
-        /**
-         * Int to set between 0 and 255 for the opacity of the background in the result
-         * images.
-         */
         backgroundOpacity?: number;
 
         /**
@@ -431,9 +435,6 @@ export namespace ExampleUpdateResponse {
          */
         bbox?: Array<number>;
 
-        /**
-         * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
-         */
         betterQuality?: boolean;
 
         /**
@@ -509,9 +510,6 @@ export namespace ExampleUpdateResponse {
          */
         detailsLevel?: number;
 
-        /**
-         * The number of pixels to dilate the result masks.
-         */
         dilate?: number;
 
         /**
@@ -816,12 +814,16 @@ export namespace ExampleUpdateResponse {
         resultContours?: boolean;
 
         /**
-         * Boolean to able output the cut out object.
+         * Boolean to return the source image with the mask applied as alpha channel (RGBA
+         * PNG, transparent background) instead of the binary mask. Mutually exclusive with
+         * `resultMask` — passing both as `true` returns a 400 error. Note:
+         * `backgroundOpacity` is no longer honored — alpha is binary (0/255) only.
          */
         resultImage?: boolean;
 
         /**
-         * Boolean to able return the masks (binary image) in the response.
+         * Boolean to return the binary masks in the response. Mutually exclusive with
+         * `resultImage` — passing both as `true` returns a 400 error.
          */
         resultMask?: boolean;
 
@@ -1041,6 +1043,13 @@ export namespace ExampleUpdateResponse {
          */
         channels?: number;
 
+        /**
+         * Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
+         * counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
+         * several).
+         */
+        charCount?: number;
+
         /**
          * Classification of the audio
          */
@@ -1086,6 +1095,14 @@ export namespace ExampleUpdateResponse {
          */
         hasAnimations?: boolean;
 
+        /**
+         * True when `preview` holds the entire content unmodified — consumers can use it
+         * directly without fetching `asset.url`. False or undefined means the content
+         * exceeds the preview budget and consumers must fetch the full body from S3 to
+         * read past the preview.
+         */
+        hasFullPreview?: boolean;
+
         /**
          * Whether the mesh has normal vectors
          */
@@ -1108,6 +1125,15 @@ export namespace ExampleUpdateResponse {
          */
         nbFrames?: number;
 
+        /**
+         * Leading slice of the content used for inline UI display and as a search
+         * shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
+         * code-point boundary so no character is split. Number of characters in the
+         * preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
+         * emoji-heavy text at the default 1 KB budget).
+         */
+        preview?: string;
+
         /**
          * Sample rate of the media in Hz
          */
@@ -1124,6 +1150,11 @@ export namespace ExampleUpdateResponse {
         vertexCount?: number;
 
         width?: number;
+
+        /**
+         * Number of whitespace-separated words in the text
+         */
+        wordCount?: number;
       }
 
       export namespace Properties {
@@ -1917,7 +1948,7 @@ export namespace ExampleUpdateResponse {
              * not able to create the asset on the flight on API side with dataurl without
              * data:kind, prefix
              */
-            kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+            kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
             /**
              * The label displayed in the UI for this input
@@ -2150,7 +2181,7 @@ export namespace ExampleUpdateResponse {
                * not able to create the asset on the flight on API side with dataurl without
                * data:kind, prefix
                */
-              kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+              kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
               /**
                * The label displayed in the UI for this input
@@ -2585,7 +2616,7 @@ export namespace ExampleListResponse {
       /**
        * The kind of asset
        */
-      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * Metadata of the asset with some additional information
@@ -2626,6 +2657,7 @@ export namespace ExampleListResponse {
         | '3d:texture:normal'
         | '3d:texture:roughness'
         | 'audio2audio'
+        | 'audio2txt'
         | 'audio2video'
         | 'background-removal'
         | 'canvas'
@@ -2636,6 +2668,7 @@ export namespace ExampleListResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2txt'
         | 'img2video'
         | 'inference-control-net'
         | 'inference-control-net-img'
@@ -2675,12 +2708,14 @@ export namespace ExampleListResponse {
         | 'txt23d'
         | 'txt2audio'
         | 'txt2img'
+        | 'txt2txt'
         | 'txt2video'
         | 'unknown'
         | 'uploaded'
         | 'uploaded-3d'
         | 'uploaded-audio'
         | 'uploaded-avatar'
+        | 'uploaded-text'
         | 'uploaded-video'
         | 'upscale'
         | 'upscale-skybox'
@@ -2795,7 +2830,7 @@ export namespace ExampleListResponse {
        * Metadata of the asset with some additional information
        */
       export interface Metadata {
-        kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+        kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
         /**
          * The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
@@ -2811,6 +2846,7 @@ export namespace ExampleListResponse {
           | '3d23d'
           | '3d23d-texture'
           | 'audio2audio'
+          | 'audio2txt'
           | 'audio2video'
           | 'background-removal'
           | 'canvas'
@@ -2821,6 +2857,7 @@ export namespace ExampleListResponse {
           | 'image-prompt-editing'
           | 'img23d'
           | 'img2img'
+          | 'img2txt'
           | 'img2video'
           | 'inference-controlnet'
           | 'inference-controlnet-img2img'
@@ -2860,12 +2897,14 @@ export namespace ExampleListResponse {
           | 'txt23d'
           | 'txt2audio'
           | 'txt2img'
+          | 'txt2txt'
           | 'txt2video'
           | 'unknown'
           | 'uploaded'
           | 'uploaded-3d'
           | 'uploaded-audio'
           | 'uploaded-avatar'
+          | 'uploaded-text'
           | 'uploaded-video'
           | 'upscale'
           | 'upscale-skybox'
@@ -2889,10 +2928,6 @@ export namespace ExampleListResponse {
          */
         aspectRatio?: string;
 
-        /**
-         * Int to set between 0 and 255 for the opacity of the background in the result
-         * images.
-         */
         backgroundOpacity?: number;
 
         /**
@@ -2905,9 +2940,6 @@ export namespace ExampleListResponse {
          */
         bbox?: Array<number>;
 
-        /**
-         * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
-         */
         betterQuality?: boolean;
 
         /**
@@ -2983,9 +3015,6 @@ export namespace ExampleListResponse {
          */
         detailsLevel?: number;
 
-        /**
-         * The number of pixels to dilate the result masks.
-         */
         dilate?: number;
 
         /**
@@ -3290,12 +3319,16 @@ export namespace ExampleListResponse {
         resultContours?: boolean;
 
         /**
-         * Boolean to able output the cut out object.
+         * Boolean to return the source image with the mask applied as alpha channel (RGBA
+         * PNG, transparent background) instead of the binary mask. Mutually exclusive with
+         * `resultMask` — passing both as `true` returns a 400 error. Note:
+         * `backgroundOpacity` is no longer honored — alpha is binary (0/255) only.
          */
         resultImage?: boolean;
 
         /**
-         * Boolean to able return the masks (binary image) in the response.
+         * Boolean to return the binary masks in the response. Mutually exclusive with
+         * `resultImage` — passing both as `true` returns a 400 error.
          */
         resultMask?: boolean;
 
@@ -3515,6 +3548,13 @@ export namespace ExampleListResponse {
          */
         channels?: number;
 
+        /**
+         * Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
+         * counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
+         * several).
+         */
+        charCount?: number;
+
         /**
          * Classification of the audio
          */
@@ -3560,6 +3600,14 @@ export namespace ExampleListResponse {
          */
         hasAnimations?: boolean;
 
+        /**
+         * True when `preview` holds the entire content unmodified — consumers can use it
+         * directly without fetching `asset.url`. False or undefined means the content
+         * exceeds the preview budget and consumers must fetch the full body from S3 to
+         * read past the preview.
+         */
+        hasFullPreview?: boolean;
+
         /**
          * Whether the mesh has normal vectors
          */
@@ -3582,6 +3630,15 @@ export namespace ExampleListResponse {
          */
         nbFrames?: number;
 
+        /**
+         * Leading slice of the content used for inline UI display and as a search
+         * shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
+         * code-point boundary so no character is split. Number of characters in the
+         * preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
+         * emoji-heavy text at the default 1 KB budget).
+         */
+        preview?: string;
+
         /**
          * Sample rate of the media in Hz
          */
@@ -3598,6 +3655,11 @@ export namespace ExampleListResponse {
         vertexCount?: number;
 
         width?: number;
+
+        /**
+         * Number of whitespace-separated words in the text
+         */
+        wordCount?: number;
       }
 
       export namespace Properties {
@@ -4391,7 +4453,7 @@ export namespace ExampleListResponse {
              * not able to create the asset on the flight on API side with dataurl without
              * data:kind, prefix
              */
-            kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+            kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
             /**
              * The label displayed in the UI for this input
@@ -4624,7 +4686,7 @@ export namespace ExampleListResponse {
                * not able to create the asset on the flight on API side with dataurl without
                * data:kind, prefix
                */
-              kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+              kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
               /**
                * The label displayed in the UI for this input