@scenario-labs/sdk 2.0.0 → 2.2.0

package/resources/generate.d.ts

@@ -323,7 +323,7 @@ export declare 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
                      */
@@ -481,7 +481,7 @@ export declare 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
                          */
@@ -1027,7 +1027,7 @@ export declare 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
                      */
@@ -1185,7 +1185,7 @@ export declare 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
                          */
@@ -1724,7 +1724,7 @@ export declare 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
                      */
@@ -1882,7 +1882,7 @@ export declare 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
                          */
@@ -2173,7 +2173,7 @@ export declare 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
          */
@@ -2198,7 +2198,7 @@ export declare namespace GenerateDetectResponse {
         /**
          * source of the asset
          */
-        source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
+        source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
         /**
          * The actual status
          */
@@ -2286,12 +2286,12 @@ export declare namespace GenerateDetectResponse {
          * Metadata of the asset with some additional information
          */
         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
              * from a text to image model
              */
-            type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
+            type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
             /**
              * How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
              */
@@ -2301,10 +2301,6 @@ export declare namespace GenerateDetectResponse {
              * models
              */
             aspectRatio?: string;
-            /**
-             * Int to set between 0 and 255 for the opacity of the background in the result
-             * images.
-             */
             backgroundOpacity?: number;
             /**
              * The baseModelId that maybe changed at inference time
@@ -2314,9 +2310,6 @@ export declare namespace GenerateDetectResponse {
              * A bounding box around the object of interest, in the format [x1, y1, x2, y2].
              */
             bbox?: Array<number>;
-            /**
-             * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
-             */
             betterQuality?: boolean;
             /**
              * The control image already processed by canny detector. Must reference an
@@ -2375,9 +2368,6 @@ export declare namespace GenerateDetectResponse {
              * Amount of details to remove or add
              */
             detailsLevel?: number;
-            /**
-             * The number of pixels to dilate the result masks.
-             */
             dilate?: number;
             /**
              * Contrast factor for Grayscale detector
@@ -2579,11 +2569,15 @@ export declare 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;
             rootParentId?: string;
@@ -2739,6 +2733,12 @@ export declare namespace GenerateDetectResponse {
              * Number of channels of the audio
              */
             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
              */
@@ -2775,6 +2775,13 @@ export declare namespace GenerateDetectResponse {
              * Whether the mesh has animations
              */
             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
              */
@@ -2792,6 +2799,14 @@ export declare namespace GenerateDetectResponse {
              * Number of frames in the video
              */
             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
              */
@@ -2805,6 +2820,10 @@ export declare namespace GenerateDetectResponse {
              */
             vertexCount?: number;
             width?: number;
+            /**
+             * Number of whitespace-separated words in the text
+             */
+            wordCount?: number;
         }
         namespace Properties {
             /**
@@ -3128,7 +3147,7 @@ export declare 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
                      */
@@ -3286,7 +3305,7 @@ export declare 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
                          */
@@ -3825,7 +3844,7 @@ export declare 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
                      */
@@ -3983,7 +4002,7 @@ export declare 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
                          */
@@ -4274,7 +4293,7 @@ export declare 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
          */
@@ -4299,7 +4318,7 @@ export declare namespace GeneratePatchResponse {
         /**
          * source of the asset
          */
-        source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
+        source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
         /**
          * The actual status
          */
@@ -4387,12 +4406,12 @@ export declare namespace GeneratePatchResponse {
          * Metadata of the asset with some additional information
          */
         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
              * from a text to image model
              */
-            type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
+            type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
             /**
              * How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
              */
@@ -4402,10 +4421,6 @@ export declare namespace GeneratePatchResponse {
              * models
              */
             aspectRatio?: string;
-            /**
-             * Int to set between 0 and 255 for the opacity of the background in the result
-             * images.
-             */
             backgroundOpacity?: number;
             /**
              * The baseModelId that maybe changed at inference time
@@ -4415,9 +4430,6 @@ export declare namespace GeneratePatchResponse {
              * A bounding box around the object of interest, in the format [x1, y1, x2, y2].
              */
             bbox?: Array<number>;
-            /**
-             * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
-             */
             betterQuality?: boolean;
             /**
              * The control image already processed by canny detector. Must reference an
@@ -4476,9 +4488,6 @@ export declare namespace GeneratePatchResponse {
              * Amount of details to remove or add
              */
             detailsLevel?: number;
-            /**
-             * The number of pixels to dilate the result masks.
-             */
             dilate?: number;
             /**
              * Contrast factor for Grayscale detector
@@ -4680,11 +4689,15 @@ export declare 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;
             rootParentId?: string;
@@ -4840,6 +4853,12 @@ export declare namespace GeneratePatchResponse {
              * Number of channels of the audio
              */
             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
              */
@@ -4876,6 +4895,13 @@ export declare namespace GeneratePatchResponse {
              * Whether the mesh has animations
              */
             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
              */
@@ -4893,6 +4919,14 @@ export declare namespace GeneratePatchResponse {
              * Number of frames in the video
              */
             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
              */
@@ -4906,6 +4940,10 @@ export declare namespace GeneratePatchResponse {
              */
             vertexCount?: number;
             width?: number;
+            /**
+             * Number of whitespace-separated words in the text
+             */
+            wordCount?: number;
         }
         namespace Properties {
             /**
@@ -5231,7 +5269,7 @@ export declare 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
                      */
@@ -5389,7 +5427,7 @@ export declare 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
                          */
@@ -5927,7 +5965,7 @@ export declare 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
                      */
@@ -6085,7 +6123,7 @@ export declare 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
                          */
@@ -6631,7 +6669,7 @@ export declare 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
                      */
@@ -6789,7 +6827,7 @@ export declare 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
                          */