retell-sdk 4.36.0 → 4.38.0

package/src/resources/llm.ts

@@ -123,7 +123,7 @@ export interface LlmResponse {
    * injected into your Retell LLM prompt and tool description when specific values
    * are not provided in a request. Only applicable for Retell LLM.
    */
-  default_dynamic_variables?: Record<string, string> | null;
+  default_dynamic_variables?: { [key: string]: string } | null;
 
   /**
    * General prompt appended to system prompt no matter what state the agent is in.
@@ -150,6 +150,7 @@ export interface LlmResponse {
     | LlmResponse.BookAppointmentCalTool
     | LlmResponse.PressDigitTool
     | LlmResponse.CustomTool
+    | LlmResponse.ExtractDynamicVariableTool
   > | null;
 
   /**
@@ -263,6 +264,11 @@ export namespace LlmResponse {
 
     type: 'transfer_call';
 
+    /**
+     * Custom SIP headers to be added to the call.
+     */
+    custom_sip_headers?: { [key: string]: string };
+
     /**
      * Describes what the tool does, sometimes can also include information about when
      * to call the tool.
@@ -498,7 +504,7 @@ export namespace LlmResponse {
     /**
      * Headers to add to the request.
      */
-    headers?: Record<string, string>;
+    headers?: { [key: string]: string };
 
     /**
      * Method to use for the request, default to POST.
@@ -516,14 +522,14 @@ export namespace LlmResponse {
     /**
      * Query parameters to append to the request URL.
      */
-    query_params?: Record<string, string>;
+    query_params?: { [key: string]: string };
 
     /**
      * A mapping of variable names to JSON paths in the response body. These values
      * will be extracted from the response and made available as dynamic variables for
      * use.
      */
-    response_variables?: Record<string, string>;
+    response_variables?: { [key: string]: string };
 
     /**
      * The maximum time in milliseconds the tool can run before it's considered
@@ -546,7 +552,7 @@ export namespace LlmResponse {
        * The value of properties is an object, where each key is the name of a property
        * and each value is a schema used to validate that property.
        */
-      properties: Record<string, unknown>;
+      properties: { [key: string]: unknown };
 
       /**
        * Type must be "object" for a JSON Schema object.
@@ -562,6 +568,114 @@ export namespace LlmResponse {
     }
   }
 
+  export interface ExtractDynamicVariableTool {
+    /**
+     * Describes what the tool does, sometimes can also include information about when
+     * to call the tool.
+     */
+    description: string;
+
+    /**
+     * Name of the tool. Must be unique within all tools available to LLM at any given
+     * time (general tools + state tools + state edges). Must be consisted of a-z, A-Z,
+     * 0-9, or contain underscores and dashes, with a maximum length of 64 (no space
+     * allowed).
+     */
+    name: string;
+
+    type: 'extract_dynamic_variable';
+
+    /**
+     * The variables to be extracted.
+     */
+    variables: Array<
+      | ExtractDynamicVariableTool.StringAnalysisData
+      | ExtractDynamicVariableTool.EnumAnalysisData
+      | ExtractDynamicVariableTool.BooleanAnalysisData
+      | ExtractDynamicVariableTool.NumberAnalysisData
+    >;
+  }
+
+  export namespace ExtractDynamicVariableTool {
+    export interface StringAnalysisData {
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'string';
+
+      /**
+       * Examples of the variable value to teach model the style and syntax.
+       */
+      examples?: Array<string>;
+    }
+
+    export interface EnumAnalysisData {
+      /**
+       * The possible values of the variable, must be non empty array.
+       */
+      choices: Array<string>;
+
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'enum';
+    }
+
+    export interface BooleanAnalysisData {
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'boolean';
+    }
+
+    export interface NumberAnalysisData {
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'number';
+    }
+  }
+
   export interface State {
     /**
      * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,
@@ -597,6 +711,7 @@ export namespace LlmResponse {
       | State.BookAppointmentCalTool
       | State.PressDigitTool
       | State.CustomTool
+      | State.ExtractDynamicVariableTool
     >;
   }
 
@@ -641,7 +756,7 @@ export namespace LlmResponse {
          * The value of properties is an object, where each key is the name of a property
          * and each value is a schema used to validate that property.
          */
-        properties: Record<string, unknown>;
+        properties: { [key: string]: unknown };
 
         /**
          * Type must be "object" for a JSON Schema object.
@@ -692,6 +807,11 @@ export namespace LlmResponse {
 
       type: 'transfer_call';
 
+      /**
+       * Custom SIP headers to be added to the call.
+       */
+      custom_sip_headers?: { [key: string]: string };
+
       /**
        * Describes what the tool does, sometimes can also include information about when
        * to call the tool.
@@ -927,7 +1047,7 @@ export namespace LlmResponse {
       /**
        * Headers to add to the request.
        */
-      headers?: Record<string, string>;
+      headers?: { [key: string]: string };
 
       /**
        * Method to use for the request, default to POST.
@@ -945,14 +1065,14 @@ export namespace LlmResponse {
       /**
        * Query parameters to append to the request URL.
        */
-      query_params?: Record<string, string>;
+      query_params?: { [key: string]: string };
 
       /**
        * A mapping of variable names to JSON paths in the response body. These values
        * will be extracted from the response and made available as dynamic variables for
        * use.
        */
-      response_variables?: Record<string, string>;
+      response_variables?: { [key: string]: string };
 
       /**
        * The maximum time in milliseconds the tool can run before it's considered
@@ -975,7 +1095,7 @@ export namespace LlmResponse {
          * The value of properties is an object, where each key is the name of a property
          * and each value is a schema used to validate that property.
          */
-        properties: Record<string, unknown>;
+        properties: { [key: string]: unknown };
 
         /**
          * Type must be "object" for a JSON Schema object.
@@ -990,6 +1110,114 @@ export namespace LlmResponse {
         required?: Array<string>;
       }
     }
+
+    export interface ExtractDynamicVariableTool {
+      /**
+       * Describes what the tool does, sometimes can also include information about when
+       * to call the tool.
+       */
+      description: string;
+
+      /**
+       * Name of the tool. Must be unique within all tools available to LLM at any given
+       * time (general tools + state tools + state edges). Must be consisted of a-z, A-Z,
+       * 0-9, or contain underscores and dashes, with a maximum length of 64 (no space
+       * allowed).
+       */
+      name: string;
+
+      type: 'extract_dynamic_variable';
+
+      /**
+       * The variables to be extracted.
+       */
+      variables: Array<
+        | ExtractDynamicVariableTool.StringAnalysisData
+        | ExtractDynamicVariableTool.EnumAnalysisData
+        | ExtractDynamicVariableTool.BooleanAnalysisData
+        | ExtractDynamicVariableTool.NumberAnalysisData
+      >;
+    }
+
+    export namespace ExtractDynamicVariableTool {
+      export interface StringAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'string';
+
+        /**
+         * Examples of the variable value to teach model the style and syntax.
+         */
+        examples?: Array<string>;
+      }
+
+      export interface EnumAnalysisData {
+        /**
+         * The possible values of the variable, must be non empty array.
+         */
+        choices: Array<string>;
+
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'enum';
+      }
+
+      export interface BooleanAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'boolean';
+      }
+
+      export interface NumberAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'number';
+      }
+    }
   }
 }
 
