@scenario-labs/sdk 2.0.0 → 2.2.0

package/src/resources/generate.ts

@@ -491,7 +491,7 @@ export namespace GenerateCaptionResponse {
            * 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
@@ -724,7 +724,7 @@ export namespace GenerateCaptionResponse {
              * 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
@@ -1477,7 +1477,7 @@ export namespace GenerateDescribeStyleResponse {
            * 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
@@ -1710,7 +1710,7 @@ export namespace GenerateDescribeStyleResponse {
              * 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
@@ -2455,7 +2455,7 @@ export namespace GenerateDetectResponse {
            * 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
@@ -2688,7 +2688,7 @@ export namespace GenerateDetectResponse {
              * 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
@@ -3085,7 +3085,7 @@ export namespace GenerateDetectResponse {
     /**
      * 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
@@ -3126,6 +3126,7 @@ export namespace GenerateDetectResponse {
       | '3d:texture:normal'
       | '3d:texture:roughness'
       | 'audio2audio'
+      | 'audio2txt'
       | 'audio2video'
       | 'background-removal'
       | 'canvas'
@@ -3136,6 +3137,7 @@ export namespace GenerateDetectResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2txt'
       | 'img2video'
       | 'inference-control-net'
       | 'inference-control-net-img'
@@ -3175,12 +3177,14 @@ export namespace GenerateDetectResponse {
       | 'txt23d'
       | 'txt2audio'
       | 'txt2img'
+      | 'txt2txt'
       | 'txt2video'
       | 'unknown'
       | 'uploaded'
       | 'uploaded-3d'
       | 'uploaded-audio'
       | 'uploaded-avatar'
+      | 'uploaded-text'
       | 'uploaded-video'
       | 'upscale'
       | 'upscale-skybox'
@@ -3295,7 +3299,7 @@ export namespace GenerateDetectResponse {
      * 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
@@ -3311,6 +3315,7 @@ export namespace GenerateDetectResponse {
         | '3d23d'
         | '3d23d-texture'
         | 'audio2audio'
+        | 'audio2txt'
         | 'audio2video'
         | 'background-removal'
         | 'canvas'
@@ -3321,6 +3326,7 @@ export namespace GenerateDetectResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2txt'
         | 'img2video'
         | 'inference-controlnet'
         | 'inference-controlnet-img2img'
@@ -3360,12 +3366,14 @@ export namespace GenerateDetectResponse {
         | 'txt23d'
         | 'txt2audio'
         | 'txt2img'
+        | 'txt2txt'
         | 'txt2video'
         | 'unknown'
         | 'uploaded'
         | 'uploaded-3d'
         | 'uploaded-audio'
         | 'uploaded-avatar'
+        | 'uploaded-text'
         | 'uploaded-video'
         | 'upscale'
         | 'upscale-skybox'
@@ -3389,10 +3397,6 @@ export namespace GenerateDetectResponse {
        */
       aspectRatio?: string;
 
-      /**
-       * Int to set between 0 and 255 for the opacity of the background in the result
-       * images.
-       */
       backgroundOpacity?: number;
 
       /**
@@ -3405,9 +3409,6 @@ export namespace GenerateDetectResponse {
        */
       bbox?: Array<number>;
 
-      /**
-       * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
-       */
       betterQuality?: boolean;
 
       /**
@@ -3483,9 +3484,6 @@ export namespace GenerateDetectResponse {
        */
       detailsLevel?: number;
 
-      /**
-       * The number of pixels to dilate the result masks.
-       */
       dilate?: number;
 
       /**
@@ -3790,12 +3788,16 @@ export namespace GenerateDetectResponse {
       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;
 
@@ -4015,6 +4017,13 @@ export namespace GenerateDetectResponse {
        */
       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
        */
@@ -4060,6 +4069,14 @@ export namespace GenerateDetectResponse {
        */
       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
        */
@@ -4082,6 +4099,15 @@ export namespace GenerateDetectResponse {
        */
       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
        */
@@ -4098,6 +4124,11 @@ export namespace GenerateDetectResponse {
       vertexCount?: number;
 
       width?: number;
+
+      /**
+       * Number of whitespace-separated words in the text
+       */
+      wordCount?: number;
     }
 
     export namespace Properties {
@@ -4548,7 +4579,7 @@ export namespace GenerateEmbedResponse {
            * 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
@@ -4781,7 +4812,7 @@ export namespace GenerateEmbedResponse {
              * 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
@@ -5526,7 +5557,7 @@ export namespace GeneratePatchResponse {
            * 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
@@ -5759,7 +5790,7 @@ export namespace GeneratePatchResponse {
              * 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
@@ -6156,7 +6187,7 @@ export namespace GeneratePatchResponse {
     /**
      * 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
@@ -6197,6 +6228,7 @@ export namespace GeneratePatchResponse {
       | '3d:texture:normal'
       | '3d:texture:roughness'
       | 'audio2audio'
+      | 'audio2txt'
       | 'audio2video'
       | 'background-removal'
       | 'canvas'
@@ -6207,6 +6239,7 @@ export namespace GeneratePatchResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2txt'
       | 'img2video'
       | 'inference-control-net'
       | 'inference-control-net-img'
@@ -6246,12 +6279,14 @@ export namespace GeneratePatchResponse {
       | 'txt23d'
       | 'txt2audio'
       | 'txt2img'
+      | 'txt2txt'
       | 'txt2video'
       | 'unknown'
       | 'uploaded'
       | 'uploaded-3d'
       | 'uploaded-audio'
       | 'uploaded-avatar'
+      | 'uploaded-text'
       | 'uploaded-video'
       | 'upscale'
       | 'upscale-skybox'
@@ -6366,7 +6401,7 @@ export namespace GeneratePatchResponse {
      * 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
@@ -6382,6 +6417,7 @@ export namespace GeneratePatchResponse {
         | '3d23d'
         | '3d23d-texture'
         | 'audio2audio'
+        | 'audio2txt'
         | 'audio2video'
         | 'background-removal'
         | 'canvas'
@@ -6392,6 +6428,7 @@ export namespace GeneratePatchResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2txt'
         | 'img2video'
         | 'inference-controlnet'
         | 'inference-controlnet-img2img'
@@ -6431,12 +6468,14 @@ export namespace GeneratePatchResponse {
         | 'txt23d'
         | 'txt2audio'
         | 'txt2img'
+        | 'txt2txt'
         | 'txt2video'
         | 'unknown'
         | 'uploaded'
         | 'uploaded-3d'
         | 'uploaded-audio'
         | 'uploaded-avatar'
+        | 'uploaded-text'
         | 'uploaded-video'
         | 'upscale'
         | 'upscale-skybox'
@@ -6460,10 +6499,6 @@ export namespace GeneratePatchResponse {
        */
       aspectRatio?: string;
 
-      /**
-       * Int to set between 0 and 255 for the opacity of the background in the result
-       * images.
-       */
       backgroundOpacity?: number;
 
       /**
@@ -6476,9 +6511,6 @@ export namespace GeneratePatchResponse {
        */
       bbox?: Array<number>;
 
-      /**
-       * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
-       */
       betterQuality?: boolean;
 
       /**
@@ -6554,9 +6586,6 @@ export namespace GeneratePatchResponse {
        */
       detailsLevel?: number;
 
-      /**
-       * The number of pixels to dilate the result masks.
-       */
       dilate?: number;
 
       /**
@@ -6861,12 +6890,16 @@ export namespace GeneratePatchResponse {
       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;
 
@@ -7086,6 +7119,13 @@ export namespace GeneratePatchResponse {
        */
       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
        */
@@ -7131,6 +7171,14 @@ export namespace GeneratePatchResponse {
        */
       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
        */
@@ -7153,6 +7201,15 @@ export namespace GeneratePatchResponse {
        */
       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
        */
@@ -7169,6 +7226,11 @@ export namespace GeneratePatchResponse {
       vertexCount?: number;
 
       width?: number;
+
+      /**
+       * Number of whitespace-separated words in the text
+       */
+      wordCount?: number;
     }
 
     export namespace Properties {
@@ -7622,7 +7684,7 @@ export namespace GeneratePromptResponse {
            * 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
@@ -7855,7 +7917,7 @@ export namespace GeneratePromptResponse {
              * 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
@@ -8598,7 +8660,7 @@ export namespace GenerateRunModelResponse {
            * 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
@@ -8831,7 +8893,7 @@ export namespace GenerateRunModelResponse {
              * 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
@@ -9584,7 +9646,7 @@ export namespace GenerateTranslateResponse {
            * 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
@@ -9817,7 +9879,7 @@ export namespace GenerateTranslateResponse {
              * 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

package/src/resources/jobs.ts

@@ -418,7 +418,7 @@ export namespace JobRetrieveResponse {
            * 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
@@ -651,7 +651,7 @@ export namespace JobRetrieveResponse {
              * 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
@@ -1379,7 +1379,7 @@ export namespace JobListResponse {
          * 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
@@ -1612,7 +1612,7 @@ export namespace JobListResponse {
            * 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
@@ -2344,7 +2344,7 @@ export namespace JobTriggerActionResponse {
            * 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
@@ -2577,7 +2577,7 @@ export namespace JobTriggerActionResponse {
              * 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