retell-sdk 5.10.3 → 5.12.0

package/resources/llm.d.ts

@@ -631,6 +631,23 @@ export declare namespace LlmResponse {
          * to call the tool.
          */
         description?: string;
+        /**
+         * Describes what to say before sending the SMS. Only applicable when
+         * speak_during_execution is true.
+         */
+        execution_message_description?: string;
+        /**
+         * Type of execution message. "prompt" means the agent will use
+         * execution_message_description as a prompt to generate the message. "static_text"
+         * means the agent will speak the execution_message_description directly. Defaults
+         * to "prompt".
+         */
+        execution_message_type?: 'prompt' | 'static_text';
+        /**
+         * If true, the agent will speak a short line before sending the SMS. If omitted,
+         * defaults to true (same as end_call / transfer_call tools).
+         */
+        speak_during_execution?: boolean;
     }
     namespace SendSMSTool {
         interface SMSContentPredefined {
@@ -851,6 +868,12 @@ export declare namespace LlmResponse {
              * Type of the variable to extract.
              */
             type: 'string';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Examples of the variable value to teach model the style and syntax.
              */
@@ -878,6 +901,12 @@ export declare namespace LlmResponse {
              * Type of the variable to extract.
              */
             type: 'enum';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Whether this data is required. If true and the data is not extracted, the call
              * will be marked as unsuccessful.
@@ -897,6 +926,12 @@ export declare namespace LlmResponse {
              * Type of the variable to extract.
              */
             type: 'boolean';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Whether this data is required. If true and the data is not extracted, the call
              * will be marked as unsuccessful.
@@ -916,6 +951,12 @@ export declare namespace LlmResponse {
              * Type of the variable to extract.
              */
             type: 'number';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Whether this data is required. If true and the data is not extracted, the call
              * will be marked as unsuccessful.
@@ -1623,6 +1664,23 @@ export declare namespace LlmResponse {
              * to call the tool.
              */
             description?: string;
+            /**
+             * Describes what to say before sending the SMS. Only applicable when
+             * speak_during_execution is true.
+             */
+            execution_message_description?: string;
+            /**
+             * Type of execution message. "prompt" means the agent will use
+             * execution_message_description as a prompt to generate the message. "static_text"
+             * means the agent will speak the execution_message_description directly. Defaults
+             * to "prompt".
+             */
+            execution_message_type?: 'prompt' | 'static_text';
+            /**
+             * If true, the agent will speak a short line before sending the SMS. If omitted,
+             * defaults to true (same as end_call / transfer_call tools).
+             */
+            speak_during_execution?: boolean;
         }
         namespace SendSMSTool {
             interface SMSContentPredefined {
@@ -1843,6 +1901,12 @@ export declare namespace LlmResponse {
                  * Type of the variable to extract.
                  */
                 type: 'string';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Examples of the variable value to teach model the style and syntax.
                  */
@@ -1870,6 +1934,12 @@ export declare namespace LlmResponse {
                  * Type of the variable to extract.
                  */
                 type: 'enum';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -1889,6 +1959,12 @@ export declare namespace LlmResponse {
                  * Type of the variable to extract.
                  */
                 type: 'boolean';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -1908,6 +1984,12 @@ export declare namespace LlmResponse {
                  * Type of the variable to extract.
                  */
                 type: 'number';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -2600,6 +2682,23 @@ export declare namespace LlmCreateParams {
          * to call the tool.
          */
         description?: string;
+        /**
+         * Describes what to say before sending the SMS. Only applicable when
+         * speak_during_execution is true.
+         */
+        execution_message_description?: string;
+        /**
+         * Type of execution message. "prompt" means the agent will use
+         * execution_message_description as a prompt to generate the message. "static_text"
+         * means the agent will speak the execution_message_description directly. Defaults
+         * to "prompt".
+         */
+        execution_message_type?: 'prompt' | 'static_text';
+        /**
+         * If true, the agent will speak a short line before sending the SMS. If omitted,
+         * defaults to true (same as end_call / transfer_call tools).
+         */
+        speak_during_execution?: boolean;
     }
     namespace SendSMSTool {
         interface SMSContentPredefined {
@@ -2820,6 +2919,12 @@ export declare namespace LlmCreateParams {
              * Type of the variable to extract.
              */
             type: 'string';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Examples of the variable value to teach model the style and syntax.
              */
@@ -2847,6 +2952,12 @@ export declare namespace LlmCreateParams {
              * Type of the variable to extract.
              */
             type: 'enum';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Whether this data is required. If true and the data is not extracted, the call
              * will be marked as unsuccessful.
@@ -2866,6 +2977,12 @@ export declare namespace LlmCreateParams {
              * Type of the variable to extract.
              */
             type: 'boolean';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Whether this data is required. If true and the data is not extracted, the call
              * will be marked as unsuccessful.
@@ -2885,6 +3002,12 @@ export declare namespace LlmCreateParams {
              * Type of the variable to extract.
              */
             type: 'number';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Whether this data is required. If true and the data is not extracted, the call
              * will be marked as unsuccessful.
@@ -3592,6 +3715,23 @@ export declare namespace LlmCreateParams {
              * to call the tool.
              */
             description?: string;
+            /**
+             * Describes what to say before sending the SMS. Only applicable when
+             * speak_during_execution is true.
+             */
+            execution_message_description?: string;
+            /**
+             * Type of execution message. "prompt" means the agent will use
+             * execution_message_description as a prompt to generate the message. "static_text"
+             * means the agent will speak the execution_message_description directly. Defaults
+             * to "prompt".
+             */
+            execution_message_type?: 'prompt' | 'static_text';
+            /**
+             * If true, the agent will speak a short line before sending the SMS. If omitted,
+             * defaults to true (same as end_call / transfer_call tools).
+             */
+            speak_during_execution?: boolean;
         }
         namespace SendSMSTool {
             interface SMSContentPredefined {
@@ -3812,6 +3952,12 @@ export declare namespace LlmCreateParams {
                  * Type of the variable to extract.
                  */
                 type: 'string';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Examples of the variable value to teach model the style and syntax.
                  */
@@ -3839,6 +3985,12 @@ export declare namespace LlmCreateParams {
                  * Type of the variable to extract.
                  */
                 type: 'enum';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -3858,6 +4010,12 @@ export declare namespace LlmCreateParams {
                  * Type of the variable to extract.
                  */
                 type: 'boolean';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -3877,6 +4035,12 @@ export declare namespace LlmCreateParams {
                  * Type of the variable to extract.
                  */
                 type: 'number';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -4582,6 +4746,23 @@ export declare namespace LlmUpdateParams {
          * to call the tool.
          */
         description?: string;
+        /**
+         * Describes what to say before sending the SMS. Only applicable when
+         * speak_during_execution is true.
+         */
+        execution_message_description?: string;
+        /**
+         * Type of execution message. "prompt" means the agent will use
+         * execution_message_description as a prompt to generate the message. "static_text"
+         * means the agent will speak the execution_message_description directly. Defaults
+         * to "prompt".
+         */
+        execution_message_type?: 'prompt' | 'static_text';
+        /**
+         * If true, the agent will speak a short line before sending the SMS. If omitted,
+         * defaults to true (same as end_call / transfer_call tools).
+         */
+        speak_during_execution?: boolean;
     }
     namespace SendSMSTool {
         interface SMSContentPredefined {
@@ -4802,6 +4983,12 @@ export declare namespace LlmUpdateParams {
              * Type of the variable to extract.
              */
             type: 'string';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Examples of the variable value to teach model the style and syntax.
              */
@@ -4829,6 +5016,12 @@ export declare namespace LlmUpdateParams {
              * Type of the variable to extract.
              */
             type: 'enum';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Whether this data is required. If true and the data is not extracted, the call
              * will be marked as unsuccessful.
@@ -4848,6 +5041,12 @@ export declare namespace LlmUpdateParams {
              * Type of the variable to extract.
              */
             type: 'boolean';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Whether this data is required. If true and the data is not extracted, the call
              * will be marked as unsuccessful.
@@ -4867,6 +5066,12 @@ export declare namespace LlmUpdateParams {
              * Type of the variable to extract.
              */
             type: 'number';
+            /**
+             * Optional instruction to help decide whether this field needs to be populated in
+             * the analysis. If not set, the field is always included. If required is true,
+             * this is ignored.
+             */
+            conditional_prompt?: string;
             /**
              * Whether this data is required. If true and the data is not extracted, the call
              * will be marked as unsuccessful.
@@ -5574,6 +5779,23 @@ export declare namespace LlmUpdateParams {
              * to call the tool.
              */
             description?: string;
+            /**
+             * Describes what to say before sending the SMS. Only applicable when
+             * speak_during_execution is true.
+             */
+            execution_message_description?: string;
+            /**
+             * Type of execution message. "prompt" means the agent will use
+             * execution_message_description as a prompt to generate the message. "static_text"
+             * means the agent will speak the execution_message_description directly. Defaults
+             * to "prompt".
+             */
+            execution_message_type?: 'prompt' | 'static_text';
+            /**
+             * If true, the agent will speak a short line before sending the SMS. If omitted,
+             * defaults to true (same as end_call / transfer_call tools).
+             */
+            speak_during_execution?: boolean;
         }
         namespace SendSMSTool {
             interface SMSContentPredefined {
@@ -5794,6 +6016,12 @@ export declare namespace LlmUpdateParams {
                  * Type of the variable to extract.
                  */
                 type: 'string';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Examples of the variable value to teach model the style and syntax.
                  */
@@ -5821,6 +6049,12 @@ export declare namespace LlmUpdateParams {
                  * Type of the variable to extract.
                  */
                 type: 'enum';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -5840,6 +6074,12 @@ export declare namespace LlmUpdateParams {
                  * Type of the variable to extract.
                  */
                 type: 'boolean';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.
@@ -5859,6 +6099,12 @@ export declare namespace LlmUpdateParams {
                  * Type of the variable to extract.
                  */
                 type: 'number';
+                /**
+                 * Optional instruction to help decide whether this field needs to be populated in
+                 * the analysis. If not set, the field is always included. If required is true,
+                 * this is ignored.
+                 */
+                conditional_prompt?: string;
                 /**
                  * Whether this data is required. If true and the data is not extracted, the call
                  * will be marked as unsuccessful.