retell-sdk 5.64.0 → 5.66.0

package/resources/conversation-flow-component.d.ts

@@ -133,6 +133,10 @@ export declare namespace ConversationFlowComponentResponse {
          */
         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
          */
@@ -169,6 +173,12 @@ export declare namespace ConversationFlowComponentResponse {
         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 {
@@ -242,6 +252,20 @@ export declare namespace ConversationFlowComponentResponse {
                 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
          */
@@ -601,6 +625,10 @@ export declare namespace ConversationFlowComponentResponse {
          */
         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
          */
@@ -637,6 +665,12 @@ export declare namespace ConversationFlowComponentResponse {
         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.
@@ -710,6 +744,20 @@ export declare namespace ConversationFlowComponentResponse {
                 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
          */
@@ -1377,6 +1425,9 @@ export declare namespace ConversationFlowComponentResponse {
                 }
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -1411,6 +1462,9 @@ export declare namespace ConversationFlowComponentResponse {
              */
             timezone?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -6053,6 +6107,9 @@ export declare namespace ConversationFlowComponentResponse {
             required?: Array<string>;
         }
     }
+    /**
+     * @deprecated
+     */
     interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -6091,6 +6148,9 @@ export declare namespace ConversationFlowComponentResponse {
          */
         tool_id?: string;
     }
+    /**
+     * @deprecated
+     */
     interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book
@@ -6134,8 +6194,8 @@ export interface ConversationFlowComponentListResponse {
     /**
      * Whether more results are available.
      */
-    has_more?: boolean;
-    items?: Array<ConversationFlowComponentResponse>;
+    has_more: boolean;
+    items: Array<ConversationFlowComponentResponse>;
     /**
      * Pagination key for the next page.
      */
@@ -6191,6 +6251,10 @@ export declare namespace ConversationFlowComponentCreateParams {
          */
         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
          */
@@ -6227,6 +6291,12 @@ export declare namespace ConversationFlowComponentCreateParams {
         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 {
@@ -6300,6 +6370,20 @@ export declare namespace ConversationFlowComponentCreateParams {
                 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
          */
@@ -6659,6 +6743,10 @@ export declare namespace ConversationFlowComponentCreateParams {
          */
         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
          */
@@ -6695,6 +6783,12 @@ export declare namespace ConversationFlowComponentCreateParams {
         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.
@@ -6768,6 +6862,20 @@ export declare namespace ConversationFlowComponentCreateParams {
                 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
          */
@@ -7435,6 +7543,9 @@ export declare namespace ConversationFlowComponentCreateParams {
                 }
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -7469,6 +7580,9 @@ export declare namespace ConversationFlowComponentCreateParams {
              */
             timezone?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -12111,6 +12225,9 @@ export declare namespace ConversationFlowComponentCreateParams {
             required?: Array<string>;
         }
     }
+    /**
+     * @deprecated
+     */
     interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -12149,6 +12266,9 @@ export declare namespace ConversationFlowComponentCreateParams {
          */
         tool_id?: string;
     }
+    /**
+     * @deprecated
+     */
     interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book
@@ -12269,6 +12389,10 @@ export declare namespace ConversationFlowComponentUpdateParams {
          */
         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
          */
@@ -12305,6 +12429,12 @@ export declare namespace ConversationFlowComponentUpdateParams {
         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 {
@@ -12378,6 +12508,20 @@ export declare namespace ConversationFlowComponentUpdateParams {
                 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
          */
@@ -12737,6 +12881,10 @@ export declare namespace ConversationFlowComponentUpdateParams {
          */
         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
          */
@@ -12773,6 +12921,12 @@ export declare namespace ConversationFlowComponentUpdateParams {
         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.
@@ -12846,6 +13000,20 @@ export declare namespace ConversationFlowComponentUpdateParams {
                 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
          */
@@ -13513,6 +13681,9 @@ export declare namespace ConversationFlowComponentUpdateParams {
                 }
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -13547,6 +13718,9 @@ export declare namespace ConversationFlowComponentUpdateParams {
              */
             timezone?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -18158,6 +18332,9 @@ export declare namespace ConversationFlowComponentUpdateParams {
             required?: Array<string>;
         }
     }
+    /**
+     * @deprecated
+     */
     interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -18196,6 +18373,9 @@ export declare namespace ConversationFlowComponentUpdateParams {
          */
         tool_id?: string;
     }
+    /**
+     * @deprecated
+     */
     interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book