retell-sdk 4.7.0 → 4.8.0

package/src/resources/llm.ts

@@ -103,9 +103,15 @@ export interface LlmResponse {
   inbound_dynamic_variables_webhook_url?: string | null;
 
   /**
-   * Select the underlying LLM. If not set, would default to gpt-4o.
+   * A list of knowledge base ids to use for this resource. Set to null to remove all
+   * knowledge bases.
    */
-  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku';
+  knowledge_base_ids?: Array<string> | null;
+
+  /**
+   * Select the underlying text LLM. If not set, would default to gpt-4o.
+   */
+  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku' | null;
 
   /**
    * If set, will control the randomness of the response. Value ranging from [0,1].
@@ -115,6 +121,12 @@ export interface LlmResponse {
    */
   model_temperature?: number;
 
+  /**
+   * Select the underlying speech to speech model. Can only set this or model, not
+   * both.
+   */
+  s2s_model?: 'gpt-4o-realtime' | null;
+
   /**
    * Name of the starting state. Required if states is not empty.
    */
@@ -128,6 +140,14 @@ export interface LlmResponse {
    * tools (essentially one state).
    */
   states?: Array<LlmResponse.State> | null;
+
+  /**
+   * Only applicable when model is gpt-4o or gpt-4o mini. If set to true, will use
+   * structured output to make sure tool call arguments follow the json schema. The
+   * time to save a new tool or change to a tool will be longer as additional
+   * processing is needed. Default to false.
+   */
+  tool_call_strict_mode?: boolean;
 }
 
 export namespace LlmResponse {
@@ -157,8 +177,8 @@ export namespace LlmResponse {
     name: string;
 
     /**
-     * The number to transfer to in E.164 format (a + and country code, then the phone
-     * number with no space or other special characters). For example, +16175551212.
+     * The number to transfer to in E.164 format or a dynamic variable like
+     * {{transfer_number}}.
      */
     number: string;
 
@@ -169,6 +189,44 @@ export namespace LlmResponse {
      * to call the tool.
      */
     description?: string;
+
+    /**
+     * If set to true, will show transferee (the user, not the AI agent) as caller when
+     * transferring, requires the telephony side to support SIP REFER to PSTN. This is
+     * only applicable for cold transfer, so if warm transfer option is specified, this
+     * field will be ignored. Default to false (default to show AI agent as caller).
+     */
+    show_transferee_as_caller?: boolean | null;
+
+    /**
+     * If set, when transfer is successful, will perform a warm handoff. Can leave
+     * either a static message or a dynamic one based on prompt. Set to null to disable
+     * warm handoff.
+     */
+    warm_transfer_option?:
+      | TransferCallTool.WarmTransferPrompt
+      | TransferCallTool.WarmTransferStaticMessage
+      | null;
+  }
+
+  export namespace TransferCallTool {
+    export interface WarmTransferPrompt {
+      /**
+       * The prompt to be used for warm handoff. Can contain dynamic variables.
+       */
+      prompt?: string;
+
+      type?: 'prompt';
+    }
+
+    export interface WarmTransferStaticMessage {
+      /**
+       * The static message to be used for warm handoff. Can contain dynamic variables.
+       */
+      message?: string;
+
+      type?: 'static_message';
+    }
   }
 
   export interface CheckAvailabilityCalTool {
@@ -475,8 +533,8 @@ export namespace LlmResponse {
       name: string;
 
       /**
-       * The number to transfer to in E.164 format (a + and country code, then the phone
-       * number with no space or other special characters). For example, +16175551212.
+       * The number to transfer to in E.164 format or a dynamic variable like
+       * {{transfer_number}}.
        */
       number: string;
 
@@ -487,6 +545,44 @@ export namespace LlmResponse {
        * to call the tool.
        */
       description?: string;
+
+      /**
+       * If set to true, will show transferee (the user, not the AI agent) as caller when
+       * transferring, requires the telephony side to support SIP REFER to PSTN. This is
+       * only applicable for cold transfer, so if warm transfer option is specified, this
+       * field will be ignored. Default to false (default to show AI agent as caller).
+       */
+      show_transferee_as_caller?: boolean | null;
+
+      /**
+       * If set, when transfer is successful, will perform a warm handoff. Can leave
+       * either a static message or a dynamic one based on prompt. Set to null to disable
+       * warm handoff.
+       */
+      warm_transfer_option?:
+        | TransferCallTool.WarmTransferPrompt
+        | TransferCallTool.WarmTransferStaticMessage
+        | null;
+    }
+
+    export namespace TransferCallTool {
+      export interface WarmTransferPrompt {
+        /**
+         * The prompt to be used for warm handoff. Can contain dynamic variables.
+         */
+        prompt?: string;
+
+        type?: 'prompt';
+      }
+
+      export interface WarmTransferStaticMessage {
+        /**
+         * The static message to be used for warm handoff. Can contain dynamic variables.
+         */
+        message?: string;
+
+        type?: 'static_message';
+      }
     }
 
     export interface CheckAvailabilityCalTool {
@@ -718,9 +814,15 @@ export interface LlmCreateParams {
   inbound_dynamic_variables_webhook_url?: string | null;
 
   /**
-   * Select the underlying LLM. If not set, would default to gpt-4o.
+   * 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.
    */
-  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku';
+  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku' | null;
 
   /**
    * If set, will control the randomness of the response. Value ranging from [0,1].
@@ -730,6 +832,12 @@ export interface LlmCreateParams {
    */
   model_temperature?: number;
 
+  /**
+   * Select the underlying speech to speech model. Can only set this or model, not
+   * both.
+   */
+  s2s_model?: 'gpt-4o-realtime' | null;
+
   /**
    * Name of the starting state. Required if states is not empty.
    */
@@ -743,6 +851,14 @@ export interface LlmCreateParams {
    * tools (essentially one state).
    */
   states?: Array<LlmCreateParams.State> | null;
+
+  /**
+   * Only applicable when model is gpt-4o or gpt-4o mini. If set to true, will use
+   * structured output to make sure tool call arguments follow the json schema. The
+   * time to save a new tool or change to a tool will be longer as additional
+   * processing is needed. Default to false.
+   */
+  tool_call_strict_mode?: boolean;
 }
 
 export namespace LlmCreateParams {
@@ -772,8 +888,8 @@ export namespace LlmCreateParams {
     name: string;
 
     /**
-     * The number to transfer to in E.164 format (a + and country code, then the phone
-     * number with no space or other special characters). For example, +16175551212.
+     * The number to transfer to in E.164 format or a dynamic variable like
+     * {{transfer_number}}.
      */
     number: string;
 
@@ -784,6 +900,44 @@ export namespace LlmCreateParams {
      * to call the tool.
      */
     description?: string;
+
+    /**
+     * If set to true, will show transferee (the user, not the AI agent) as caller when
+     * transferring, requires the telephony side to support SIP REFER to PSTN. This is
+     * only applicable for cold transfer, so if warm transfer option is specified, this
+     * field will be ignored. Default to false (default to show AI agent as caller).
+     */
+    show_transferee_as_caller?: boolean | null;
+
+    /**
+     * If set, when transfer is successful, will perform a warm handoff. Can leave
+     * either a static message or a dynamic one based on prompt. Set to null to disable
+     * warm handoff.
+     */
+    warm_transfer_option?:
+      | TransferCallTool.WarmTransferPrompt
+      | TransferCallTool.WarmTransferStaticMessage
+      | null;
+  }
+
+  export namespace TransferCallTool {
+    export interface WarmTransferPrompt {
+      /**
+       * The prompt to be used for warm handoff. Can contain dynamic variables.
+       */
+      prompt?: string;
+
+      type?: 'prompt';
+    }
+
+    export interface WarmTransferStaticMessage {
+      /**
+       * The static message to be used for warm handoff. Can contain dynamic variables.
+       */
+      message?: string;
+
+      type?: 'static_message';
+    }
   }
 
   export interface CheckAvailabilityCalTool {
@@ -1090,8 +1244,8 @@ export namespace LlmCreateParams {
       name: string;
 
       /**
-       * The number to transfer to in E.164 format (a + and country code, then the phone
-       * number with no space or other special characters). For example, +16175551212.
+       * The number to transfer to in E.164 format or a dynamic variable like
+       * {{transfer_number}}.
        */
       number: string;
 
@@ -1102,6 +1256,44 @@ export namespace LlmCreateParams {
        * to call the tool.
        */
       description?: string;
+
+      /**
+       * If set to true, will show transferee (the user, not the AI agent) as caller when
+       * transferring, requires the telephony side to support SIP REFER to PSTN. This is
+       * only applicable for cold transfer, so if warm transfer option is specified, this
+       * field will be ignored. Default to false (default to show AI agent as caller).
+       */
+      show_transferee_as_caller?: boolean | null;
+
+      /**
+       * If set, when transfer is successful, will perform a warm handoff. Can leave
+       * either a static message or a dynamic one based on prompt. Set to null to disable
+       * warm handoff.
+       */
+      warm_transfer_option?:
+        | TransferCallTool.WarmTransferPrompt
+        | TransferCallTool.WarmTransferStaticMessage
+        | null;
+    }
+
+    export namespace TransferCallTool {
+      export interface WarmTransferPrompt {
+        /**
+         * The prompt to be used for warm handoff. Can contain dynamic variables.
+         */
+        prompt?: string;
+
+        type?: 'prompt';
+      }
+
+      export interface WarmTransferStaticMessage {
+        /**
+         * The static message to be used for warm handoff. Can contain dynamic variables.
+         */
+        message?: string;
+
+        type?: 'static_message';
+      }
     }
 
     export interface CheckAvailabilityCalTool {
@@ -1331,9 +1523,15 @@ export interface LlmUpdateParams {
   inbound_dynamic_variables_webhook_url?: string | null;
 
   /**
-   * Select the underlying LLM. If not set, would default to gpt-4o.
+   * 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.
    */
-  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku';
+  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku' | null;
 
   /**
    * If set, will control the randomness of the response. Value ranging from [0,1].
@@ -1343,6 +1541,12 @@ export interface LlmUpdateParams {
    */
   model_temperature?: number;
 
+  /**
+   * Select the underlying speech to speech model. Can only set this or model, not
+   * both.
+   */
+  s2s_model?: 'gpt-4o-realtime' | null;
+
   /**
    * Name of the starting state. Required if states is not empty.
    */
@@ -1356,6 +1560,14 @@ export interface LlmUpdateParams {
    * tools (essentially one state).
    */
   states?: Array<LlmUpdateParams.State> | null;
+
+  /**
+   * Only applicable when model is gpt-4o or gpt-4o mini. If set to true, will use
+   * structured output to make sure tool call arguments follow the json schema. The
+   * time to save a new tool or change to a tool will be longer as additional
+   * processing is needed. Default to false.
+   */
+  tool_call_strict_mode?: boolean;
 }
 
 export namespace LlmUpdateParams {
@@ -1385,8 +1597,8 @@ export namespace LlmUpdateParams {
     name: string;
 
     /**
-     * The number to transfer to in E.164 format (a + and country code, then the phone
-     * number with no space or other special characters). For example, +16175551212.
+     * The number to transfer to in E.164 format or a dynamic variable like
+     * {{transfer_number}}.
      */
     number: string;
 
@@ -1397,6 +1609,44 @@ export namespace LlmUpdateParams {
      * to call the tool.
      */
     description?: string;
+
+    /**
+     * If set to true, will show transferee (the user, not the AI agent) as caller when
+     * transferring, requires the telephony side to support SIP REFER to PSTN. This is
+     * only applicable for cold transfer, so if warm transfer option is specified, this
+     * field will be ignored. Default to false (default to show AI agent as caller).
+     */
+    show_transferee_as_caller?: boolean | null;
+
+    /**
+     * If set, when transfer is successful, will perform a warm handoff. Can leave
+     * either a static message or a dynamic one based on prompt. Set to null to disable
+     * warm handoff.
+     */
+    warm_transfer_option?:
+      | TransferCallTool.WarmTransferPrompt
+      | TransferCallTool.WarmTransferStaticMessage
+      | null;
+  }
+
+  export namespace TransferCallTool {
+    export interface WarmTransferPrompt {
+      /**
+       * The prompt to be used for warm handoff. Can contain dynamic variables.
+       */
+      prompt?: string;
+
+      type?: 'prompt';
+    }
+
+    export interface WarmTransferStaticMessage {
+      /**
+       * The static message to be used for warm handoff. Can contain dynamic variables.
+       */
+      message?: string;
+
+      type?: 'static_message';
+    }
   }
 
   export interface CheckAvailabilityCalTool {
@@ -1703,8 +1953,8 @@ export namespace LlmUpdateParams {
       name: string;
 
       /**
-       * The number to transfer to in E.164 format (a + and country code, then the phone
-       * number with no space or other special characters). For example, +16175551212.
+       * The number to transfer to in E.164 format or a dynamic variable like
+       * {{transfer_number}}.
        */
       number: string;
 
@@ -1715,6 +1965,44 @@ export namespace LlmUpdateParams {
        * to call the tool.
        */
       description?: string;
+
+      /**
+       * If set to true, will show transferee (the user, not the AI agent) as caller when
+       * transferring, requires the telephony side to support SIP REFER to PSTN. This is
+       * only applicable for cold transfer, so if warm transfer option is specified, this
+       * field will be ignored. Default to false (default to show AI agent as caller).
+       */
+      show_transferee_as_caller?: boolean | null;
+
+      /**
+       * If set, when transfer is successful, will perform a warm handoff. Can leave
+       * either a static message or a dynamic one based on prompt. Set to null to disable
+       * warm handoff.
+       */
+      warm_transfer_option?:
+        | TransferCallTool.WarmTransferPrompt
+        | TransferCallTool.WarmTransferStaticMessage
+        | null;
+    }
+
+    export namespace TransferCallTool {
+      export interface WarmTransferPrompt {
+        /**
+         * The prompt to be used for warm handoff. Can contain dynamic variables.
+         */
+        prompt?: string;
+
+        type?: 'prompt';
+      }
+
+      export interface WarmTransferStaticMessage {
+        /**
+         * The static message to be used for warm handoff. Can contain dynamic variables.
+         */
+        message?: string;
+
+        type?: 'static_message';
+      }
     }
 
     export interface CheckAvailabilityCalTool {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.7.0'; // x-release-please-version
+export const VERSION = '4.8.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.7.0";
+export declare const VERSION = "4.8.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.7.0'; // x-release-please-version
+exports.VERSION = '4.8.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.7.0'; // x-release-please-version
+export const VERSION = '4.8.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map