retell-sdk 4.42.0 → 4.44.0

package/resources/llm.d.ts

@@ -103,15 +103,19 @@ export interface LlmResponse {
      * Whether the Retell LLM Response Engine is published.
      */
     is_published?: boolean;
+    /**
+     * Knowledge base configuration for RAG retrieval.
+     */
+    kb_config?: LlmResponse.KBConfig | null;
     /**
      * A list of knowledge base ids to use for this resource. Set to null to remove all
      * knowledge bases.
      */
     knowledge_base_ids?: Array<string> | null;
     /**
-     * Select the underlying text LLM. If not set, would default to gpt-4o.
+     * Select the underlying text LLM. If not set, would default to gpt-4.1.
      */
-    model?: 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | null;
+    model?: 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | null;
     /**
      * If set to true, will enable fast tier, which uses high priority pool with more
      * dedicated resource to ensure lower and more consistent latency, default to
@@ -129,7 +133,7 @@ export interface LlmResponse {
      * Select the underlying speech to speech model. Can only set this or model, not
      * both.
      */
-    s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | null;
+    s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
     /**
      * Name of the starting state. Required if states is not empty.
      */
@@ -202,6 +206,11 @@ export declare namespace LlmResponse {
              * The type of transfer destination.
              */
             type: 'predefined';
+            /**
+             * Extension digits to dial after the main number connects. Sent via DTMF. Allow
+             * digits, '\*', '#'.
+             */
+            extension?: string;
         }
         interface TransferDestinationInferred {
             /**
@@ -607,15 +616,36 @@ export declare namespace LlmResponse {
         name: string;
         type: 'mcp';
         /**
-         * The input schema of the MCP tool.
+         * The description for the sentence agent say during execution. Only applicable
+         * when speak_during_execution is true. Can write what to say or even provide
+         * examples. The default is "The message you will say to callee when calling this
+         * tool. Make sure it fits into the conversation smoothly.".
          */
-        input_schema?: {
-            [key: string]: string;
-        };
+        execution_message_description?: string;
         /**
          * Unique id of the MCP.
          */
         mcp_id?: string;
+        /**
+         * Response variables to add to dynamic variables, key is the variable name, value
+         * is the path to the variable in the response
+         */
+        response_variables?: {
+            [key: string]: string;
+        };
+        /**
+         * Determines whether the agent would call LLM another time and speak when the
+         * result of function is obtained. Usually this needs to get turned on so user can
+         * get update for the function call.
+         */
+        speak_after_execution?: boolean;
+        /**
+         * Determines whether the agent would say sentence like "One moment, let me check
+         * that." when executing the function. Recommend to turn on if your function call
+         * takes over 1s (including network) to complete, so that your agent remains
+         * responsive.
+         */
+        speak_during_execution?: boolean;
     }
     interface SendSMSTool {
         /**
@@ -649,6 +679,19 @@ export declare namespace LlmResponse {
             type?: 'inferred';
         }
     }
+    /**
+     * Knowledge base configuration for RAG retrieval.
+     */
+    interface KBConfig {
+        /**
+         * Similarity threshold for filtering search results
+         */
+        filter_score?: number;
+        /**
+         * Max number of knowledge base chunks to retrieve
+         */
+        top_k?: number;
+    }
     interface State {
         /**
          * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,
@@ -776,6 +819,11 @@ export declare namespace LlmResponse {
                  * The type of transfer destination.
                  */
                 type: 'predefined';
+                /**
+                 * Extension digits to dial after the main number connects. Sent via DTMF. Allow
+                 * digits, '\*', '#'.
+                 */
+                extension?: string;
             }
             interface TransferDestinationInferred {
                 /**
@@ -1181,15 +1229,36 @@ export declare namespace LlmResponse {
             name: string;
             type: 'mcp';
             /**
-             * The input schema of the MCP tool.
+             * The description for the sentence agent say during execution. Only applicable
+             * when speak_during_execution is true. Can write what to say or even provide
+             * examples. The default is "The message you will say to callee when calling this
+             * tool. Make sure it fits into the conversation smoothly.".
              */
-            input_schema?: {
-                [key: string]: string;
-            };
+            execution_message_description?: string;
             /**
              * Unique id of the MCP.
              */
             mcp_id?: string;
+            /**
+             * Response variables to add to dynamic variables, key is the variable name, value
+             * is the path to the variable in the response
+             */
+            response_variables?: {
+                [key: string]: string;
+            };
+            /**
+             * Determines whether the agent would call LLM another time and speak when the
+             * result of function is obtained. Usually this needs to get turned on so user can
+             * get update for the function call.
+             */
+            speak_after_execution?: boolean;
+            /**
+             * Determines whether the agent would say sentence like "One moment, let me check
+             * that." when executing the function. Recommend to turn on if your function call
+             * takes over 1s (including network) to complete, so that your agent remains
+             * responsive.
+             */
+            speak_during_execution?: boolean;
         }
         interface SendSMSTool {
             /**
@@ -1258,15 +1327,19 @@ export interface LlmCreateParams {
      * - Tools of LLM (no state) = general tools
      */
     general_tools?: Array<LlmCreateParams.EndCallTool | LlmCreateParams.TransferCallTool | LlmCreateParams.CheckAvailabilityCalTool | LlmCreateParams.BookAppointmentCalTool | LlmCreateParams.PressDigitTool | LlmCreateParams.CustomTool | LlmCreateParams.ExtractDynamicVariableTool | LlmCreateParams.AgentSwapTool | LlmCreateParams.McpTool | LlmCreateParams.SendSMSTool> | null;
+    /**
+     * Knowledge base configuration for RAG retrieval.
+     */
+    kb_config?: LlmCreateParams.KBConfig | null;
     /**
      * A list of knowledge base ids to use for this resource. Set to null to remove all
      * knowledge bases.
      */
     knowledge_base_ids?: Array<string> | null;
     /**
-     * Select the underlying text LLM. If not set, would default to gpt-4o.
+     * Select the underlying text LLM. If not set, would default to gpt-4.1.
      */
-    model?: 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | null;
+    model?: 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | null;
     /**
      * If set to true, will enable fast tier, which uses high priority pool with more
      * dedicated resource to ensure lower and more consistent latency, default to
@@ -1284,7 +1357,7 @@ export interface LlmCreateParams {
      * Select the underlying speech to speech model. Can only set this or model, not
      * both.
      */
-    s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | null;
+    s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
     /**
      * Name of the starting state. Required if states is not empty.
      */
@@ -1357,6 +1430,11 @@ export declare namespace LlmCreateParams {
              * The type of transfer destination.
              */
             type: 'predefined';
+            /**
+             * Extension digits to dial after the main number connects. Sent via DTMF. Allow
+             * digits, '\*', '#'.
+             */
+            extension?: string;
         }
         interface TransferDestinationInferred {
             /**
@@ -1762,15 +1840,36 @@ export declare namespace LlmCreateParams {
         name: string;
         type: 'mcp';
         /**
-         * The input schema of the MCP tool.
+         * The description for the sentence agent say during execution. Only applicable
+         * when speak_during_execution is true. Can write what to say or even provide
+         * examples. The default is "The message you will say to callee when calling this
+         * tool. Make sure it fits into the conversation smoothly.".
+         */
+        execution_message_description?: string;
+        /**
+         * Unique id of the MCP.
+         */
+        mcp_id?: string;
+        /**
+         * Response variables to add to dynamic variables, key is the variable name, value
+         * is the path to the variable in the response
          */
-        input_schema?: {
+        response_variables?: {
             [key: string]: string;
         };
         /**
-         * Unique id of the MCP.
+         * Determines whether the agent would call LLM another time and speak when the
+         * result of function is obtained. Usually this needs to get turned on so user can
+         * get update for the function call.
          */
-        mcp_id?: string;
+        speak_after_execution?: boolean;
+        /**
+         * Determines whether the agent would say sentence like "One moment, let me check
+         * that." when executing the function. Recommend to turn on if your function call
+         * takes over 1s (including network) to complete, so that your agent remains
+         * responsive.
+         */
+        speak_during_execution?: boolean;
     }
     interface SendSMSTool {
         /**
@@ -1804,6 +1903,19 @@ export declare namespace LlmCreateParams {
             type?: 'inferred';
         }
     }
+    /**
+     * Knowledge base configuration for RAG retrieval.
+     */
+    interface KBConfig {
+        /**
+         * Similarity threshold for filtering search results
+         */
+        filter_score?: number;
+        /**
+         * Max number of knowledge base chunks to retrieve
+         */
+        top_k?: number;
+    }
     interface State {
         /**
          * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,
@@ -1931,6 +2043,11 @@ export declare namespace LlmCreateParams {
                  * The type of transfer destination.
                  */
                 type: 'predefined';
+                /**
+                 * Extension digits to dial after the main number connects. Sent via DTMF. Allow
+                 * digits, '\*', '#'.
+                 */
+                extension?: string;
             }
             interface TransferDestinationInferred {
                 /**
@@ -2336,15 +2453,36 @@ export declare namespace LlmCreateParams {
             name: string;
             type: 'mcp';
             /**
-             * The input schema of the MCP tool.
+             * The description for the sentence agent say during execution. Only applicable
+             * when speak_during_execution is true. Can write what to say or even provide
+             * examples. The default is "The message you will say to callee when calling this
+             * tool. Make sure it fits into the conversation smoothly.".
              */
-            input_schema?: {
-                [key: string]: string;
-            };
+            execution_message_description?: string;
             /**
              * Unique id of the MCP.
              */
             mcp_id?: string;
+            /**
+             * Response variables to add to dynamic variables, key is the variable name, value
+             * is the path to the variable in the response
+             */
+            response_variables?: {
+                [key: string]: string;
+            };
+            /**
+             * Determines whether the agent would call LLM another time and speak when the
+             * result of function is obtained. Usually this needs to get turned on so user can
+             * get update for the function call.
+             */
+            speak_after_execution?: boolean;
+            /**
+             * Determines whether the agent would say sentence like "One moment, let me check
+             * that." when executing the function. Recommend to turn on if your function call
+             * takes over 1s (including network) to complete, so that your agent remains
+             * responsive.
+             */
+            speak_during_execution?: boolean;
         }
         interface SendSMSTool {
             /**
@@ -2426,15 +2564,20 @@ export interface LlmUpdateParams {
      * - Tools of LLM (no state) = general tools
      */
     general_tools?: Array<LlmUpdateParams.EndCallTool | LlmUpdateParams.TransferCallTool | LlmUpdateParams.CheckAvailabilityCalTool | LlmUpdateParams.BookAppointmentCalTool | LlmUpdateParams.PressDigitTool | LlmUpdateParams.CustomTool | LlmUpdateParams.ExtractDynamicVariableTool | LlmUpdateParams.AgentSwapTool | LlmUpdateParams.McpTool | LlmUpdateParams.SendSMSTool> | null;
+    /**
+     * Body param: Knowledge base configuration for RAG retrieval.
+     */
+    kb_config?: LlmUpdateParams.KBConfig | null;
     /**
      * Body param: A list of knowledge base ids to use for this resource. Set to null
      * to remove all knowledge bases.
      */
     knowledge_base_ids?: Array<string> | null;
     /**
-     * Body param: Select the underlying text LLM. If not set, would default to gpt-4o.
+     * Body param: Select the underlying text LLM. If not set, would default to
+     * gpt-4.1.
      */
-    model?: 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | null;
+    model?: 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | null;
     /**
      * Body param: If set to true, will enable fast tier, which uses high priority pool
      * with more dedicated resource to ensure lower and more consistent latency,
@@ -2452,7 +2595,7 @@ export interface LlmUpdateParams {
      * Body param: Select the underlying speech to speech model. Can only set this or
      * model, not both.
      */
-    s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | null;
+    s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
     /**
      * Body param: Name of the starting state. Required if states is not empty.
      */
@@ -2525,6 +2668,11 @@ export declare namespace LlmUpdateParams {
              * The type of transfer destination.
              */
             type: 'predefined';
+            /**
+             * Extension digits to dial after the main number connects. Sent via DTMF. Allow
+             * digits, '\*', '#'.
+             */
+            extension?: string;
         }
         interface TransferDestinationInferred {
             /**
@@ -2930,15 +3078,36 @@ export declare namespace LlmUpdateParams {
         name: string;
         type: 'mcp';
         /**
-         * The input schema of the MCP tool.
+         * The description for the sentence agent say during execution. Only applicable
+         * when speak_during_execution is true. Can write what to say or even provide
+         * examples. The default is "The message you will say to callee when calling this
+         * tool. Make sure it fits into the conversation smoothly.".
          */
-        input_schema?: {
-            [key: string]: string;
-        };
+        execution_message_description?: string;
         /**
          * Unique id of the MCP.
          */
         mcp_id?: string;
+        /**
+         * Response variables to add to dynamic variables, key is the variable name, value
+         * is the path to the variable in the response
+         */
+        response_variables?: {
+            [key: string]: string;
+        };
+        /**
+         * Determines whether the agent would call LLM another time and speak when the
+         * result of function is obtained. Usually this needs to get turned on so user can
+         * get update for the function call.
+         */
+        speak_after_execution?: boolean;
+        /**
+         * Determines whether the agent would say sentence like "One moment, let me check
+         * that." when executing the function. Recommend to turn on if your function call
+         * takes over 1s (including network) to complete, so that your agent remains
+         * responsive.
+         */
+        speak_during_execution?: boolean;
     }
     interface SendSMSTool {
         /**
@@ -2972,6 +3141,19 @@ export declare namespace LlmUpdateParams {
             type?: 'inferred';
         }
     }
+    /**
+     * Knowledge base configuration for RAG retrieval.
+     */
+    interface KBConfig {
+        /**
+         * Similarity threshold for filtering search results
+         */
+        filter_score?: number;
+        /**
+         * Max number of knowledge base chunks to retrieve
+         */
+        top_k?: number;
+    }
     interface State {
         /**
          * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,
@@ -3099,6 +3281,11 @@ export declare namespace LlmUpdateParams {
                  * The type of transfer destination.
                  */
                 type: 'predefined';
+                /**
+                 * Extension digits to dial after the main number connects. Sent via DTMF. Allow
+                 * digits, '\*', '#'.
+                 */
+                extension?: string;
             }
             interface TransferDestinationInferred {
                 /**
@@ -3504,15 +3691,36 @@ export declare namespace LlmUpdateParams {
             name: string;
             type: 'mcp';
             /**
-             * The input schema of the MCP tool.
+             * The description for the sentence agent say during execution. Only applicable
+             * when speak_during_execution is true. Can write what to say or even provide
+             * examples. The default is "The message you will say to callee when calling this
+             * tool. Make sure it fits into the conversation smoothly.".
              */
-            input_schema?: {
-                [key: string]: string;
-            };
+            execution_message_description?: string;
             /**
              * Unique id of the MCP.
              */
             mcp_id?: string;
+            /**
+             * Response variables to add to dynamic variables, key is the variable name, value
+             * is the path to the variable in the response
+             */
+            response_variables?: {
+                [key: string]: string;
+            };
+            /**
+             * Determines whether the agent would call LLM another time and speak when the
+             * result of function is obtained. Usually this needs to get turned on so user can
+             * get update for the function call.
+             */
+            speak_after_execution?: boolean;
+            /**
+             * Determines whether the agent would say sentence like "One moment, let me check
+             * that." when executing the function. Recommend to turn on if your function call
+             * takes over 1s (including network) to complete, so that your agent remains
+             * responsive.
+             */
+            speak_during_execution?: boolean;
         }
         interface SendSMSTool {
             /**