retell-sdk 4.49.0 → 4.51.0

package/src/resources/llm.ts

@@ -11,7 +11,9 @@ export class Llm extends APIResource {
    *
    * @example
    * ```ts
-   * const llmResponse = await client.llm.create();
+   * const llmResponse = await client.llm.create({
+   *   start_speaker: 'user',
+   * });
    * ```
    */
   create(body: LlmCreateParams, options?: Core.RequestOptions): Core.APIPromise<LlmResponse> {
@@ -53,6 +55,7 @@ export class Llm extends APIResource {
    * const llmResponse = await client.llm.update(
    *   '16b980523634a6dc504898cda492e939',
    *   {
+   *     start_speaker: 'user',
    *     begin_message:
    *       'Hey I am a virtual assistant calling from Retell Hospital.',
    *   },
@@ -120,6 +123,12 @@ export interface LlmResponse {
    */
   llm_id: string;
 
+  /**
+   * The speaker who starts the conversation. Required. Must be either 'user' or
+   * 'agent'.
+   */
+  start_speaker: 'user' | 'agent';
+
   /**
    * First utterance said by the agent in the call. If not set, LLM will dynamically
    * generate a message. If set to "", agent will wait for user to speak first.
@@ -221,12 +230,6 @@ export interface LlmResponse {
    */
   s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
 
-  /**
-   * The speaker who starts the conversation. Required. Must be either 'user' or
-   * 'agent'.
-   */
-  start_speaker?: 'user' | 'agent';
-
   /**
    * Name of the starting state. Required if states is not empty.
    */
@@ -318,7 +321,7 @@ export namespace LlmResponse {
 
       /**
        * Extension digits to dial after the main number connects. Sent via DTMF. Allow
-       * digits, '\*', '#'.
+       * digits, '\*', '#', or a dynamic variable like {{extension}}.
        */
       extension?: string;
     }
@@ -345,9 +348,8 @@ export namespace LlmResponse {
 
       /**
        * 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).
+       * transferring, requires the telephony side to support caller id override. Retell
+       * Twilio numbers support this option.
        */
       show_transferee_as_caller?: boolean;
     }
@@ -363,6 +365,12 @@ export namespace LlmResponse {
        */
       agent_detection_timeout_ms?: number;
 
+      /**
+       * IVR navigation option to run when doing human detection. This prompt will guide
+       * the AI on how to navigate the IVR system.
+       */
+      ivr_option?: TransferOptionWarmTransfer.IvrOption;
+
       /**
        * The music to play while the caller is being transferred.
        */
@@ -397,9 +405,29 @@ export namespace LlmResponse {
       public_handoff_option?:
         | TransferOptionWarmTransfer.WarmTransferPrompt
         | TransferOptionWarmTransfer.WarmTransferStaticMessage;
+
+      /**
+       * If set to true, will show transferee (the user, not the AI agent) as caller when
+       * transferring, requires the telephony side to support caller id override. Retell
+       * Twilio numbers support this option.
+       */
+      show_transferee_as_caller?: boolean;
     }
 
     export namespace TransferOptionWarmTransfer {
+      /**
+       * IVR navigation option to run when doing human detection. This prompt will guide
+       * the AI on how to navigate the IVR system.
+       */
+      export interface IvrOption {
+        /**
+         * The prompt to be used for warm handoff. Can contain dynamic variables.
+         */
+        prompt?: string;
+
+        type?: 'prompt';
+      }
+
       export interface WarmTransferPrompt {
         /**
          * The prompt to be used for warm handoff. Can contain dynamic variables.
@@ -1066,7 +1094,7 @@ export namespace LlmResponse {
 
         /**
          * Extension digits to dial after the main number connects. Sent via DTMF. Allow
-         * digits, '\*', '#'.
+         * digits, '\*', '#', or a dynamic variable like {{extension}}.
          */
         extension?: string;
       }
@@ -1093,9 +1121,8 @@ export namespace LlmResponse {
 
         /**
          * 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).
+         * transferring, requires the telephony side to support caller id override. Retell
+         * Twilio numbers support this option.
          */
         show_transferee_as_caller?: boolean;
       }
@@ -1111,6 +1138,12 @@ export namespace LlmResponse {
          */
         agent_detection_timeout_ms?: number;
 
+        /**
+         * IVR navigation option to run when doing human detection. This prompt will guide
+         * the AI on how to navigate the IVR system.
+         */
+        ivr_option?: TransferOptionWarmTransfer.IvrOption;
+
         /**
          * The music to play while the caller is being transferred.
          */
@@ -1145,9 +1178,29 @@ export namespace LlmResponse {
         public_handoff_option?:
           | TransferOptionWarmTransfer.WarmTransferPrompt
           | TransferOptionWarmTransfer.WarmTransferStaticMessage;
+
+        /**
+         * If set to true, will show transferee (the user, not the AI agent) as caller when
+         * transferring, requires the telephony side to support caller id override. Retell
+         * Twilio numbers support this option.
+         */
+        show_transferee_as_caller?: boolean;
       }
 
       export namespace TransferOptionWarmTransfer {
+        /**
+         * IVR navigation option to run when doing human detection. This prompt will guide
+         * the AI on how to navigate the IVR system.
+         */
+        export interface IvrOption {
+          /**
+           * The prompt to be used for warm handoff. Can contain dynamic variables.
+           */
+          prompt?: string;
+
+          type?: 'prompt';
+        }
+
         export interface WarmTransferPrompt {
           /**
            * The prompt to be used for warm handoff. Can contain dynamic variables.
@@ -1643,6 +1696,12 @@ export namespace LlmResponse {
 export type LlmListResponse = Array<LlmResponse>;
 
 export interface LlmCreateParams {
+  /**
+   * The speaker who starts the conversation. Required. Must be either 'user' or
+   * 'agent'.
+   */
+  start_speaker: 'user' | 'agent';
+
   /**
    * First utterance said by the agent in the call. If not set, LLM will dynamically
    * generate a message. If set to "", agent will wait for user to speak first.
@@ -1739,12 +1798,6 @@ export interface LlmCreateParams {
    */
   s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
 
-  /**
-   * The speaker who starts the conversation. Required. Must be either 'user' or
-   * 'agent'.
-   */
-  start_speaker?: 'user' | 'agent';
-
   /**
    * Name of the starting state. Required if states is not empty.
    */
@@ -1836,7 +1889,7 @@ export namespace LlmCreateParams {
 
       /**
        * Extension digits to dial after the main number connects. Sent via DTMF. Allow
-       * digits, '\*', '#'.
+       * digits, '\*', '#', or a dynamic variable like {{extension}}.
        */
       extension?: string;
     }
@@ -1863,9 +1916,8 @@ export namespace LlmCreateParams {
 
       /**
        * 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).
+       * transferring, requires the telephony side to support caller id override. Retell
+       * Twilio numbers support this option.
        */
       show_transferee_as_caller?: boolean;
     }
@@ -1881,6 +1933,12 @@ export namespace LlmCreateParams {
        */
       agent_detection_timeout_ms?: number;
 
+      /**
+       * IVR navigation option to run when doing human detection. This prompt will guide
+       * the AI on how to navigate the IVR system.
+       */
+      ivr_option?: TransferOptionWarmTransfer.IvrOption;
+
       /**
        * The music to play while the caller is being transferred.
        */
@@ -1915,9 +1973,29 @@ export namespace LlmCreateParams {
       public_handoff_option?:
         | TransferOptionWarmTransfer.WarmTransferPrompt
         | TransferOptionWarmTransfer.WarmTransferStaticMessage;
+
+      /**
+       * If set to true, will show transferee (the user, not the AI agent) as caller when
+       * transferring, requires the telephony side to support caller id override. Retell
+       * Twilio numbers support this option.
+       */
+      show_transferee_as_caller?: boolean;
     }
 
     export namespace TransferOptionWarmTransfer {
+      /**
+       * IVR navigation option to run when doing human detection. This prompt will guide
+       * the AI on how to navigate the IVR system.
+       */
+      export interface IvrOption {
+        /**
+         * The prompt to be used for warm handoff. Can contain dynamic variables.
+         */
+        prompt?: string;
+
+        type?: 'prompt';
+      }
+
       export interface WarmTransferPrompt {
         /**
          * The prompt to be used for warm handoff. Can contain dynamic variables.
@@ -2584,7 +2662,7 @@ export namespace LlmCreateParams {
 
         /**
          * Extension digits to dial after the main number connects. Sent via DTMF. Allow
-         * digits, '\*', '#'.
+         * digits, '\*', '#', or a dynamic variable like {{extension}}.
          */
         extension?: string;
       }
@@ -2611,9 +2689,8 @@ export namespace LlmCreateParams {
 
         /**
          * 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).
+         * transferring, requires the telephony side to support caller id override. Retell
+         * Twilio numbers support this option.
          */
         show_transferee_as_caller?: boolean;
       }
@@ -2629,6 +2706,12 @@ export namespace LlmCreateParams {
          */
         agent_detection_timeout_ms?: number;
 
+        /**
+         * IVR navigation option to run when doing human detection. This prompt will guide
+         * the AI on how to navigate the IVR system.
+         */
+        ivr_option?: TransferOptionWarmTransfer.IvrOption;
+
         /**
          * The music to play while the caller is being transferred.
          */
@@ -2663,9 +2746,29 @@ export namespace LlmCreateParams {
         public_handoff_option?:
           | TransferOptionWarmTransfer.WarmTransferPrompt
           | TransferOptionWarmTransfer.WarmTransferStaticMessage;
+
+        /**
+         * If set to true, will show transferee (the user, not the AI agent) as caller when
+         * transferring, requires the telephony side to support caller id override. Retell
+         * Twilio numbers support this option.
+         */
+        show_transferee_as_caller?: boolean;
       }
 
       export namespace TransferOptionWarmTransfer {
+        /**
+         * IVR navigation option to run when doing human detection. This prompt will guide
+         * the AI on how to navigate the IVR system.
+         */
+        export interface IvrOption {
+          /**
+           * The prompt to be used for warm handoff. Can contain dynamic variables.
+           */
+          prompt?: string;
+
+          type?: 'prompt';
+        }
+
         export interface WarmTransferPrompt {
           /**
            * The prompt to be used for warm handoff. Can contain dynamic variables.
@@ -3166,6 +3269,12 @@ export interface LlmRetrieveParams {
 }
 
 export interface LlmUpdateParams {
+  /**
+   * Body param: The speaker who starts the conversation. Required. Must be either
+   * 'user' or 'agent'.
+   */
+  start_speaker: 'user' | 'agent';
+
   /**
    * Query param: Optional version of the API to use for this request. Default to
    * latest version.
@@ -3272,12 +3381,6 @@ export interface LlmUpdateParams {
    */
   s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
 
-  /**
-   * Body param: The speaker who starts the conversation. Required. Must be either
-   * 'user' or 'agent'.
-   */
-  start_speaker?: 'user' | 'agent';
-
   /**
    * Body param: Name of the starting state. Required if states is not empty.
    */
@@ -3369,7 +3472,7 @@ export namespace LlmUpdateParams {
 
       /**
        * Extension digits to dial after the main number connects. Sent via DTMF. Allow
-       * digits, '\*', '#'.
+       * digits, '\*', '#', or a dynamic variable like {{extension}}.
        */
       extension?: string;
     }
@@ -3396,9 +3499,8 @@ export namespace LlmUpdateParams {
 
       /**
        * 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).
+       * transferring, requires the telephony side to support caller id override. Retell
+       * Twilio numbers support this option.
        */
       show_transferee_as_caller?: boolean;
     }
@@ -3414,6 +3516,12 @@ export namespace LlmUpdateParams {
        */
       agent_detection_timeout_ms?: number;
 
+      /**
+       * IVR navigation option to run when doing human detection. This prompt will guide
+       * the AI on how to navigate the IVR system.
+       */
+      ivr_option?: TransferOptionWarmTransfer.IvrOption;
+
       /**
        * The music to play while the caller is being transferred.
        */
@@ -3448,9 +3556,29 @@ export namespace LlmUpdateParams {
       public_handoff_option?:
         | TransferOptionWarmTransfer.WarmTransferPrompt
         | TransferOptionWarmTransfer.WarmTransferStaticMessage;
+
+      /**
+       * If set to true, will show transferee (the user, not the AI agent) as caller when
+       * transferring, requires the telephony side to support caller id override. Retell
+       * Twilio numbers support this option.
+       */
+      show_transferee_as_caller?: boolean;
     }
 
     export namespace TransferOptionWarmTransfer {
+      /**
+       * IVR navigation option to run when doing human detection. This prompt will guide
+       * the AI on how to navigate the IVR system.
+       */
+      export interface IvrOption {
+        /**
+         * The prompt to be used for warm handoff. Can contain dynamic variables.
+         */
+        prompt?: string;
+
+        type?: 'prompt';
+      }
+
       export interface WarmTransferPrompt {
         /**
          * The prompt to be used for warm handoff. Can contain dynamic variables.
@@ -4117,7 +4245,7 @@ export namespace LlmUpdateParams {
 
         /**
          * Extension digits to dial after the main number connects. Sent via DTMF. Allow
-         * digits, '\*', '#'.
+         * digits, '\*', '#', or a dynamic variable like {{extension}}.
          */
         extension?: string;
       }
@@ -4144,9 +4272,8 @@ export namespace LlmUpdateParams {
 
         /**
          * 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).
+         * transferring, requires the telephony side to support caller id override. Retell
+         * Twilio numbers support this option.
          */
         show_transferee_as_caller?: boolean;
       }
@@ -4162,6 +4289,12 @@ export namespace LlmUpdateParams {
          */
         agent_detection_timeout_ms?: number;
 
+        /**
+         * IVR navigation option to run when doing human detection. This prompt will guide
+         * the AI on how to navigate the IVR system.
+         */
+        ivr_option?: TransferOptionWarmTransfer.IvrOption;
+
         /**
          * The music to play while the caller is being transferred.
          */
@@ -4196,9 +4329,29 @@ export namespace LlmUpdateParams {
         public_handoff_option?:
           | TransferOptionWarmTransfer.WarmTransferPrompt
           | TransferOptionWarmTransfer.WarmTransferStaticMessage;
+
+        /**
+         * If set to true, will show transferee (the user, not the AI agent) as caller when
+         * transferring, requires the telephony side to support caller id override. Retell
+         * Twilio numbers support this option.
+         */
+        show_transferee_as_caller?: boolean;
       }
 
       export namespace TransferOptionWarmTransfer {
+        /**
+         * IVR navigation option to run when doing human detection. This prompt will guide
+         * the AI on how to navigate the IVR system.
+         */
+        export interface IvrOption {
+          /**
+           * The prompt to be used for warm handoff. Can contain dynamic variables.
+           */
+          prompt?: string;
+
+          type?: 'prompt';
+        }
+
         export interface WarmTransferPrompt {
           /**
            * The prompt to be used for warm handoff. Can contain dynamic variables.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.49.0'; // x-release-please-version
+export const VERSION = '4.51.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.49.0";
+export declare const VERSION = "4.51.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.49.0'; // x-release-please-version
+exports.VERSION = '4.51.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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