retell-sdk 5.65.0 → 5.66.0

package/resources/conversation-flow.d.mts

@@ -227,6 +227,10 @@ export declare namespace ConversationFlowResponse {
              */
             allow_dtmf_interruption?: boolean | null;
             always_edge?: ConversationNode.AlwaysEdge;
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            custom_stt_config?: ConversationNode.CustomSttConfig | null;
             /**
              * Position for frontend display
              */
@@ -263,6 +267,12 @@ export declare namespace ConversationFlowResponse {
             reminder_trigger_ms?: number | null;
             responsiveness?: number | null;
             skip_response_edge?: ConversationNode.SkipResponseEdge;
+            /**
+             * Balance between speed and accuracy. Fast optimizes for speed using the provider
+             * configuration, accurate optimizes for accuracy using the provider configuration,
+             * and custom uses custom_stt_config.
+             */
+            stt_mode?: 'fast' | 'accurate' | 'custom' | null;
             voice_speed?: number | null;
         }
         namespace ConversationNode {
@@ -336,6 +346,20 @@ export declare namespace ConversationFlowResponse {
                     type: 'prompt';
                 }
             }
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            interface CustomSttConfig {
+                /**
+                 * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+                 * 500 for Soniox, and 100 for AssemblyAI.
+                 */
+                endpointing_ms: number;
+                /**
+                 * ASR provider name.
+                 */
+                provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+            }
             /**
              * Position for frontend display
              */
@@ -695,6 +719,10 @@ export declare namespace ConversationFlowResponse {
              */
             allow_dtmf_interruption?: boolean | null;
             always_edge?: SubagentNode.AlwaysEdge;
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            custom_stt_config?: SubagentNode.CustomSttConfig | null;
             /**
              * Position for frontend display
              */
@@ -731,6 +759,12 @@ export declare namespace ConversationFlowResponse {
             reminder_trigger_ms?: number | null;
             responsiveness?: number | null;
             skip_response_edge?: SubagentNode.SkipResponseEdge;
+            /**
+             * Balance between speed and accuracy. Fast optimizes for speed using the provider
+             * configuration, accurate optimizes for accuracy using the provider configuration,
+             * and custom uses custom_stt_config.
+             */
+            stt_mode?: 'fast' | 'accurate' | 'custom' | null;
             /**
              * The tool ids of the tools defined in main conversation flow or component that
              * can be used in this subagent node.
@@ -804,6 +838,20 @@ export declare namespace ConversationFlowResponse {
                     type: 'prompt';
                 }
             }
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            interface CustomSttConfig {
+                /**
+                 * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+                 * 500 for Soniox, and 100 for AssemblyAI.
+                 */
+                endpointing_ms: number;
+                /**
+                 * ASR provider name.
+                 */
+                provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+            }
             /**
              * Position for frontend display
              */
@@ -6305,6 +6353,10 @@ export declare namespace ConversationFlowResponse {
          */
         allow_dtmf_interruption?: boolean | null;
         always_edge?: ConversationNode.AlwaysEdge;
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        custom_stt_config?: ConversationNode.CustomSttConfig | null;
         /**
          * Position for frontend display
          */
@@ -6341,6 +6393,12 @@ export declare namespace ConversationFlowResponse {
         reminder_trigger_ms?: number | null;
         responsiveness?: number | null;
         skip_response_edge?: ConversationNode.SkipResponseEdge;
+        /**
+         * Balance between speed and accuracy. Fast optimizes for speed using the provider
+         * configuration, accurate optimizes for accuracy using the provider configuration,
+         * and custom uses custom_stt_config.
+         */
+        stt_mode?: 'fast' | 'accurate' | 'custom' | null;
         voice_speed?: number | null;
     }
     namespace ConversationNode {
@@ -6414,6 +6472,20 @@ export declare namespace ConversationFlowResponse {
                 type: 'prompt';
             }
         }
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        interface CustomSttConfig {
+            /**
+             * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+             * 500 for Soniox, and 100 for AssemblyAI.
+             */
+            endpointing_ms: number;
+            /**
+             * ASR provider name.
+             */
+            provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+        }
         /**
          * Position for frontend display
          */
@@ -6773,6 +6845,10 @@ export declare namespace ConversationFlowResponse {
          */
         allow_dtmf_interruption?: boolean | null;
         always_edge?: SubagentNode.AlwaysEdge;
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        custom_stt_config?: SubagentNode.CustomSttConfig | null;
         /**
          * Position for frontend display
          */
@@ -6809,6 +6885,12 @@ export declare namespace ConversationFlowResponse {
         reminder_trigger_ms?: number | null;
         responsiveness?: number | null;
         skip_response_edge?: SubagentNode.SkipResponseEdge;
+        /**
+         * Balance between speed and accuracy. Fast optimizes for speed using the provider
+         * configuration, accurate optimizes for accuracy using the provider configuration,
+         * and custom uses custom_stt_config.
+         */
+        stt_mode?: 'fast' | 'accurate' | 'custom' | null;
         /**
          * The tool ids of the tools defined in main conversation flow or component that
          * can be used in this subagent node.
@@ -6882,6 +6964,20 @@ export declare namespace ConversationFlowResponse {
                 type: 'prompt';
             }
         }
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        interface CustomSttConfig {
+            /**
+             * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+             * 500 for Soniox, and 100 for AssemblyAI.
+             */
+            endpointing_ms: number;
+            /**
+             * ASR provider name.
+             */
+            provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+        }
         /**
          * Position for frontend display
          */
@@ -12411,6 +12507,10 @@ export declare namespace ConversationFlowCreateParams {
          */
         allow_dtmf_interruption?: boolean | null;
         always_edge?: ConversationNode.AlwaysEdge;
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        custom_stt_config?: ConversationNode.CustomSttConfig | null;
         /**
          * Position for frontend display
          */
@@ -12447,6 +12547,12 @@ export declare namespace ConversationFlowCreateParams {
         reminder_trigger_ms?: number | null;
         responsiveness?: number | null;
         skip_response_edge?: ConversationNode.SkipResponseEdge;
+        /**
+         * Balance between speed and accuracy. Fast optimizes for speed using the provider
+         * configuration, accurate optimizes for accuracy using the provider configuration,
+         * and custom uses custom_stt_config.
+         */
+        stt_mode?: 'fast' | 'accurate' | 'custom' | null;
         voice_speed?: number | null;
     }
     namespace ConversationNode {
@@ -12520,6 +12626,20 @@ export declare namespace ConversationFlowCreateParams {
                 type: 'prompt';
             }
         }
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        interface CustomSttConfig {
+            /**
+             * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+             * 500 for Soniox, and 100 for AssemblyAI.
+             */
+            endpointing_ms: number;
+            /**
+             * ASR provider name.
+             */
+            provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+        }
         /**
          * Position for frontend display
          */
@@ -12879,6 +12999,10 @@ export declare namespace ConversationFlowCreateParams {
          */
         allow_dtmf_interruption?: boolean | null;
         always_edge?: SubagentNode.AlwaysEdge;
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        custom_stt_config?: SubagentNode.CustomSttConfig | null;
         /**
          * Position for frontend display
          */
@@ -12915,6 +13039,12 @@ export declare namespace ConversationFlowCreateParams {
         reminder_trigger_ms?: number | null;
         responsiveness?: number | null;
         skip_response_edge?: SubagentNode.SkipResponseEdge;
+        /**
+         * Balance between speed and accuracy. Fast optimizes for speed using the provider
+         * configuration, accurate optimizes for accuracy using the provider configuration,
+         * and custom uses custom_stt_config.
+         */
+        stt_mode?: 'fast' | 'accurate' | 'custom' | null;
         /**
          * The tool ids of the tools defined in main conversation flow or component that
          * can be used in this subagent node.
@@ -12988,6 +13118,20 @@ export declare namespace ConversationFlowCreateParams {
                 type: 'prompt';
             }
         }
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        interface CustomSttConfig {
+            /**
+             * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+             * 500 for Soniox, and 100 for AssemblyAI.
+             */
+            endpointing_ms: number;
+            /**
+             * ASR provider name.
+             */
+            provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+        }
         /**
          * Position for frontend display
          */
@@ -18184,6 +18328,10 @@ export declare namespace ConversationFlowCreateParams {
              */
             allow_dtmf_interruption?: boolean | null;
             always_edge?: ConversationNode.AlwaysEdge;
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            custom_stt_config?: ConversationNode.CustomSttConfig | null;
             /**
              * Position for frontend display
              */
@@ -18220,6 +18368,12 @@ export declare namespace ConversationFlowCreateParams {
             reminder_trigger_ms?: number | null;
             responsiveness?: number | null;
             skip_response_edge?: ConversationNode.SkipResponseEdge;
+            /**
+             * Balance between speed and accuracy. Fast optimizes for speed using the provider
+             * configuration, accurate optimizes for accuracy using the provider configuration,
+             * and custom uses custom_stt_config.
+             */
+            stt_mode?: 'fast' | 'accurate' | 'custom' | null;
             voice_speed?: number | null;
         }
         namespace ConversationNode {
@@ -18293,6 +18447,20 @@ export declare namespace ConversationFlowCreateParams {
                     type: 'prompt';
                 }
             }
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            interface CustomSttConfig {
+                /**
+                 * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+                 * 500 for Soniox, and 100 for AssemblyAI.
+                 */
+                endpointing_ms: number;
+                /**
+                 * ASR provider name.
+                 */
+                provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+            }
             /**
              * Position for frontend display
              */
@@ -18652,6 +18820,10 @@ export declare namespace ConversationFlowCreateParams {
              */
             allow_dtmf_interruption?: boolean | null;
             always_edge?: SubagentNode.AlwaysEdge;
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            custom_stt_config?: SubagentNode.CustomSttConfig | null;
             /**
              * Position for frontend display
              */
@@ -18688,6 +18860,12 @@ export declare namespace ConversationFlowCreateParams {
             reminder_trigger_ms?: number | null;
             responsiveness?: number | null;
             skip_response_edge?: SubagentNode.SkipResponseEdge;
+            /**
+             * Balance between speed and accuracy. Fast optimizes for speed using the provider
+             * configuration, accurate optimizes for accuracy using the provider configuration,
+             * and custom uses custom_stt_config.
+             */
+            stt_mode?: 'fast' | 'accurate' | 'custom' | null;
             /**
              * The tool ids of the tools defined in main conversation flow or component that
              * can be used in this subagent node.
@@ -18761,6 +18939,20 @@ export declare namespace ConversationFlowCreateParams {
                     type: 'prompt';
                 }
             }
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            interface CustomSttConfig {
+                /**
+                 * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+                 * 500 for Soniox, and 100 for AssemblyAI.
+                 */
+                endpointing_ms: number;
+                /**
+                 * ASR provider name.
+                 */
+                provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+            }
             /**
              * Position for frontend display
              */
@@ -24647,6 +24839,10 @@ export declare namespace ConversationFlowUpdateParams {
              */
             allow_dtmf_interruption?: boolean | null;
             always_edge?: ConversationNode.AlwaysEdge;
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            custom_stt_config?: ConversationNode.CustomSttConfig | null;
             /**
              * Position for frontend display
              */
@@ -24683,6 +24879,12 @@ export declare namespace ConversationFlowUpdateParams {
             reminder_trigger_ms?: number | null;
             responsiveness?: number | null;
             skip_response_edge?: ConversationNode.SkipResponseEdge;
+            /**
+             * Balance between speed and accuracy. Fast optimizes for speed using the provider
+             * configuration, accurate optimizes for accuracy using the provider configuration,
+             * and custom uses custom_stt_config.
+             */
+            stt_mode?: 'fast' | 'accurate' | 'custom' | null;
             voice_speed?: number | null;
         }
         namespace ConversationNode {
@@ -24756,6 +24958,20 @@ export declare namespace ConversationFlowUpdateParams {
                     type: 'prompt';
                 }
             }
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            interface CustomSttConfig {
+                /**
+                 * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+                 * 500 for Soniox, and 100 for AssemblyAI.
+                 */
+                endpointing_ms: number;
+                /**
+                 * ASR provider name.
+                 */
+                provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+            }
             /**
              * Position for frontend display
              */
@@ -25115,6 +25331,10 @@ export declare namespace ConversationFlowUpdateParams {
              */
             allow_dtmf_interruption?: boolean | null;
             always_edge?: SubagentNode.AlwaysEdge;
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            custom_stt_config?: SubagentNode.CustomSttConfig | null;
             /**
              * Position for frontend display
              */
@@ -25151,6 +25371,12 @@ export declare namespace ConversationFlowUpdateParams {
             reminder_trigger_ms?: number | null;
             responsiveness?: number | null;
             skip_response_edge?: SubagentNode.SkipResponseEdge;
+            /**
+             * Balance between speed and accuracy. Fast optimizes for speed using the provider
+             * configuration, accurate optimizes for accuracy using the provider configuration,
+             * and custom uses custom_stt_config.
+             */
+            stt_mode?: 'fast' | 'accurate' | 'custom' | null;
             /**
              * The tool ids of the tools defined in main conversation flow or component that
              * can be used in this subagent node.
@@ -25224,6 +25450,20 @@ export declare namespace ConversationFlowUpdateParams {
                     type: 'prompt';
                 }
             }
+            /**
+             * Custom transcription settings. Required when stt_mode is custom.
+             */
+            interface CustomSttConfig {
+                /**
+                 * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+                 * 500 for Soniox, and 100 for AssemblyAI.
+                 */
+                endpointing_ms: number;
+                /**
+                 * ASR provider name.
+                 */
+                provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+            }
             /**
              * Position for frontend display
              */
@@ -30725,6 +30965,10 @@ export declare namespace ConversationFlowUpdateParams {
          */
         allow_dtmf_interruption?: boolean | null;
         always_edge?: ConversationNode.AlwaysEdge;
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        custom_stt_config?: ConversationNode.CustomSttConfig | null;
         /**
          * Position for frontend display
          */
@@ -30761,6 +31005,12 @@ export declare namespace ConversationFlowUpdateParams {
         reminder_trigger_ms?: number | null;
         responsiveness?: number | null;
         skip_response_edge?: ConversationNode.SkipResponseEdge;
+        /**
+         * Balance between speed and accuracy. Fast optimizes for speed using the provider
+         * configuration, accurate optimizes for accuracy using the provider configuration,
+         * and custom uses custom_stt_config.
+         */
+        stt_mode?: 'fast' | 'accurate' | 'custom' | null;
         voice_speed?: number | null;
     }
     namespace ConversationNode {
@@ -30834,6 +31084,20 @@ export declare namespace ConversationFlowUpdateParams {
                 type: 'prompt';
             }
         }
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        interface CustomSttConfig {
+            /**
+             * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+             * 500 for Soniox, and 100 for AssemblyAI.
+             */
+            endpointing_ms: number;
+            /**
+             * ASR provider name.
+             */
+            provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+        }
         /**
          * Position for frontend display
          */
@@ -31193,6 +31457,10 @@ export declare namespace ConversationFlowUpdateParams {
          */
         allow_dtmf_interruption?: boolean | null;
         always_edge?: SubagentNode.AlwaysEdge;
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        custom_stt_config?: SubagentNode.CustomSttConfig | null;
         /**
          * Position for frontend display
          */
@@ -31229,6 +31497,12 @@ export declare namespace ConversationFlowUpdateParams {
         reminder_trigger_ms?: number | null;
         responsiveness?: number | null;
         skip_response_edge?: SubagentNode.SkipResponseEdge;
+        /**
+         * Balance between speed and accuracy. Fast optimizes for speed using the provider
+         * configuration, accurate optimizes for accuracy using the provider configuration,
+         * and custom uses custom_stt_config.
+         */
+        stt_mode?: 'fast' | 'accurate' | 'custom' | null;
         /**
          * The tool ids of the tools defined in main conversation flow or component that
          * can be used in this subagent node.
@@ -31302,6 +31576,20 @@ export declare namespace ConversationFlowUpdateParams {
                 type: 'prompt';
             }
         }
+        /**
+         * Custom transcription settings. Required when stt_mode is custom.
+         */
+        interface CustomSttConfig {
+            /**
+             * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+             * 500 for Soniox, and 100 for AssemblyAI.
+             */
+            endpointing_ms: number;
+            /**
+             * ASR provider name.
+             */
+            provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+        }
         /**
          * Position for frontend display
          */