@@ -1007,7 +1235,7 @@ export interface LlmCreateParams {
    * injected into your Retell LLM prompt and tool description when specific values
    * are not provided in a request. Only applicable for Retell LLM.
    */
-  default_dynamic_variables?: Record<string, string> | null;
+  default_dynamic_variables?: { [key: string]: string } | null;
 
   /**
    * General prompt appended to system prompt no matter what state the agent is in.
@@ -1034,6 +1262,7 @@ export interface LlmCreateParams {
     | LlmCreateParams.BookAppointmentCalTool
     | LlmCreateParams.PressDigitTool
     | LlmCreateParams.CustomTool
+    | LlmCreateParams.ExtractDynamicVariableTool
   > | null;
 
   /**
@@ -1142,6 +1371,11 @@ export namespace LlmCreateParams {
 
     type: 'transfer_call';
 
+    /**
+     * Custom SIP headers to be added to the call.
+     */
+    custom_sip_headers?: { [key: string]: string };
+
     /**
      * Describes what the tool does, sometimes can also include information about when
      * to call the tool.
@@ -1377,7 +1611,7 @@ export namespace LlmCreateParams {
     /**
      * Headers to add to the request.
      */
-    headers?: Record<string, string>;
+    headers?: { [key: string]: string };
 
     /**
      * Method to use for the request, default to POST.
@@ -1395,14 +1629,14 @@ export namespace LlmCreateParams {
     /**
      * Query parameters to append to the request URL.
      */
-    query_params?: Record<string, string>;
+    query_params?: { [key: string]: string };
 
     /**
      * A mapping of variable names to JSON paths in the response body. These values
      * will be extracted from the response and made available as dynamic variables for
      * use.
      */
-    response_variables?: Record<string, string>;
+    response_variables?: { [key: string]: string };
 
     /**
      * The maximum time in milliseconds the tool can run before it's considered
@@ -1425,7 +1659,7 @@ export namespace LlmCreateParams {
        * The value of properties is an object, where each key is the name of a property
        * and each value is a schema used to validate that property.
        */
-      properties: Record<string, unknown>;
+      properties: { [key: string]: unknown };
 
       /**
        * Type must be "object" for a JSON Schema object.
@@ -1441,6 +1675,114 @@ export namespace LlmCreateParams {
     }
   }
 
+  export interface ExtractDynamicVariableTool {
+    /**
+     * Describes what the tool does, sometimes can also include information about when
+     * to call the tool.
+     */
+    description: string;
+
+    /**
+     * Name of the tool. Must be unique within all tools available to LLM at any given
+     * time (general tools + state tools + state edges). Must be consisted of a-z, A-Z,
+     * 0-9, or contain underscores and dashes, with a maximum length of 64 (no space
+     * allowed).
+     */
+    name: string;
+
+    type: 'extract_dynamic_variable';
+
+    /**
+     * The variables to be extracted.
+     */
+    variables: Array<
+      | ExtractDynamicVariableTool.StringAnalysisData
+      | ExtractDynamicVariableTool.EnumAnalysisData
+      | ExtractDynamicVariableTool.BooleanAnalysisData
+      | ExtractDynamicVariableTool.NumberAnalysisData
+    >;
+  }
+
+  export namespace ExtractDynamicVariableTool {
+    export interface StringAnalysisData {
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'string';
+
+      /**
+       * Examples of the variable value to teach model the style and syntax.
+       */
+      examples?: Array<string>;
+    }
+
+    export interface EnumAnalysisData {
+      /**
+       * The possible values of the variable, must be non empty array.
+       */
+      choices: Array<string>;
+
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'enum';
+    }
+
+    export interface BooleanAnalysisData {
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'boolean';
+    }
+
+    export interface NumberAnalysisData {
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'number';
+    }
+  }
+
   export interface State {
     /**
      * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,
@@ -1476,6 +1818,7 @@ export namespace LlmCreateParams {
       | State.BookAppointmentCalTool
       | State.PressDigitTool
       | State.CustomTool
+      | State.ExtractDynamicVariableTool
     >;
   }
 
@@ -1520,7 +1863,7 @@ export namespace LlmCreateParams {
          * The value of properties is an object, where each key is the name of a property
          * and each value is a schema used to validate that property.
          */
-        properties: Record<string, unknown>;
+        properties: { [key: string]: unknown };
 
         /**
          * Type must be "object" for a JSON Schema object.
@@ -1571,6 +1914,11 @@ export namespace LlmCreateParams {
 
       type: 'transfer_call';
 
+      /**
+       * Custom SIP headers to be added to the call.
+       */
+      custom_sip_headers?: { [key: string]: string };
+
       /**
        * Describes what the tool does, sometimes can also include information about when
        * to call the tool.
@@ -1806,7 +2154,7 @@ export namespace LlmCreateParams {
       /**
        * Headers to add to the request.
        */
-      headers?: Record<string, string>;
+      headers?: { [key: string]: string };
 
       /**
        * Method to use for the request, default to POST.
@@ -1824,14 +2172,14 @@ export namespace LlmCreateParams {
       /**
        * Query parameters to append to the request URL.
        */
-      query_params?: Record<string, string>;
+      query_params?: { [key: string]: string };
 
       /**
        * A mapping of variable names to JSON paths in the response body. These values
        * will be extracted from the response and made available as dynamic variables for
        * use.
        */
-      response_variables?: Record<string, string>;
+      response_variables?: { [key: string]: string };
 
       /**
        * The maximum time in milliseconds the tool can run before it's considered
@@ -1854,7 +2202,7 @@ export namespace LlmCreateParams {
          * The value of properties is an object, where each key is the name of a property
          * and each value is a schema used to validate that property.
          */
-        properties: Record<string, unknown>;
+        properties: { [key: string]: unknown };
 
         /**
          * Type must be "object" for a JSON Schema object.
@@ -1869,6 +2217,114 @@ export namespace LlmCreateParams {
         required?: Array<string>;
       }
     }
+
+    export interface ExtractDynamicVariableTool {
+      /**
+       * Describes what the tool does, sometimes can also include information about when
+       * to call the tool.
+       */
+      description: string;
+
+      /**
+       * Name of the tool. Must be unique within all tools available to LLM at any given
+       * time (general tools + state tools + state edges). Must be consisted of a-z, A-Z,
+       * 0-9, or contain underscores and dashes, with a maximum length of 64 (no space
+       * allowed).
+       */
+      name: string;
+
+      type: 'extract_dynamic_variable';
+
+      /**
+       * The variables to be extracted.
+       */
+      variables: Array<
+        | ExtractDynamicVariableTool.StringAnalysisData
+        | ExtractDynamicVariableTool.EnumAnalysisData
+        | ExtractDynamicVariableTool.BooleanAnalysisData
+        | ExtractDynamicVariableTool.NumberAnalysisData
+      >;
+    }
+
+    export namespace ExtractDynamicVariableTool {
+      export interface StringAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'string';
+
+        /**
+         * Examples of the variable value to teach model the style and syntax.
+         */
+        examples?: Array<string>;
+      }
+
+      export interface EnumAnalysisData {
+        /**
+         * The possible values of the variable, must be non empty array.
+         */
+        choices: Array<string>;
+
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'enum';
+      }
+
+      export interface BooleanAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'boolean';
+      }
+
+      export interface NumberAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'number';
+      }
+    }
   }
 }
 
