retell-sdk 6.1.0 → 6.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5660,6 +5660,15 @@ export declare namespace CallCreatePhoneCallParams {
5660
5660
  * apply.
5661
5661
  */
5662
5662
  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
5663
+ /**
5664
+ * Controls the enhancement level for background voice cancellation. Set to 0 to
5665
+ * bypass background voice cancellation without BVC charges. Value ranging from
5666
+ * [0,1]. Only applicable when denoising_mode is
5667
+ * noise-and-background-speech-cancellation. Defaults to 0.8 if no value is
5668
+ * configured. Set to null to clear the configured value. Omitting this field
5669
+ * preserves the existing value.
5670
+ */
5671
+ denoising_enhancement_level?: number | null;
5663
5672
  /**
5664
5673
  * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
5665
5674
  * audio denoising. Default to noise-cancellation.
@@ -5876,7 +5885,7 @@ export declare namespace CallCreatePhoneCallParams {
5876
5885
  * available voice models. Set to null to remove voice model selection, and default
5877
5886
  * ones will apply. Check out dashboard for more details of each voice model.
5878
5887
  */
5879
- voice_model?: 'eleven_flash_v2' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'eleven_v3' | 'eleven_v4_turbo' | 'sonic-3' | 'sonic-3-latest' | 'sonic-3.5' | 'sonic-3.6' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | 's1' | 's2-pro' | 's2.1-pro' | 'inworld-tts-2' | 'inworld-tts-2-flash' | null;
5888
+ voice_model?: 'eleven_flash_v2' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'eleven_v3' | 'eleven_v3_conversational' | 'eleven_v4' | 'eleven_v4_turbo' | 'sonic-3' | 'sonic-3-latest' | 'sonic-3.5' | 'sonic-3.6' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | 's1' | 's2-pro' | 's2.1-pro' | 'inworld-tts-2' | 'inworld-tts-2-flash' | null;
5880
5889
  /**
5881
5890
  * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
5882
5891
  * speech, while higher value means faster speech rate. If unset, default value 1
@@ -7198,7 +7207,7 @@ export declare namespace CallCreatePhoneCallParams {
7198
7207
  /**
7199
7208
  * The model choice for the conversation flow.
7200
7209
  */
7201
- model_choice?: ConversationFlow.ModelChoice;
7210
+ model_choice?: ConversationFlow.ModelChoiceCascading | ConversationFlow.ModelChoiceS2S;
7202
7211
  /**
7203
7212
  * Controls the randomness of the model's responses. Lower values make responses
7204
7213
  * more deterministic.
@@ -7228,10 +7237,7 @@ export declare namespace CallCreatePhoneCallParams {
7228
7237
  */
7229
7238
  top_k?: number;
7230
7239
  }
7231
- /**
7232
- * The model choice for the conversation flow.
7233
- */
7234
- interface ModelChoice {
7240
+ interface ModelChoiceCascading {
7235
7241
  /**
7236
7242
  * The LLM model to use
7237
7243
  */
@@ -7245,6 +7251,16 @@ export declare namespace CallCreatePhoneCallParams {
7245
7251
  */
7246
7252
  high_priority?: boolean;
7247
7253
  }
7254
+ interface ModelChoiceS2S {
7255
+ /**
7256
+ * The speech-to-speech model to use
7257
+ */
7258
+ model: 'gpt-realtime-2.1' | 'gpt-realtime-2.1-mini' | 'gpt-realtime-2' | 'gpt-realtime-1.5' | 'gpt-realtime' | 'gpt-realtime-mini';
7259
+ /**
7260
+ * Type of model choice
7261
+ */
7262
+ type: 's2s';
7263
+ }
7248
7264
  }
7249
7265
  /**
7250
7266
  * Override Retell LLM configuration settings. Only applicable when using Retell
@@ -7507,6 +7523,15 @@ export declare namespace CallCreateWebCallParams {
7507
7523
  * apply.
7508
7524
  */
7509
7525
  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
7526
+ /**
7527
+ * Controls the enhancement level for background voice cancellation. Set to 0 to
7528
+ * bypass background voice cancellation without BVC charges. Value ranging from
7529
+ * [0,1]. Only applicable when denoising_mode is
7530
+ * noise-and-background-speech-cancellation. Defaults to 0.8 if no value is
7531
+ * configured. Set to null to clear the configured value. Omitting this field
7532
+ * preserves the existing value.
7533
+ */
7534
+ denoising_enhancement_level?: number | null;
7510
7535
  /**
7511
7536
  * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
7512
7537
  * audio denoising. Default to noise-cancellation.
@@ -7723,7 +7748,7 @@ export declare namespace CallCreateWebCallParams {
7723
7748
  * available voice models. Set to null to remove voice model selection, and default
7724
7749
  * ones will apply. Check out dashboard for more details of each voice model.
7725
7750
  */
7726
- voice_model?: 'eleven_flash_v2' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'eleven_v3' | 'eleven_v4_turbo' | 'sonic-3' | 'sonic-3-latest' | 'sonic-3.5' | 'sonic-3.6' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | 's1' | 's2-pro' | 's2.1-pro' | 'inworld-tts-2' | 'inworld-tts-2-flash' | null;
7751
+ voice_model?: 'eleven_flash_v2' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'eleven_v3' | 'eleven_v3_conversational' | 'eleven_v4' | 'eleven_v4_turbo' | 'sonic-3' | 'sonic-3-latest' | 'sonic-3.5' | 'sonic-3.6' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | 's1' | 's2-pro' | 's2.1-pro' | 'inworld-tts-2' | 'inworld-tts-2-flash' | null;
7727
7752
  /**
7728
7753
  * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
7729
7754
  * speech, while higher value means faster speech rate. If unset, default value 1
@@ -9045,7 +9070,7 @@ export declare namespace CallCreateWebCallParams {
9045
9070
  /**
9046
9071
  * The model choice for the conversation flow.
9047
9072
  */
9048
- model_choice?: ConversationFlow.ModelChoice;
9073
+ model_choice?: ConversationFlow.ModelChoiceCascading | ConversationFlow.ModelChoiceS2S;
9049
9074
  /**
9050
9075
  * Controls the randomness of the model's responses. Lower values make responses
9051
9076
  * more deterministic.
@@ -9075,10 +9100,7 @@ export declare namespace CallCreateWebCallParams {
9075
9100
  */
9076
9101
  top_k?: number;
9077
9102
  }
