retell-sdk 5.10.3 → 5.12.0

package/src/resources/call.ts

@@ -2733,6 +2733,11 @@ export namespace CallCreatePhoneCallParams {
        */
       guardrail_config?: Agent.GuardrailConfig;
 
+      /**
+       * Toggle behavior presets on/off to influence agent response style and behaviors.
+       */
+      handbook_config?: Agent.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
@@ -2867,6 +2872,7 @@ export namespace CallCreatePhoneCallParams {
         | Agent.EnumAnalysisData
         | Agent.BooleanAnalysisData
         | Agent.NumberAnalysisData
+        | Agent.CallPresetAnalysisData
       > | null;
 
       /**
@@ -2952,6 +2958,12 @@ export namespace CallCreatePhoneCallParams {
        */
       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?: Agent.UserDtmfOptions | null;
 
       /**
@@ -3120,6 +3132,58 @@ export namespace CallCreatePhoneCallParams {
         > | 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
@@ -3181,6 +3245,13 @@ export namespace CallCreatePhoneCallParams {
          */
         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.
          */
@@ -3214,6 +3285,13 @@ export namespace CallCreatePhoneCallParams {
          */
         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.
@@ -3237,6 +3315,13 @@ export namespace CallCreatePhoneCallParams {
          */
         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.
@@ -3260,6 +3345,13 @@ export namespace CallCreatePhoneCallParams {
          */
         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.
@@ -3267,6 +3359,39 @@ export namespace CallCreatePhoneCallParams {
         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.
@@ -3862,6 +3987,11 @@ export namespace CallCreateWebCallParams {
        */
       guardrail_config?: Agent.GuardrailConfig;
 
+      /**
+       * Toggle behavior presets on/off to influence agent response style and behaviors.
+       */
+      handbook_config?: Agent.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
@@ -3996,6 +4126,7 @@ export namespace CallCreateWebCallParams {
         | Agent.EnumAnalysisData
         | Agent.BooleanAnalysisData
         | Agent.NumberAnalysisData
+        | Agent.CallPresetAnalysisData
       > | null;
 
       /**
@@ -4081,6 +4212,12 @@ export namespace CallCreateWebCallParams {
        */
       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?: Agent.UserDtmfOptions | null;
 
       /**
@@ -4249,6 +4386,58 @@ export namespace CallCreateWebCallParams {
         > | 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
@@ -4310,6 +4499,13 @@ export namespace CallCreateWebCallParams {
          */
         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.
          */
@@ -4343,6 +4539,13 @@ export namespace CallCreateWebCallParams {
          */
         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.
@@ -4366,6 +4569,13 @@ export namespace CallCreateWebCallParams {
          */
         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.
@@ -4389,6 +4599,13 @@ export namespace CallCreateWebCallParams {
          */
         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.
@@ -4396,6 +4613,39 @@ export namespace CallCreateWebCallParams {
         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.
@@ -4991,6 +5241,11 @@ export namespace CallRegisterPhoneCallParams {
        */
       guardrail_config?: Agent.GuardrailConfig;
 
+      /**
+       * Toggle behavior presets on/off to influence agent response style and behaviors.
+       */
+      handbook_config?: Agent.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
@@ -5125,6 +5380,7 @@ export namespace CallRegisterPhoneCallParams {
         | Agent.EnumAnalysisData
         | Agent.BooleanAnalysisData
         | Agent.NumberAnalysisData
+        | Agent.CallPresetAnalysisData
       > | null;
 
       /**
@@ -5210,6 +5466,12 @@ export namespace CallRegisterPhoneCallParams {
        */
       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?: Agent.UserDtmfOptions | null;
 
       /**
@@ -5378,6 +5640,58 @@ export namespace CallRegisterPhoneCallParams {
         > | 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
@@ -5439,6 +5753,13 @@ export namespace CallRegisterPhoneCallParams {
          */
         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.
          */
@@ -5472,6 +5793,13 @@ export namespace CallRegisterPhoneCallParams {
          */
         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.
@@ -5495,6 +5823,13 @@ export namespace CallRegisterPhoneCallParams {
          */
         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.
@@ -5518,6 +5853,13 @@ export namespace CallRegisterPhoneCallParams {
          */
         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.
@@ -5525,6 +5867,39 @@ export namespace CallRegisterPhoneCallParams {
         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.