retell-sdk 5.10.2 → 5.11.0

package/src/resources/batch-call.ts

@@ -399,6 +399,11 @@ export namespace BatchCallCreateBatchCallParams {
          */
         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
@@ -533,6 +538,7 @@ export namespace BatchCallCreateBatchCallParams {
           | Agent.EnumAnalysisData
           | Agent.BooleanAnalysisData
           | Agent.NumberAnalysisData
+          | Agent.CallPresetAnalysisData
         > | null;
 
         /**
@@ -618,6 +624,12 @@ export namespace BatchCallCreateBatchCallParams {
          */
         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;
 
         /**
@@ -786,6 +798,58 @@ export namespace BatchCallCreateBatchCallParams {
           > | 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
@@ -847,6 +911,13 @@ export namespace BatchCallCreateBatchCallParams {
            */
           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.
            */
@@ -880,6 +951,13 @@ export namespace BatchCallCreateBatchCallParams {
            */
           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.
@@ -903,6 +981,13 @@ export namespace BatchCallCreateBatchCallParams {
            */
           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.
@@ -926,6 +1011,13 @@ export namespace BatchCallCreateBatchCallParams {
            */
           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.
@@ -933,6 +1025,39 @@ export namespace BatchCallCreateBatchCallParams {
           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.