retell-sdk 5.10.3 → 5.12.0

package/src/resources/agent.ts

@@ -329,6 +329,11 @@ export interface AgentResponse {
    */
   guardrail_config?: AgentResponse.GuardrailConfig;
 
+  /**
+   * Toggle behavior presets on/off to influence agent response style and behaviors.
+   */
+  handbook_config?: AgentResponse.HandbookConfig;
+
   /**
    * Controls how sensitive the agent is to user interruptions. Value ranging from
    * [0,1]. Lower value means it will take longer / more words for user to interrupt
@@ -468,6 +473,7 @@ export interface AgentResponse {
     | AgentResponse.EnumAnalysisData
     | AgentResponse.BooleanAnalysisData
     | AgentResponse.NumberAnalysisData
+    | AgentResponse.CallPresetAnalysisData
   > | null;
 
   /**
@@ -543,6 +549,12 @@ export interface AgentResponse {
    */
   stt_mode?: 'fast' | 'accurate' | 'custom';
 
+  /**
+   * IANA timezone for the agent (e.g. America/New_York). Defaults to
+   * America/Los_Angeles if not set.
+   */
+  timezone?: string | null;
+
   user_dtmf_options?: AgentResponse.UserDtmfOptions | null;
 
   /**
@@ -751,6 +763,58 @@ export namespace AgentResponse {
     > | null;
   }
 
+  /**
+   * Toggle behavior presets on/off to influence agent response style and behaviors.
+   */
+  export interface HandbookConfig {
+    /**
+     * When asked, acknowledge being a virtual assistant.
+     */
+    ai_disclosure?: boolean;
+
+    /**
+     * Professional call center rep baseline.
+     */
+    default_personality?: boolean;
+
+    /**
+     * Repeat back and confirm important details (voice only).
+     */
+    echo_verification?: boolean;
+
+    /**
+     * Warm acknowledgment of caller concerns.
+     */
+    high_empathy?: boolean;
+
+    /**
+     * Spell using NATO phonetic alphabet style (voice only).
+     */
+    nato_phonetic_alphabet?: boolean;
+
+    /**
+     * Sprinkle natural speech fillers like "um", "you know" for a more human,
+     * conversational tone.
+     */
+    natural_filler_words?: boolean;
+
+    /**
+     * Stay within prompt/context scope, don't invent details.
+     */
+    scope_boundaries?: boolean;
+
+    /**
+     * Treat near-match similar words as same entity to reduce impact of transcription
+     * error (voice only).
+     */
+    smart_matching?: boolean;
+
+    /**
+     * Convert numbers/dates/currency to spoken forms (voice only).
+     */
+    speech_normalization?: boolean;
+  }
+
   /**
    * If this option is set, the call will try to detect IVR in the first 3 minutes of
    * the call. Actions defined will be applied when the IVR is detected. Set this to
@@ -812,6 +876,13 @@ export namespace AgentResponse {
      */
     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.
      */
@@ -845,6 +916,13 @@ export namespace AgentResponse {
      */
     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.
@@ -868,6 +946,13 @@ export namespace AgentResponse {
      */
     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.
@@ -891,6 +976,13 @@ export namespace AgentResponse {
      */
     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.
@@ -898,6 +990,39 @@ export namespace AgentResponse {
     required?: boolean;
   }
 
+  /**
+   * System preset for post-call analysis (voice agents). Use in
+   * post_call_analysis_data to override prompts or mark fields optional.
+   */
+  export interface CallPresetAnalysisData {
+    /**
+     * Preset identifier for voice agent analysis.
+     */
+    name: 'call_summary' | 'call_successful' | 'user_sentiment';
+
+    /**
+     * Identifies this item as a system preset.
+     */
+    type: 'system-presets';
+
+    /**
+     * Optional instruction to help decide whether this field needs to be populated. If
+     * not set, the field is always included.
+     */
+    conditional_prompt?: string;
+
+    /**
+     * Prompt or description for this preset.
+     */
+    description?: string;
+
+    /**
+     * If false, this field is optional in the analysis. If true or unset, the field is
+     * required.
+     */
+    required?: boolean;
+  }
+
   export interface PronunciationDictionary {
     /**
      * The phonetic alphabet to be used for pronunciation.
@@ -1173,6 +1298,11 @@ export interface AgentCreateParams {
    */
   guardrail_config?: AgentCreateParams.GuardrailConfig;
 
+  /**
+   * Toggle behavior presets on/off to influence agent response style and behaviors.
+   */
+  handbook_config?: AgentCreateParams.HandbookConfig;
+
   /**
    * Controls how sensitive the agent is to user interruptions. Value ranging from
    * [0,1]. Lower value means it will take longer / more words for user to interrupt
@@ -1307,6 +1437,7 @@ export interface AgentCreateParams {
     | AgentCreateParams.EnumAnalysisData
     | AgentCreateParams.BooleanAnalysisData
     | AgentCreateParams.NumberAnalysisData
+    | AgentCreateParams.CallPresetAnalysisData
   > | null;
 
   /**
@@ -1382,6 +1513,12 @@ export interface AgentCreateParams {
    */
   stt_mode?: 'fast' | 'accurate' | 'custom';
 
+  /**
+   * IANA timezone for the agent (e.g. America/New_York). Defaults to
+   * America/Los_Angeles if not set.
+   */
+  timezone?: string | null;
+
   user_dtmf_options?: AgentCreateParams.UserDtmfOptions | null;
 
   /**
@@ -1590,6 +1727,58 @@ export namespace AgentCreateParams {
     > | null;
   }
 
+  /**
+   * Toggle behavior presets on/off to influence agent response style and behaviors.
+   */
+  export interface HandbookConfig {
+    /**
+     * When asked, acknowledge being a virtual assistant.
+     */
+    ai_disclosure?: boolean;
+
+    /**
+     * Professional call center rep baseline.
+     */
+    default_personality?: boolean;
+
+    /**
+     * Repeat back and confirm important details (voice only).
+     */
+    echo_verification?: boolean;
+
+    /**
+     * Warm acknowledgment of caller concerns.
+     */
+    high_empathy?: boolean;
+
+    /**
+     * Spell using NATO phonetic alphabet style (voice only).
+     */
+    nato_phonetic_alphabet?: boolean;
+
+    /**
+     * Sprinkle natural speech fillers like "um", "you know" for a more human,
+     * conversational tone.
+     */
+    natural_filler_words?: boolean;
+
+    /**
+     * Stay within prompt/context scope, don't invent details.
+     */
+    scope_boundaries?: boolean;
+
+    /**
+     * Treat near-match similar words as same entity to reduce impact of transcription
+     * error (voice only).
+     */
+    smart_matching?: boolean;
+
+    /**
+     * Convert numbers/dates/currency to spoken forms (voice only).
+     */
+    speech_normalization?: boolean;
+  }
+
   /**
    * If this option is set, the call will try to detect IVR in the first 3 minutes of
    * the call. Actions defined will be applied when the IVR is detected. Set this to
@@ -1651,6 +1840,13 @@ export namespace AgentCreateParams {
      */
     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.
      */
@@ -1684,6 +1880,13 @@ export namespace AgentCreateParams {
      */
     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.
@@ -1707,6 +1910,13 @@ export namespace AgentCreateParams {
      */
     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.
@@ -1730,6 +1940,13 @@ export namespace AgentCreateParams {
      */
     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.
@@ -1737,6 +1954,39 @@ export namespace AgentCreateParams {
     required?: boolean;
   }
 
+  /**
+   * System preset for post-call analysis (voice agents). Use in
+   * post_call_analysis_data to override prompts or mark fields optional.
+   */
+  export interface CallPresetAnalysisData {
+    /**
+     * Preset identifier for voice agent analysis.
+     */
+    name: 'call_summary' | 'call_successful' | 'user_sentiment';
+
+    /**
+     * Identifies this item as a system preset.
+     */
+    type: 'system-presets';
+
+    /**
+     * Optional instruction to help decide whether this field needs to be populated. If
+     * not set, the field is always included.
+     */
+    conditional_prompt?: string;
+
+    /**
+     * Prompt or description for this preset.
+     */
+    description?: string;
+
+    /**
+     * If false, this field is optional in the analysis. If true or unset, the field is
+     * required.
+     */
+    required?: boolean;
+  }
+
   export interface PronunciationDictionary {
     /**
      * The phonetic alphabet to be used for pronunciation.
@@ -2008,6 +2258,12 @@ export interface AgentUpdateParams {
    */
   guardrail_config?: AgentUpdateParams.GuardrailConfig;
 
+  /**
+   * Body param: Toggle behavior presets on/off to influence agent response style and
+   * behaviors.
+   */
+  handbook_config?: AgentUpdateParams.HandbookConfig;
+
   /**
    * Body param: Controls how sensitive the agent is to user interruptions. Value
    * ranging from [0,1]. Lower value means it will take longer / more words for user
@@ -2142,6 +2398,7 @@ export interface AgentUpdateParams {
     | AgentUpdateParams.EnumAnalysisData
     | AgentUpdateParams.BooleanAnalysisData
     | AgentUpdateParams.NumberAnalysisData
+    | AgentUpdateParams.CallPresetAnalysisData
   > | null;
 
   /**
@@ -2229,6 +2486,12 @@ export interface AgentUpdateParams {
    */
   stt_mode?: 'fast' | 'accurate' | 'custom';
 
+  /**
+   * Body param: IANA timezone for the agent (e.g. America/New_York). Defaults to
+   * America/Los_Angeles if not set.
+   */
+  timezone?: string | null;
+
   /**
    * Body param
    */
@@ -2402,6 +2665,58 @@ export namespace AgentUpdateParams {
     > | null;
   }
 
+  /**
+   * Toggle behavior presets on/off to influence agent response style and behaviors.
+   */
+  export interface HandbookConfig {
+    /**
+     * When asked, acknowledge being a virtual assistant.
+     */
+    ai_disclosure?: boolean;
+
+    /**
+     * Professional call center rep baseline.
+     */
+    default_personality?: boolean;
+
+    /**
+     * Repeat back and confirm important details (voice only).
+     */
+    echo_verification?: boolean;
+
+    /**
+     * Warm acknowledgment of caller concerns.
+     */
+    high_empathy?: boolean;
+
+    /**
+     * Spell using NATO phonetic alphabet style (voice only).
+     */
+    nato_phonetic_alphabet?: boolean;
+
+    /**
+     * Sprinkle natural speech fillers like "um", "you know" for a more human,
+     * conversational tone.
+     */
+    natural_filler_words?: boolean;
+
+    /**
+     * Stay within prompt/context scope, don't invent details.
+     */
+    scope_boundaries?: boolean;
+
+    /**
+     * Treat near-match similar words as same entity to reduce impact of transcription
+     * error (voice only).
+     */
+    smart_matching?: boolean;
+
+    /**
+     * Convert numbers/dates/currency to spoken forms (voice only).
+     */
+    speech_normalization?: boolean;
+  }
+
   /**
    * If this option is set, the call will try to detect IVR in the first 3 minutes of
    * the call. Actions defined will be applied when the IVR is detected. Set this to
@@ -2463,6 +2778,13 @@ export namespace AgentUpdateParams {
      */
     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.
      */
@@ -2496,6 +2818,13 @@ export namespace AgentUpdateParams {
      */
     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.
@@ -2519,6 +2848,13 @@ export namespace AgentUpdateParams {
      */
     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.
@@ -2542,6 +2878,13 @@ export namespace AgentUpdateParams {
      */
     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.
@@ -2549,6 +2892,39 @@ export namespace AgentUpdateParams {
     required?: boolean;
   }
 
+  /**
+   * System preset for post-call analysis (voice agents). Use in
+   * post_call_analysis_data to override prompts or mark fields optional.
+   */
+  export interface CallPresetAnalysisData {
+    /**
+     * Preset identifier for voice agent analysis.
+     */
+    name: 'call_summary' | 'call_successful' | 'user_sentiment';
+
+    /**
+     * Identifies this item as a system preset.
+     */
+    type: 'system-presets';
+
+    /**
+     * Optional instruction to help decide whether this field needs to be populated. If
+     * not set, the field is always included.
+     */
+    conditional_prompt?: string;
+
+    /**
+     * Prompt or description for this preset.
+     */
+    description?: string;
+
+    /**
+     * If false, this field is optional in the analysis. If true or unset, the field is
+     * required.
+     */
+    required?: boolean;
+  }
+
   export interface PronunciationDictionary {
     /**
      * The phonetic alphabet to be used for pronunciation.