9078
- /**
9079
- * The model choice for the conversation flow.
9080
- */
9081
- interface ModelChoice {
9103
+ interface ModelChoiceCascading {
9082
9104
  /**
9083
9105
  * The LLM model to use
9084
9106
  */
@@ -9092,6 +9114,16 @@ export declare namespace CallCreateWebCallParams {
9092
9114
  */
9093
9115
  high_priority?: boolean;
9094
9116
  }
9117
+ interface ModelChoiceS2S {
9118
+ /**
9119
+ * The speech-to-speech model to use
9120
+ */
9121
+ model: 'gpt-realtime-2.1' | 'gpt-realtime-2.1-mini' | 'gpt-realtime-2' | 'gpt-realtime-1.5' | 'gpt-realtime' | 'gpt-realtime-mini';
9122
+ /**
9123
+ * Type of model choice
9124
+ */
9125
+ type: 's2s';
9126
+ }
9095
9127
  }
9096
9128
  /**
9097
9129
  * Override Retell LLM configuration settings. Only applicable when using Retell
@@ -9353,6 +9385,15 @@ export declare namespace CallRegisterPhoneCallParams {
9353
9385
  * apply.
9354
9386
  */
9355
9387
  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
9388
+ /**
9389
+ * Controls the enhancement level for background voice cancellation. Set to 0 to
9390
+ * bypass background voice cancellation without BVC charges. Value ranging from
9391
+ * [0,1]. Only applicable when denoising_mode is
9392
+ * noise-and-background-speech-cancellation. Defaults to 0.8 if no value is
9393
+ * configured. Set to null to clear the configured value. Omitting this field
9394
+ * preserves the existing value.
9395
+ */
9396
+ denoising_enhancement_level?: number | null;
9356
9397
  /**
9357
9398
  * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
9358
9399
  * audio denoising. Default to noise-cancellation.
@@ -9569,7 +9610,7 @@ export declare namespace CallRegisterPhoneCallParams {
9569
9610
  * available voice models. Set to null to remove voice model selection, and default
9570
9611
  * ones will apply. Check out dashboard for more details of each voice model.
9571
9612
  */
9572
- voice_model?: 'eleven_flash_v2' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'eleven_v3' | 'eleven_v4_turbo' | 'sonic-3' | 'sonic-3-latest' | 'sonic-3.5' | 'sonic-3.6' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | 's1' | 's2-pro' | 's2.1-pro' | 'inworld-tts-2' | 'inworld-tts-2-flash' | null;
9613
+ voice_model?: 'eleven_flash_v2' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'eleven_v3' | 'eleven_v3_conversational' | 'eleven_v4' | 'eleven_v4_turbo' | 'sonic-3' | 'sonic-3-latest' | 'sonic-3.5' | 'sonic-3.6' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | 's1' | 's2-pro' | 's2.1-pro' | 'inworld-tts-2' | 'inworld-tts-2-flash' | null;
9573
9614
  /**
9574
9615
  * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
9575
9616
  * speech, while higher value means faster speech rate. If unset, default value 1
@@ -10891,7 +10932,7 @@ export declare namespace CallRegisterPhoneCallParams {
10891
10932
  /**
10892
10933
  * The model choice for the conversation flow.
10893
10934
  */
10894
- model_choice?: ConversationFlow.ModelChoice;
10935
+ model_choice?: ConversationFlow.ModelChoiceCascading | ConversationFlow.ModelChoiceS2S;
10895
10936
  /**
10896
10937
  * Controls the randomness of the model's responses. Lower values make responses
10897
10938
  * more deterministic.
@@ -10921,10 +10962,7 @@ export declare namespace CallRegisterPhoneCallParams {
10921
10962
  */
10922
10963
  top_k?: number;
10923
10964
  }
10924
- /**
10925
- * The model choice for the conversation flow.
10926
- */
10927
- interface ModelChoice {
10965
+ interface ModelChoiceCascading {
10928
10966
  /**
10929
10967
  * The LLM model to use
10930
10968
  */
@@ -10938,6 +10976,16 @@ export declare namespace CallRegisterPhoneCallParams {
10938
10976
  */
10939
10977
  high_priority?: boolean;
10940
10978
  }
10979
+ interface ModelChoiceS2S {
10980
+ /**
10981
+ * The speech-to-speech model to use
10982
+ */
10983
+ model: 'gpt-realtime-2.1' | 'gpt-realtime-2.1-mini' | 'gpt-realtime-2' | 'gpt-realtime-1.5' | 'gpt-realtime' | 'gpt-realtime-mini';
10984
+ /**
10985
+ * Type of model choice
10986
+ */
10987
+ type: 's2s';
10988
+ }
10941
10989
  }
10942
10990
  /**
10943
10991
  * Override Retell LLM configuration settings. Only applicable when using Retell