@scenario-labs/sdk 2.2.1 → 2.4.0-alpha.1

package/resources/models/models.d.ts

@@ -914,11 +914,16 @@ export declare namespace ModelCreateResponse {
             /**
              * The stage of the request
              */
-            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'ready-for-captcha' | 'running-train' | 'starting-train';
             /**
              * Timestamp in milliseconds of the last time the training progress was updated
              */
             updatedAt: number;
+            /**
+             * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+             * present when stage === 'pending-captcha'. Overwritten on each retry.
+             */
+            captchaImageUrl?: string;
             /**
              * Position of the job in the queue (ie. the number of job in the queue before this
              * one)
@@ -932,6 +937,18 @@ export declare namespace ModelCreateResponse {
              * The remaining time in milliseconds
              */
             remainingTimeMs?: number;
+            /**
+             * Last recoverable failure message during PVC. Present when the model has bounced
+             * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+             * captcha rejected, time limit exceeded). Surface above the retry button so the
+             * user understands why they're back here.
+             */
+            retryableError?: string;
+            /**
+             * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+             * model is marked Failed when this reaches the platform's max retries.
+             */
+            retryCount?: number;
             /**
              * The timestamp in millisecond marking the start of the process
              */
@@ -1918,11 +1935,16 @@ export declare namespace ModelRetrieveResponse {
             /**
              * The stage of the request
              */
-            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'ready-for-captcha' | 'running-train' | 'starting-train';
             /**
              * Timestamp in milliseconds of the last time the training progress was updated
              */
             updatedAt: number;
+            /**
+             * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+             * present when stage === 'pending-captcha'. Overwritten on each retry.
+             */
+            captchaImageUrl?: string;
             /**
              * Position of the job in the queue (ie. the number of job in the queue before this
              * one)
@@ -1936,6 +1958,18 @@ export declare namespace ModelRetrieveResponse {
              * The remaining time in milliseconds
              */
             remainingTimeMs?: number;
+            /**
+             * Last recoverable failure message during PVC. Present when the model has bounced
+             * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+             * captcha rejected, time limit exceeded). Surface above the retry button so the
+             * user understands why they're back here.
+             */
+            retryableError?: string;
+            /**
+             * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+             * model is marked Failed when this reaches the platform's max retries.
+             */
+            retryCount?: number;
             /**
              * The timestamp in millisecond marking the start of the process
              */
@@ -2922,11 +2956,16 @@ export declare namespace ModelUpdateResponse {
             /**
              * The stage of the request
              */
-            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'ready-for-captcha' | 'running-train' | 'starting-train';
             /**
              * Timestamp in milliseconds of the last time the training progress was updated
              */
             updatedAt: number;
+            /**
+             * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+             * present when stage === 'pending-captcha'. Overwritten on each retry.
+             */
+            captchaImageUrl?: string;
             /**
              * Position of the job in the queue (ie. the number of job in the queue before this
              * one)
@@ -2940,6 +2979,18 @@ export declare namespace ModelUpdateResponse {
              * The remaining time in milliseconds
              */
             remainingTimeMs?: number;
+            /**
+             * Last recoverable failure message during PVC. Present when the model has bounced
+             * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+             * captcha rejected, time limit exceeded). Surface above the retry button so the
+             * user understands why they're back here.
+             */
+            retryableError?: string;
+            /**
+             * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+             * model is marked Failed when this reaches the platform's max retries.
+             */
+            retryCount?: number;
             /**
              * The timestamp in millisecond marking the start of the process
              */
@@ -3922,11 +3973,16 @@ export declare namespace ModelListResponse {
         /**
          * The stage of the request
          */
-        stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+        stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'ready-for-captcha' | 'running-train' | 'starting-train';
         /**
          * Timestamp in milliseconds of the last time the training progress was updated
          */
         updatedAt: number;
+        /**
+         * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+         * present when stage === 'pending-captcha'. Overwritten on each retry.
+         */
+        captchaImageUrl?: string;
         /**
          * Position of the job in the queue (ie. the number of job in the queue before this
          * one)
@@ -3940,6 +3996,18 @@ export declare namespace ModelListResponse {
          * The remaining time in milliseconds
          */
         remainingTimeMs?: number;
+        /**
+         * Last recoverable failure message during PVC. Present when the model has bounced
+         * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+         * captcha rejected, time limit exceeded). Surface above the retry button so the
+         * user understands why they're back here.
+         */
+        retryableError?: string;
+        /**
+         * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+         * model is marked Failed when this reaches the platform's max retries.
+         */
+        retryCount?: number;
         /**
          * The timestamp in millisecond marking the start of the process
          */
@@ -4926,11 +4994,16 @@ export declare namespace ModelCopyResponse {
             /**
              * The stage of the request
              */
-            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'ready-for-captcha' | 'running-train' | 'starting-train';
             /**
              * Timestamp in milliseconds of the last time the training progress was updated
              */
             updatedAt: number;
+            /**
+             * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+             * present when stage === 'pending-captcha'. Overwritten on each retry.
+             */
+            captchaImageUrl?: string;
             /**
              * Position of the job in the queue (ie. the number of job in the queue before this
              * one)
@@ -4944,6 +5017,18 @@ export declare namespace ModelCopyResponse {
              * The remaining time in milliseconds
              */
             remainingTimeMs?: number;
+            /**
+             * Last recoverable failure message during PVC. Present when the model has bounced
+             * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+             * captcha rejected, time limit exceeded). Surface above the retry button so the
+             * user understands why they're back here.
+             */
+            retryableError?: string;
+            /**
+             * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+             * model is marked Failed when this reaches the platform's max retries.
+             */
+            retryCount?: number;
             /**
              * The timestamp in millisecond marking the start of the process
              */
@@ -5937,11 +6022,16 @@ export declare namespace ModelGetBulkResponse {
             /**
              * The stage of the request
              */
-            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'ready-for-captcha' | 'running-train' | 'starting-train';
             /**
              * Timestamp in milliseconds of the last time the training progress was updated
              */
             updatedAt: number;
+            /**
+             * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+             * present when stage === 'pending-captcha'. Overwritten on each retry.
+             */
+            captchaImageUrl?: string;
             /**
              * Position of the job in the queue (ie. the number of job in the queue before this
              * one)
@@ -5955,6 +6045,18 @@ export declare namespace ModelGetBulkResponse {
              * The remaining time in milliseconds
              */
             remainingTimeMs?: number;
+            /**
+             * Last recoverable failure message during PVC. Present when the model has bounced
+             * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+             * captcha rejected, time limit exceeded). Surface above the retry button so the
+             * user understands why they're back here.
+             */
+            retryableError?: string;
+            /**
+             * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+             * model is marked Failed when this reaches the platform's max retries.
+             */
+            retryCount?: number;
             /**
              * The timestamp in millisecond marking the start of the process
              */
@@ -6941,11 +7043,16 @@ export declare namespace ModelTransferResponse {
             /**
              * The stage of the request
              */
-            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
+            stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'ready-for-captcha' | 'running-train' | 'starting-train';
             /**
              * Timestamp in milliseconds of the last time the training progress was updated
              */
             updatedAt: number;
+            /**
+             * Signed URL of the captcha image to read aloud during PVC voice cloning. Only
+             * present when stage === 'pending-captcha'. Overwritten on each retry.
+             */
+            captchaImageUrl?: string;
             /**
              * Position of the job in the queue (ie. the number of job in the queue before this
              * one)
@@ -6959,6 +7066,18 @@ export declare namespace ModelTransferResponse {
              * The remaining time in milliseconds
              */
             remainingTimeMs?: number;
+            /**
+             * Last recoverable failure message during PVC. Present when the model has bounced
+             * back to stage === 'ready-for-captcha' after a step 2 or step 3 failure (e.g.
+             * captcha rejected, time limit exceeded). Surface above the retry button so the
+             * user understands why they're back here.
+             */
+            retryableError?: string;
+            /**
+             * Number of consecutive PVC step 2 / step 3 failures on this voice model. The
+             * model is marked Failed when this reaches the platform's max retries.
+             */
+            retryCount?: number;
             /**
              * The timestamp in millisecond marking the start of the process
              */