retell-sdk 4.58.0 → 4.59.0

package/resources/batch-call.d.ts

@@ -58,6 +58,12 @@ export declare namespace BatchCallCreateBatchCallParams {
          * from Retell, only US numbers are supported as destination.
          */
         to_number: string;
+        /**
+         * For this particular call, override agent configuration with these settings. This
+         * allows you to customize agent behavior for individual calls without modifying
+         * the base agent.
+         */
+        agent_override?: Task.AgentOverride;
         /**
          * If true, the e.164 validation will be ignored for the from_number. This can be
          * useful when you want to dial to internal pseudo numbers. This only applies when
@@ -84,6 +90,626 @@ export declare namespace BatchCallCreateBatchCallParams {
             [key: string]: unknown;
         };
     }
+    namespace Task {
+        /**
+         * For this particular call, override agent configuration with these settings. This
+         * allows you to customize agent behavior for individual calls without modifying
+         * the base agent.
+         */
+        interface AgentOverride {
+            /**
+             * Override agent configuration settings. Any properties specified here will
+             * override the base agent configuration for this call.
+             */
+            agent?: AgentOverride.Agent;
+            /**
+             * Override conversation flow configuration settings. Only applicable when using
+             * conversation flow as the response engine. Supported attributes - model_choice,
+             * model_temperature, tool_call_strict_mode, knowledge_base_ids, kb_config,
+             * start_speaker, begin_after_user_silence_ms.
+             */
+            conversation_flow?: AgentOverride.ConversationFlow;
+            /**
+             * Override Retell LLM configuration settings. Only applicable when using Retell
+             * LLM as the response engine. Supported attributes - model, s2s_model,
+             * model_temperature, model_high_priority, tool_call_strict_mode,
+             * knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
+             * begin_message.
+             */
+            retell_llm?: AgentOverride.RetellLlm;
+        }
+        namespace AgentOverride {
+            /**
+             * Override agent configuration settings. Any properties specified here will
+             * override the base agent configuration for this call.
+             */
+            interface Agent {
+                /**
+                 * The name of the agent. Only used for your own reference.
+                 */
+                agent_name?: string | null;
+                /**
+                 * If set to true, DTMF input will be accepted and processed. If false, any DTMF
+                 * input will be ignored. Default to true.
+                 */
+                allow_user_dtmf?: boolean;
+                /**
+                 * If set, will add ambient environment sound to the call to make experience more
+                 * realistic. Currently supports the following options:
+                 *
+                 * - `coffee-shop`: Coffee shop ambience with people chatting in background.
+                 *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
+                 *
+                 * - `convention-hall`: Convention hall ambience, with some echo and people
+                 *   chatting in background.
+                 *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
+                 *
+                 * - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
+                 *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
+                 *
+                 * - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
+                 *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
+                 *
+                 * - `static-noise`: Constant static noise.
+                 *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/static-noise.wav)
+                 *
+                 * - `call-center`: Call center work noise.
+                 *   [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/call-center.wav)
+                 *
+                 * Set to `null` to remove ambient sound from this agent.
+                 */
+                ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'static-noise' | 'call-center' | null;
+                /**
+                 * If set, will control the volume of the ambient sound. Value ranging from [0,2].
+                 * Lower value means quieter ambient sound, while higher value means louder ambient
+                 * sound. If unset, default value 1 will apply.
+                 */
+                ambient_sound_volume?: number;
+                /**
+                 * Only applicable when enable_backchannel is true. Controls how often the agent
+                 * would backchannel when a backchannel is possible. Value ranging from [0,1].
+                 * Lower value means less frequent backchannel, while higher value means more
+                 * frequent backchannel. If unset, default value 0.8 will apply.
+                 */
+                backchannel_frequency?: number;
+                /**
+                 * Only applicable when enable_backchannel is true. A list of words that the agent
+                 * would use as backchannel. If not set, default backchannel words will apply.
+                 * Check out
+                 * [backchannel default words](/agent/interaction-configuration#backchannel) for
+                 * more details. Note that certain voices do not work too well with certain words,
+                 * so it's recommended to experiment before adding any words.
+                 */
+                backchannel_words?: Array<string> | null;
+                /**
+                 * If set, will delay the first message by the specified amount of milliseconds, so
+                 * that it gives user more time to prepare to take the call. Valid range is [0,
+                 * 5000]. If not set or set to 0, agent will speak immediately. Only applicable
+                 * when agent speaks first.
+                 */
+                begin_message_delay_ms?: number;
+                /**
+                 * Provide a customized list of keywords to bias the transcriber model, so that
+                 * these words are more likely to get transcribed. Commonly used for names, brands,
+                 * street, etc.
+                 */
+                boosted_keywords?: Array<string> | null;
+                /**
+                 * Granular setting to manage how Retell stores sensitive data (transcripts,
+                 * recordings, logs, etc.). This replaces the deprecated
+                 * `opt_out_sensitive_data_storage` field.
+                 *
+                 * - `everything`: Store all data including transcripts, recordings, and logs.
+                 * - `everything_except_pii`: Store data without PII when PII is detected.
+                 * - `basic_attributes_only`: Store only basic attributes; no
+                 *   transcripts/recordings/logs. If not set, default value of "everything" will
+                 *   apply.
+                 */
+                data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
+                /**
+                 * If set, determines what denoising mode to use. Default to noise-cancellation.
+                 */
+                denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
+                /**
+                 * Controls whether the agent would backchannel (agent interjects the speaker with
+                 * phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
+                 * when enabled tends to show up more in longer user utterances. If not set, agent
+                 * will not backchannel.
+                 */
+                enable_backchannel?: boolean;
+                /**
+                 * If users stay silent for a period after agent speech, end the call. The minimum
+                 * value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
+                 */
+                end_call_after_silence_ms?: number;
+                /**
+                 * When TTS provider for the selected voice is experiencing outages, we would use
+                 * fallback voices listed here for the agent. Voice id and the fallback voice ids
+                 * must be from different TTS providers. The system would go through the list in
+                 * order, if the first one in the list is also having outage, it would use the next
+                 * one. Set to null to remove voice fallback for the agent.
+                 */
+                fallback_voice_ids?: Array<string> | null;
+                /**
+                 * 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
+                 * agent, while higher value means it's easier for user to interrupt agent. If
+                 * unset, default value 1 will apply. When this is set to 0, agent would never be
+                 * interrupted.
+                 */
+                interruption_sensitivity?: number;
+                /**
+                 * Specifies what language (and dialect) the speech recognition will operate in.
+                 * For instance, selecting `en-GB` optimizes speech recognition for British
+                 * English. If unset, will use default value `en-US`. Select `multi` for
+                 * multilingual support, currently this supports Spanish and English.
+                 */
+                language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'th-TH' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'multi';
+                /**
+                 * Maximum allowed length for the call, will force end the call if reached. The
+                 * minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
+                 * 7,200,000 (2 hours). By default, this is set to 3,600,000 (1 hour).
+                 */
+                max_call_duration_ms?: number;
+                /**
+                 * If set to true, will normalize the some part of text (number, currency, date,
+                 * etc) to spoken to its spoken form for more consistent speech synthesis
+                 * (sometimes the voice synthesize system itself might read these wrong with the
+                 * raw text). For example, it will convert "Call my number 2137112342 on Jul 5th,
+                 * 2024 for the $24.12 payment" to "Call my number two one three seven one one two
+                 * three four two on july fifth, twenty twenty four for the twenty four dollars
+                 * twelve cents payment" before starting audio generation.
+                 */
+                normalize_for_speech?: boolean;
+                /**
+                 * Whether this agent opts in for signed URLs for public logs and recordings. When
+                 * enabled, the generated URLs will include security signatures that restrict
+                 * access and automatically expire after 24 hours.
+                 */
+                opt_in_signed_url?: boolean;
+                /**
+                 * Configuration for PII scrubbing from transcripts and recordings.
+                 */
+                pii_config?: Agent.PiiConfig;
+                /**
+                 * Post call analysis data to extract from the call. This data will augment the
+                 * pre-defined variables extracted in the call analysis. This will be available
+                 * after the call ends.
+                 */
+                post_call_analysis_data?: Array<Agent.StringAnalysisData | Agent.EnumAnalysisData | Agent.BooleanAnalysisData | Agent.NumberAnalysisData> | null;
+                /**
+                 * The model to use for post call analysis. Default to gpt-4o-mini.
+                 */
+                post_call_analysis_model?: 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.0-sonnet' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
+                /**
+                 * A list of words / phrases and their pronunciation to be used to guide the audio
+                 * synthesize for consistent pronunciation. Currently only supported for English &
+                 * 11labs voices. Set to null to remove pronunciation dictionary from this agent.
+                 */
+                pronunciation_dictionary?: Array<Agent.PronunciationDictionary> | null;
+                /**
+                 * If set, controls how many times agent would remind user when user is
+                 * unresponsive. Must be a non negative integer. If unset, default value of 1 will
+                 * apply (remind once). Set to 0 to disable agent from reminding.
+                 */
+                reminder_max_count?: number;
+                /**
+                 * If set (in milliseconds), will trigger a reminder to the agent to speak if the
+                 * user has been silent for the specified duration after some agent speech. Must be
+                 * a positive number. If unset, default value of 10000 ms (10 s) will apply.
+                 */
+                reminder_trigger_ms?: number;
+                /**
+                 * The Response Engine to attach to the agent. It is used to generate responses for
+                 * the agent. You need to create a Response Engine first before attaching it to an
+                 * agent.
+                 */
+                response_engine?: Agent.ResponseEngineRetellLm | Agent.ResponseEngineCustomLm | Agent.ResponseEngineConversationFlow;
+                /**
+                 * Controls how responsive is the agent. Value ranging from [0,1]. Lower value
+                 * means less responsive agent (wait more, respond slower), while higher value
+                 * means faster exchanges (respond when it can). If unset, default value 1 will
+                 * apply.
+                 */
+                responsiveness?: number;
+                /**
+                 * If set, the phone ringing will last for the specified amount of milliseconds.
+                 * This applies for both outbound call ringtime, and call transfer ringtime.
+                 * Default to 30000 (30 s). Valid range is [5000, 90000].
+                 */
+                ring_duration_ms?: number;
+                /**
+                 * If set, determines whether speech to text should focus on latency or accuracy.
+                 * Default to fast mode.
+                 */
+                stt_mode?: 'fast' | 'accurate';
+                user_dtmf_options?: Agent.UserDtmfOptions | null;
+                /**
+                 * If set, determines the vocabulary set to use for transcription. This setting
+                 * only applies for English agents, for non English agent, this setting is a no-op.
+                 * Default to general.
+                 */
+                vocab_specialization?: 'general' | 'medical';
+                /**
+                 * Unique voice id used for the agent. Find list of available voices and their
+                 * preview in Dashboard.
+                 */
+                voice_id?: string;
+                /**
+                 * Optionally set the voice model used for the selected voice. Currently only
+                 * elevenlab voices have voice model selections. Set to null to remove voice model
+                 * selection, and default ones will apply. Check out the dashboard for details on
+                 * each voice model.
+                 */
+                voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'tts-1' | 'gpt-4o-mini-tts' | null;
+                /**
+                 * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
+                 * speech, while higher value means faster speech rate. If unset, default value 1
+                 * will apply.
+                 */
+                voice_speed?: number;
+                /**
+                 * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
+                 * more stable, and higher value means more variant speech generation. Currently
+                 * this setting only applies to `11labs` voices. If unset, default value 1 will
+                 * apply.
+                 */
+                voice_temperature?: number;
+                /**
+                 * If this option is set, the call will try to detect voicemail in the first 3
+                 * minutes of the call. Actions defined (hangup, or leave a message) will be
+                 * applied when the voicemail is detected. Set this to null to disable voicemail
+                 * detection.
+                 */
+                voicemail_option?: Agent.VoicemailOption | null;
+                /**
+                 * If set, will control the volume of the agent. Value ranging from [0,2]. Lower
+                 * value means quieter agent speech, while higher value means louder agent speech.
+                 * If unset, default value 1 will apply.
+                 */
+                volume?: number;
+                /**
+                 * The timeout for the webhook in milliseconds. If not set, default value of 10000
+                 * will apply.
+                 */
+                webhook_timeout_ms?: number;
+                /**
+                 * The webhook for agent to listen to call events. See what events it would get at
+                 * [webhook doc](/features/webhook). If set, will binds webhook events for this
+                 * agent to the specified url, and will ignore the account level webhook for this
+                 * agent. Set to `null` to remove webhook url from this agent.
+                 */
+                webhook_url?: string | null;
+            }
+            namespace Agent {
+                /**
+                 * Configuration for PII scrubbing from transcripts and recordings.
+                 */
+                interface PiiConfig {
+                    /**
+                     * List of PII categories to scrub from transcripts and recordings.
+                     */
+                    categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth'>;
+                    /**
+                     * The processing mode for PII scrubbing. Currently only post-call is supported.
+                     */
+                    mode: 'post_call';
+                }
+                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>;
+                }
+                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';
+                }
+                interface BooleanAnalysisData {
+                    /**
+                     * Description of the variable.
+                     */
+                    description: string;
+                    /**
+                     * Name of the variable.
+                     */
+                    name: string;
+                    /**
+                     * Type of the variable to extract.
+                     */
+                    type: 'boolean';
+                }
+                interface NumberAnalysisData {
+                    /**
+                     * Description of the variable.
+                     */
+                    description: string;
+                    /**
+                     * Name of the variable.
+                     */
+                    name: string;
+                    /**
+                     * Type of the variable to extract.
+                     */
+                    type: 'number';
+                }
+                interface PronunciationDictionary {
+                    /**
+                     * The phonetic alphabet to be used for pronunciation.
+                     */
+                    alphabet: 'ipa' | 'cmu';
+                    /**
+                     * Pronunciation of the word in the format of a IPA / CMU pronunciation.
+                     */
+                    phoneme: string;
+                    /**
+                     * The string of word / phrase to be annotated with pronunciation.
+                     */
+                    word: string;
+                }
+                interface ResponseEngineRetellLm {
+                    /**
+                     * id of the Retell LLM Response Engine.
+                     */
+                    llm_id: string;
+                    /**
+                     * type of the Response Engine.
+                     */
+                    type: 'retell-llm';
+                    /**
+                     * Version of the Retell LLM Response Engine.
+                     */
+                    version?: number | null;
+                }
+                interface ResponseEngineCustomLm {
+                    /**
+                     * LLM websocket url of the custom LLM.
+                     */
+                    llm_websocket_url: string;
+                    /**
+                     * type of the Response Engine.
+                     */
+                    type: 'custom-llm';
+                }
+                interface ResponseEngineConversationFlow {
+                    /**
+                     * ID of the Conversation Flow Response Engine.
+                     */
+                    conversation_flow_id: string;
+                    /**
+                     * type of the Response Engine.
+                     */
+                    type: 'conversation-flow';
+                    /**
+                     * Version of the Conversation Flow Response Engine.
+                     */
+                    version?: number | null;
+                }
+                interface UserDtmfOptions {
+                    /**
+                     * The maximum number of digits allowed in the user's DTMF (Dual-Tone
+                     * Multi-Frequency) input per turn. Once this limit is reached, the input is
+                     * considered complete and a response will be generated immediately.
+                     */
+                    digit_limit?: number | null;
+                    /**
+                     * A single key that signals the end of DTMF input. Acceptable values include any
+                     * digit (0–9), the pound/hash symbol (#), or the asterisk (\*).
+                     */
+                    termination_key?: string | null;
+                    /**
+                     * The time (in milliseconds) to wait for user DTMF input before timing out. The
+                     * timer resets with each digit received.
+                     */
+                    timeout_ms?: number;
+                }
+                /**
+                 * If this option is set, the call will try to detect voicemail in the first 3
+                 * minutes of the call. Actions defined (hangup, or leave a message) will be
+                 * applied when the voicemail is detected. Set this to null to disable voicemail
+                 * detection.
+                 */
+                interface VoicemailOption {
+                    action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup;
+                }
+                namespace VoicemailOption {
+                    interface VoicemailActionPrompt {
+                        /**
+                         * The prompt used to generate the text to be spoken when the call is detected to
+                         * be in voicemail.
+                         */
+                        text: string;
+                        type: 'prompt';
+                    }
+                    interface VoicemailActionStaticText {
+                        /**
+                         * The text to be spoken when the call is detected to be in voicemail.
+                         */
+                        text: string;
+                        type: 'static_text';
+                    }
+                    interface VoicemailActionHangup {
+                        type: 'hangup';
+                    }
+                }
+            }
+            /**
+             * Override conversation flow configuration settings. Only applicable when using
+             * conversation flow as the response engine. Supported attributes - model_choice,
+             * model_temperature, tool_call_strict_mode, knowledge_base_ids, kb_config,
+             * start_speaker, begin_after_user_silence_ms.
+             */
+            interface ConversationFlow {
+                /**
+                 * If set, the AI will begin the conversation after waiting for the user for the
+                 * duration (in milliseconds) specified by this attribute. This only applies if the
+                 * agent is configured to wait for the user to speak first. If not set, the agent
+                 * will wait indefinitely for the user to speak.
+                 */
+                begin_after_user_silence_ms?: number | null;
+                /**
+                 * Knowledge base configuration for RAG retrieval.
+                 */
+                kb_config?: ConversationFlow.KBConfig;
+                /**
+                 * Knowledge base IDs for RAG (Retrieval-Augmented Generation).
+                 */
+                knowledge_base_ids?: Array<string> | null;
+                /**
+                 * The model choice for the conversation flow.
+                 */
+                model_choice?: ConversationFlow.ModelChoice;
+                /**
+                 * Controls the randomness of the model's responses. Lower values make responses
+                 * more deterministic.
+                 */
+                model_temperature?: number | null;
+                /**
+                 * Who starts the conversation - user or agent.
+                 */
+                start_speaker?: 'user' | 'agent';
+                /**
+                 * Whether to use strict mode for tool calls. Only applicable when using certain
+                 * supported models.
+                 */
+                tool_call_strict_mode?: boolean | null;
+            }
+            namespace ConversationFlow {
+                /**
+                 * Knowledge base configuration for RAG retrieval.
+                 */
+                interface KBConfig {
+                    /**
+                     * Similarity threshold for filtering search results
+                     */
+                    filter_score?: number;
+                    /**
+                     * Max number of knowledge base chunks to retrieve
+                     */
+                    top_k?: number;
+                }
+                /**
+                 * The model choice for the conversation flow.
+                 */
+                interface ModelChoice {
+                    /**
+                     * The LLM model to use
+                     */
+                    model: 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite';
+                    /**
+                     * Type of model choice
+                     */
+                    type: 'cascading';
+                    /**
+                     * Whether to use high priority pool with more dedicated resource, default false
+                     */
+                    high_priority?: boolean;
+                }
+            }
+            /**
+             * Override Retell LLM configuration settings. Only applicable when using Retell
+             * LLM as the response engine. Supported attributes - model, s2s_model,
+             * model_temperature, model_high_priority, tool_call_strict_mode,
+             * knowledge_base_ids, kb_config, start_speaker, begin_after_user_silence_ms,
+             * begin_message.
+             */
+            interface RetellLlm {
+                /**
+                 * If set, the AI will begin the conversation after waiting for the user for the
+                 * duration (in milliseconds) specified by this attribute. This only applies if the
+                 * agent is configured to wait for the user to speak first. If not set, the agent
+                 * will wait indefinitely for the user to speak.
+                 */
+                begin_after_user_silence_ms?: number | null;
+                /**
+                 * First utterance said by the agent in the call. If not set, LLM will dynamically
+                 * generate a message. If set to "", agent will wait for user to speak first.
+                 */
+                begin_message?: string | null;
+                /**
+                 * Knowledge base configuration for RAG retrieval.
+                 */
+                kb_config?: RetellLlm.KBConfig | null;
+                /**
+                 * A list of knowledge base ids to use for this resource.
+                 */
+                knowledge_base_ids?: Array<string> | null;
+                /**
+                 * Select the underlying text LLM. If not set, would default to gpt-4.1.
+                 */
+                model?: 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'claude-3.7-sonnet' | 'claude-3.5-haiku' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | null;
+                /**
+                 * If set to true, will use high priority pool with more dedicated resource to
+                 * ensure lower and more consistent latency, default to false. This feature usually
+                 * comes with a higher cost.
+                 */
+                model_high_priority?: boolean | null;
+                /**
+                 * If set, will control the randomness of the response. Value ranging from [0,1].
+                 * Lower value means more deterministic, while higher value means more random. If
+                 * unset, default value 0 will apply. Note that for tool calling, a lower value is
+                 * recommended.
+                 */
+                model_temperature?: number;
+                /**
+                 * Select the underlying speech to speech model. Can only set this or model, not
+                 * both.
+                 */
+                s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
+                /**
+                 * The speaker who starts the conversation. Required. Must be either 'user' or
+                 * 'agent'.
+                 */
+                start_speaker?: 'user' | 'agent';
+                /**
+                 * Whether to use strict mode for tool calls. Only applicable when using certain
+                 * supported models.
+                 */
+                tool_call_strict_mode?: boolean | null;
+            }
+            namespace RetellLlm {
+                /**
+                 * Knowledge base configuration for RAG retrieval.
+                 */
+                interface KBConfig {
+                    /**
+                     * Similarity threshold for filtering search results
+                     */
+                    filter_score?: number;
+                    /**
+                     * Max number of knowledge base chunks to retrieve
+                     */
+                    top_k?: number;
+                }
+            }
+        }
+    }
 }
 export declare namespace BatchCall {
     export { type BatchCallResponse as BatchCallResponse, type BatchCallCreateBatchCallParams as BatchCallCreateBatchCallParams, };

package/resources/batch-call.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"batch-call.d.ts","sourceRoot":"","sources":["../src/resources/batch-call.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,eAAe,CACb,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAGtC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;;WAKG;QACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;QAEjC;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;QAEhC;;;;WAIG;QACH,4BAA4B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KAC3D;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
+{"version":3,"file":"batch-call.d.ts","sourceRoot":"","sources":["../src/resources/batch-call.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;OAWG;IACH,eAAe,CACb,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAGtC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;IAElD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,cAAc,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC;QAEpC;;;;;WAKG;QACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;QAEjC;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;QAEhC;;;;WAIG;QACH,4BAA4B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KAC3D;IAED,UAAiB,IAAI,CAAC;QACpB;;;;WAIG;QACH,UAAiB,aAAa;YAC5B;;;eAGG;YACH,KAAK,CAAC,EAAE,aAAa,CAAC,KAAK,CAAC;YAE5B;;;;;eAKG;YACH,iBAAiB,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC;YAEnD;;;;;;eAMG;YACH,UAAU,CAAC,EAAE,aAAa,CAAC,SAAS,CAAC;SACtC;QAED,UAAiB,aAAa,CAAC;YAC7B;;;eAGG;YACH,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE3B;;;mBAGG;gBACH,eAAe,CAAC,EAAE,OAAO,CAAC;gBAE1B;;;;;;;;;;;;;;;;;;;;;;;;mBAwBG;gBACH,aAAa,CAAC,EACV,aAAa,GACb,iBAAiB,GACjB,gBAAgB,GAChB,kBAAkB,GAClB,cAAc,GACd,aAAa,GACb,IAAI,CAAC;gBAET;;;;mBAIG;gBACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;gBAE9B;;;;;mBAKG;gBACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;gBAE/B;;;;;;;mBAOG;gBACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;gBAEzC;;;;;mBAKG;gBACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;gBAEhC;;;;mBAIG;gBACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;gBAExC;;;;;;;;;;mBAUG;gBACH,oBAAoB,CAAC,EAAE,YAAY,GAAG,uBAAuB,GAAG,uBAAuB,CAAC;gBAExF;;mBAEG;gBACH,cAAc,CAAC,EAAE,oBAAoB,GAAG,0CAA0C,CAAC;gBAEnF;;;;;mBAKG;gBACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;gBAE7B;;;mBAGG;gBACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;gBAEnC;;;;;;mBAMG;gBACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;gBAE1C;;;;;;mBAMG;gBACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;gBAElC;;;;;mBAKG;gBACH,QAAQ,CAAC,EACL,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,CAAC;gBAEZ;;;;mBAIG;gBACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;gBAE9B;;;;;;;;mBAQG;gBACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;gBAE/B;;;;mBAIG;gBACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;gBAE5B;;mBAEG;gBACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;gBAE7B;;;;mBAIG;gBACH,uBAAuB,CAAC,EAAE,KAAK,CAC3B,KAAK,CAAC,kBAAkB,GACxB,KAAK,CAAC,gBAAgB,GACtB,KAAK,CAAC,mBAAmB,GACzB,KAAK,CAAC,kBAAkB,CAC3B,GAAG,IAAI,CAAC;gBAET;;mBAEG;gBACH,wBAAwB,CAAC,EACrB,QAAQ,GACR,aAAa,GACb,SAAS,GACT,cAAc,GACd,cAAc,GACd,OAAO,GACP,YAAY,GACZ,YAAY,GACZ,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,uBAAuB,GACvB,kBAAkB,GAClB,uBAAuB,CAAC;gBAE5B;;;;mBAIG;gBACH,wBAAwB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC;gBAEvE;;;;mBAIG;gBACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;gBAE5B;;;;mBAIG;gBACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;gBAE7B;;;;mBAIG;gBACH,eAAe,CAAC,EACZ,KAAK,CAAC,sBAAsB,GAC5B,KAAK,CAAC,sBAAsB,GAC5B,KAAK,CAAC,8BAA8B,CAAC;gBAEzC;;;;;mBAKG;gBACH,cAAc,CAAC,EAAE,MAAM,CAAC;gBAExB;;;;mBAIG;gBACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;gBAE1B;;;mBAGG;gBACH,QAAQ,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;gBAE/B,iBAAiB,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC;gBAEjD;;;;mBAIG;gBACH,oBAAoB,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;gBAE7C;;;mBAGG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;;;mBAKG;gBACH,WAAW,CAAC,EACR,iBAAiB,GACjB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,OAAO,GACP,iBAAiB,GACjB,IAAI,CAAC;gBAET;;;;mBAIG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB;;;;;mBAKG;gBACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;gBAE3B;;;;;mBAKG;gBACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC;gBAEhD;;;;mBAIG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB;;;mBAGG;gBACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;gBAE5B;;;;;mBAKG;gBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aAC7B;YAED,UAAiB,KAAK,CAAC;gBACrB;;mBAEG;gBACH,UAAiB,SAAS;oBACxB;;uBAEG;oBACH,UAAU,EAAE,KAAK,CACb,aAAa,GACb,SAAS,GACT,OAAO,GACP,cAAc,GACd,KAAK,GACL,UAAU,GACV,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,UAAU,GACV,KAAK,GACL,YAAY,GACZ,eAAe,CAClB,CAAC;oBAEF;;uBAEG;oBACH,IAAI,EAAE,WAAW,CAAC;iBACnB;gBAED,UAAiB,kBAAkB;oBACjC;;uBAEG;oBACH,WAAW,EAAE,MAAM,CAAC;oBAEpB;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;oBAEb;;uBAEG;oBACH,IAAI,EAAE,QAAQ,CAAC;oBAEf;;uBAEG;oBACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;iBAC1B;gBAED,UAAiB,gBAAgB;oBAC/B;;uBAEG;oBACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;oBAEvB;;uBAEG;oBACH,WAAW,EAAE,MAAM,CAAC;oBAEpB;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;oBAEb;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;gBAED,UAAiB,mBAAmB;oBAClC;;uBAEG;oBACH,WAAW,EAAE,MAAM,CAAC;oBAEpB;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;oBAEb;;uBAEG;oBACH,IAAI,EAAE,SAAS,CAAC;iBACjB;gBAED,UAAiB,kBAAkB;oBACjC;;uBAEG;oBACH,WAAW,EAAE,MAAM,CAAC;oBAEpB;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;oBAEb;;uBAEG;oBACH,IAAI,EAAE,QAAQ,CAAC;iBAChB;gBAED,UAAiB,uBAAuB;oBACtC;;uBAEG;oBACH,QAAQ,EAAE,KAAK,GAAG,KAAK,CAAC;oBAExB;;uBAEG;oBACH,OAAO,EAAE,MAAM,CAAC;oBAEhB;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;gBAED,UAAiB,sBAAsB;oBACrC;;uBAEG;oBACH,MAAM,EAAE,MAAM,CAAC;oBAEf;;uBAEG;oBACH,IAAI,EAAE,YAAY,CAAC;oBAEnB;;uBAEG;oBACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;iBACzB;gBAED,UAAiB,sBAAsB;oBACrC;;uBAEG;oBACH,iBAAiB,EAAE,MAAM,CAAC;oBAE1B;;uBAEG;oBACH,IAAI,EAAE,YAAY,CAAC;iBACpB;gBAED,UAAiB,8BAA8B;oBAC7C;;uBAEG;oBACH,oBAAoB,EAAE,MAAM,CAAC;oBAE7B;;uBAEG;oBACH,IAAI,EAAE,mBAAmB,CAAC;oBAE1B;;uBAEG;oBACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;iBACzB;gBAED,UAAiB,eAAe;oBAC9B;;;;uBAIG;oBACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;oBAE5B;;;uBAGG;oBACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;oBAEhC;;;uBAGG;oBACH,UAAU,CAAC,EAAE,MAAM,CAAC;iBACrB;gBAED;;;;;mBAKG;gBACH,UAAiB,eAAe;oBAC9B,MAAM,EACF,eAAe,CAAC,qBAAqB,GACrC,eAAe,CAAC,yBAAyB,GACzC,eAAe,CAAC,qBAAqB,CAAC;iBAC3C;gBAED,UAAiB,eAAe,CAAC;oBAC/B,UAAiB,qBAAqB;wBACpC;;;2BAGG;wBACH,IAAI,EAAE,MAAM,CAAC;wBAEb,IAAI,EAAE,QAAQ,CAAC;qBAChB;oBAED,UAAiB,yBAAyB;wBACxC;;2BAEG;wBACH,IAAI,EAAE,MAAM,CAAC;wBAEb,IAAI,EAAE,aAAa,CAAC;qBACrB;oBAED,UAAiB,qBAAqB;wBACpC,IAAI,EAAE,QAAQ,CAAC;qBAChB;iBACF;aACF;YAED;;;;;eAKG;YACH,UAAiB,gBAAgB;gBAC/B;;;;;mBAKG;gBACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5C;;mBAEG;gBACH,SAAS,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC;gBAEtC;;mBAEG;gBACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;gBAE1C;;mBAEG;gBACH,YAAY,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC;gBAE5C;;;mBAGG;gBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElC;;mBAEG;gBACH,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;gBAEjC;;;mBAGG;gBACH,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;aACxC;YAED,UAAiB,gBAAgB,CAAC;gBAChC;;mBAEG;gBACH,UAAiB,QAAQ;oBACvB;;uBAEG;oBACH,YAAY,CAAC,EAAE,MAAM,CAAC;oBAEtB;;uBAEG;oBACH,KAAK,CAAC,EAAE,MAAM,CAAC;iBAChB;gBAED;;mBAEG;gBACH,UAAiB,WAAW;oBAC1B;;uBAEG;oBACH,KAAK,EACD,OAAO,GACP,YAAY,GACZ,YAAY,GACZ,QAAQ,GACR,aAAa,GACb,SAAS,GACT,cAAc,GACd,cAAc,GACd,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,uBAAuB,GACvB,kBAAkB,GAClB,uBAAuB,CAAC;oBAE5B;;uBAEG;oBACH,IAAI,EAAE,WAAW,CAAC;oBAElB;;uBAEG;oBACH,aAAa,CAAC,EAAE,OAAO,CAAC;iBACzB;aACF;YAED;;;;;;eAMG;YACH,UAAiB,SAAS;gBACxB;;;;;mBAKG;gBACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5C;;;mBAGG;gBACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE9B;;mBAEG;gBACH,SAAS,CAAC,EAAE,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC;gBAEtC;;mBAEG;gBACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;gBAE1C;;mBAEG;gBACH,KAAK,CAAC,EACF,OAAO,GACP,YAAY,GACZ,YAAY,GACZ,QAAQ,GACR,aAAa,GACb,SAAS,GACT,cAAc,GACd,cAAc,GACd,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,uBAAuB,GACvB,kBAAkB,GAClB,uBAAuB,GACvB,IAAI,CAAC;gBAET;;;;mBAIG;gBACH,mBAAmB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;gBAErC;;;;;mBAKG;gBACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;gBAE3B;;;mBAGG;gBACH,SAAS,CAAC,EAAE,iBAAiB,GAAG,sBAAsB,GAAG,cAAc,GAAG,IAAI,CAAC;gBAE/E;;;mBAGG;gBACH,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;gBAEjC;;;mBAGG;gBACH,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;aACxC;YAED,UAAiB,SAAS,CAAC;gBACzB;;mBAEG;gBACH,UAAiB,QAAQ;oBACvB;;uBAEG;oBACH,YAAY,CAAC,EAAE,MAAM,CAAC;oBAEtB;;uBAEG;oBACH,KAAK,CAAC,EAAE,MAAM,CAAC;iBAChB;aACF;SACF;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}