@@ -1898,7 +2354,7 @@ export interface LlmUpdateParams {
    * These are injected into your Retell LLM prompt and tool description when
    * specific values are not provided in a request. Only applicable for Retell LLM.
    */
-  default_dynamic_variables?: Record<string, string> | null;
+  default_dynamic_variables?: { [key: string]: string } | null;
 
   /**
    * Body param: General prompt appended to system prompt no matter what state the
@@ -1927,6 +2383,7 @@ export interface LlmUpdateParams {
     | LlmUpdateParams.BookAppointmentCalTool
     | LlmUpdateParams.PressDigitTool
     | LlmUpdateParams.CustomTool
+    | LlmUpdateParams.ExtractDynamicVariableTool
   > | null;
 
   /**
@@ -2035,6 +2492,11 @@ export namespace LlmUpdateParams {
 
     type: 'transfer_call';
 
+    /**
+     * Custom SIP headers to be added to the call.
+     */
+    custom_sip_headers?: { [key: string]: string };
+
     /**
      * Describes what the tool does, sometimes can also include information about when
      * to call the tool.
@@ -2270,7 +2732,7 @@ export namespace LlmUpdateParams {
     /**
      * Headers to add to the request.
      */
-    headers?: Record<string, string>;
+    headers?: { [key: string]: string };
 
     /**
      * Method to use for the request, default to POST.
@@ -2288,14 +2750,14 @@ export namespace LlmUpdateParams {
     /**
      * Query parameters to append to the request URL.
      */
-    query_params?: Record<string, string>;
+    query_params?: { [key: string]: string };
 
     /**
      * A mapping of variable names to JSON paths in the response body. These values
      * will be extracted from the response and made available as dynamic variables for
      * use.
      */
-    response_variables?: Record<string, string>;
+    response_variables?: { [key: string]: string };
 
     /**
      * The maximum time in milliseconds the tool can run before it's considered
@@ -2318,7 +2780,7 @@ export namespace LlmUpdateParams {
        * The value of properties is an object, where each key is the name of a property
        * and each value is a schema used to validate that property.
        */
-      properties: Record<string, unknown>;
+      properties: { [key: string]: unknown };
 
       /**
        * Type must be "object" for a JSON Schema object.
@@ -2334,6 +2796,114 @@ export namespace LlmUpdateParams {
     }
   }
 
+  export interface ExtractDynamicVariableTool {
+    /**
+     * Describes what the tool does, sometimes can also include information about when
+     * to call the tool.
+     */
+    description: string;
+
+    /**
+     * Name of the tool. Must be unique within all tools available to LLM at any given
+     * time (general tools + state tools + state edges). Must be consisted of a-z, A-Z,
+     * 0-9, or contain underscores and dashes, with a maximum length of 64 (no space
+     * allowed).
+     */
+    name: string;
+
+    type: 'extract_dynamic_variable';
+
+    /**
+     * The variables to be extracted.
+     */
+    variables: Array<
+      | ExtractDynamicVariableTool.StringAnalysisData
+      | ExtractDynamicVariableTool.EnumAnalysisData
+      | ExtractDynamicVariableTool.BooleanAnalysisData
+      | ExtractDynamicVariableTool.NumberAnalysisData
+    >;
+  }
+
+  export namespace ExtractDynamicVariableTool {
+    export interface StringAnalysisData {
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'string';
+
+      /**
+       * Examples of the variable value to teach model the style and syntax.
+       */
+      examples?: Array<string>;
+    }
+
+    export interface EnumAnalysisData {
+      /**
+       * The possible values of the variable, must be non empty array.
+       */
+      choices: Array<string>;
+
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'enum';
+    }
+
+    export interface BooleanAnalysisData {
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'boolean';
+    }
+
+    export interface NumberAnalysisData {
+      /**
+       * Description of the variable.
+       */
+      description: string;
+
+      /**
+       * Name of the variable.
+       */
+      name: string;
+
+      /**
+       * Type of the variable to extract.
+       */
+      type: 'number';
+    }
+  }
+
   export interface State {
     /**
      * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,
@@ -2369,6 +2939,7 @@ export namespace LlmUpdateParams {
       | State.BookAppointmentCalTool
       | State.PressDigitTool
       | State.CustomTool
+      | State.ExtractDynamicVariableTool
     >;
   }
 
@@ -2413,7 +2984,7 @@ export namespace LlmUpdateParams {
          * The value of properties is an object, where each key is the name of a property
          * and each value is a schema used to validate that property.
          */
-        properties: Record<string, unknown>;
+        properties: { [key: string]: unknown };
 
         /**
          * Type must be "object" for a JSON Schema object.
@@ -2464,6 +3035,11 @@ export namespace LlmUpdateParams {
 
       type: 'transfer_call';
 
+      /**
+       * Custom SIP headers to be added to the call.
+       */
+      custom_sip_headers?: { [key: string]: string };
+
       /**
        * Describes what the tool does, sometimes can also include information about when
        * to call the tool.
@@ -2699,7 +3275,7 @@ export namespace LlmUpdateParams {
       /**
        * Headers to add to the request.
        */
-      headers?: Record<string, string>;
+      headers?: { [key: string]: string };
 
       /**
        * Method to use for the request, default to POST.
@@ -2717,14 +3293,14 @@ export namespace LlmUpdateParams {
       /**
        * Query parameters to append to the request URL.
        */
-      query_params?: Record<string, string>;
+      query_params?: { [key: string]: string };
 
       /**
        * A mapping of variable names to JSON paths in the response body. These values
        * will be extracted from the response and made available as dynamic variables for
        * use.
        */
-      response_variables?: Record<string, string>;
+      response_variables?: { [key: string]: string };
 
       /**
        * The maximum time in milliseconds the tool can run before it's considered
@@ -2747,7 +3323,7 @@ export namespace LlmUpdateParams {
          * The value of properties is an object, where each key is the name of a property
          * and each value is a schema used to validate that property.
          */
-        properties: Record<string, unknown>;
+        properties: { [key: string]: unknown };
 
         /**
          * Type must be "object" for a JSON Schema object.
@@ -2762,6 +3338,114 @@ export namespace LlmUpdateParams {
         required?: Array<string>;
       }
     }
+
+    export interface ExtractDynamicVariableTool {
+      /**
+       * Describes what the tool does, sometimes can also include information about when
+       * to call the tool.
+       */
+      description: string;
+
+      /**
+       * Name of the tool. Must be unique within all tools available to LLM at any given
+       * time (general tools + state tools + state edges). Must be consisted of a-z, A-Z,
+       * 0-9, or contain underscores and dashes, with a maximum length of 64 (no space
+       * allowed).
+       */
+      name: string;
+
+      type: 'extract_dynamic_variable';
+
+      /**
+       * The variables to be extracted.
+       */
+      variables: Array<
+        | ExtractDynamicVariableTool.StringAnalysisData
+        | ExtractDynamicVariableTool.EnumAnalysisData
+        | ExtractDynamicVariableTool.BooleanAnalysisData
+        | ExtractDynamicVariableTool.NumberAnalysisData
+      >;
+    }
+
+    export namespace ExtractDynamicVariableTool {
+      export interface StringAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'string';
+
+        /**
+         * Examples of the variable value to teach model the style and syntax.
+         */
+        examples?: Array<string>;
+      }
+
+      export interface EnumAnalysisData {
+        /**
+         * The possible values of the variable, must be non empty array.
+         */
+        choices: Array<string>;
+
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'enum';
+      }
+
+      export interface BooleanAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'boolean';
+      }
+
+      export interface NumberAnalysisData {
+        /**
+         * Description of the variable.
+         */
+        description: string;
+
+        /**
+         * Name of the variable.
+         */
+        name: string;
+
+        /**
+         * Type of the variable to extract.
+         */
+        type: 'number';
+      }
+    }
   }
 }