retell-sdk 6.1.1 → 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.
@@ -377,6 +377,16 @@ export interface AgentResponse {
377
377
  */
378
378
  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
379
379
 
380
+ /**
381
+ * Controls the enhancement level for background voice cancellation. Set to 0 to
382
+ * bypass background voice cancellation without BVC charges. Value ranging from
383
+ * [0,1]. Only applicable when denoising_mode is
384
+ * noise-and-background-speech-cancellation. Defaults to 0.8 if no value is
385
+ * configured. Set to null to clear the configured value. Omitting this field
386
+ * preserves the existing value.
387
+ */
388
+ denoising_enhancement_level?: number | null;
389
+
380
390
  /**
381
391
  * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
382
392
  * audio denoising. Default to noise-cancellation.
@@ -807,6 +817,8 @@ export interface AgentResponse {
807
817
  | 'eleven_flash_v2_5'
808
818
  | 'eleven_multilingual_v2'
809
819
  | 'eleven_v3'
820
+ | 'eleven_v3_conversational'
821
+ | 'eleven_v4'
810
822
  | 'eleven_v4_turbo'
811
823
  | 'sonic-3'
812
824
  | 'sonic-3-latest'
@@ -2658,6 +2670,16 @@ export interface AgentCreateParams {
2658
2670
  */
2659
2671
  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
2660
2672
 
2673
+ /**
2674
+ * Controls the enhancement level for background voice cancellation. Set to 0 to
2675
+ * bypass background voice cancellation without BVC charges. Value ranging from
2676
+ * [0,1]. Only applicable when denoising_mode is
2677
+ * noise-and-background-speech-cancellation. Defaults to 0.8 if no value is
2678
+ * configured. Set to null to clear the configured value. Omitting this field
2679
+ * preserves the existing value.
2680
+ */
2681
+ denoising_enhancement_level?: number | null;
2682
+
2661
2683
  /**
2662
2684
  * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
2663
2685
  * audio denoising. Default to noise-cancellation.
@@ -3088,6 +3110,8 @@ export interface AgentCreateParams {
3088
3110
  | 'eleven_flash_v2_5'
3089
3111
  | 'eleven_multilingual_v2'
3090
3112
  | 'eleven_v3'
3113
+ | 'eleven_v3_conversational'
3114
+ | 'eleven_v4'
3091
3115
  | 'eleven_v4_turbo'
3092
3116
  | 'sonic-3'
3093
3117
  | 'sonic-3-latest'
@@ -4837,6 +4861,16 @@ export interface AgentUpdateParams {
4837
4861
  */
4838
4862
  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
4839
4863
 
4864
+ /**
4865
+ * Body param: Controls the enhancement level for background voice cancellation.
4866
+ * Set to 0 to bypass background voice cancellation without BVC charges. Value
4867
+ * ranging from [0,1]. Only applicable when denoising_mode is
4868
+ * noise-and-background-speech-cancellation. Defaults to 0.8 if no value is
4869
+ * configured. Set to null to clear the configured value. Omitting this field
4870
+ * preserves the existing value.
4871
+ */
4872
+ denoising_enhancement_level?: number | null;
4873
+
4840
4874
  /**
4841
4875
  * Body param: If set, determines what denoising mode to use. Use "no-denoise" to
4842
4876
  * bypass all audio denoising. Default to noise-cancellation.
@@ -5292,6 +5326,8 @@ export interface AgentUpdateParams {
5292
5326
  | 'eleven_flash_v2_5'
5293
5327
  | 'eleven_multilingual_v2'
5294
5328
  | 'eleven_v3'
5329
+ | 'eleven_v3_conversational'
5330
+ | 'eleven_v4'
5295
5331
  | 'eleven_v4_turbo'
5296
5332
  | 'sonic-3'
5297
5333
  | 'sonic-3-latest'
@@ -354,6 +354,16 @@ export namespace BatchCallCreateBatchCallParams {
354
354
  */
355
355
  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
356
356
 
357
+ /**
358
+ * Controls the enhancement level for background voice cancellation. Set to 0 to
359
+ * bypass background voice cancellation without BVC charges. Value ranging from
360
+ * [0,1]. Only applicable when denoising_mode is
361
+ * noise-and-background-speech-cancellation. Defaults to 0.8 if no value is
362
+ * configured. Set to null to clear the configured value. Omitting this field
363
+ * preserves the existing value.
364
+ */
365
+ denoising_enhancement_level?: number | null;
366
+
357
367
  /**
358
368
  * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
359
369
  * audio denoising. Default to noise-cancellation.
@@ -795,6 +805,8 @@ export namespace BatchCallCreateBatchCallParams {
795
805
  | 'eleven_flash_v2_5'
796
806
  | 'eleven_multilingual_v2'
797
807
  | 'eleven_v3'
808
+ | 'eleven_v3_conversational'
809
+ | 'eleven_v4'
798
810
  | 'eleven_v4_turbo'
799
811
  | 'sonic-3'
800
812
  | 'sonic-3-latest'
@@ -2429,7 +2441,7 @@ export namespace BatchCallCreateBatchCallParams {
2429
2441
  /**
2430
2442
  * The model choice for the conversation flow.
2431
2443
  */
2432
- model_choice?: ConversationFlow.ModelChoice;
2444
+ model_choice?: ConversationFlow.ModelChoiceCascading | ConversationFlow.ModelChoiceS2S;
2433
2445
 
2434
2446
  /**
2435
2447
  * Controls the randomness of the model's responses. Lower values make responses
@@ -2465,10 +2477,7 @@ export namespace BatchCallCreateBatchCallParams {
2465
2477
  top_k?: number;
2466
2478
  }
2467
2479
 
2468
- /**
2469
- * The model choice for the conversation flow.
2470
- */
2471
- export interface ModelChoice {
2480
+ export interface ModelChoiceCascading {
2472
2481
  /**
2473
2482
  * The LLM model to use
2474
2483
  */
@@ -2516,6 +2525,24 @@ export namespace BatchCallCreateBatchCallParams {
2516
2525
  */
2517
2526
  high_priority?: boolean;
2518
2527
  }
2528
+
2529
+ export interface ModelChoiceS2S {
2530
+ /**
2531
+ * The speech-to-speech model to use
2532
+ */
2533
+ model:
2534
+ | 'gpt-realtime-2.1'
2535
+ | 'gpt-realtime-2.1-mini'
2536
+ | 'gpt-realtime-2'
2537
+ | 'gpt-realtime-1.5'
2538
+ | 'gpt-realtime'
2539
+ | 'gpt-realtime-mini';
2540
+
2541
+ /**
2542
+ * Type of model choice
2543
+ */
2544
+ type: 's2s';
2545
+ }
2519
2546
  }
2520
2547
 
2521
2548
  /**
@@ -7140,6 +7140,16 @@ export namespace CallCreatePhoneCallParams {
7140
7140
  */
7141
7141
  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
7142
7142
 
7143
+ /**
7144
+ * Controls the enhancement level for background voice cancellation. Set to 0 to
7145
+ * bypass background voice cancellation without BVC charges. Value ranging from
7146
+ * [0,1]. Only applicable when denoising_mode is
7147
+ * noise-and-background-speech-cancellation. Defaults to 0.8 if no value is
7148
+ * configured. Set to null to clear the configured value. Omitting this field
7149
+ * preserves the existing value.
7150
+ */
7151
+ denoising_enhancement_level?: number | null;
7152
+
7143
7153
  /**
7144
7154
  * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
7145
7155
  * audio denoising. Default to noise-cancellation.
@@ -7581,6 +7591,8 @@ export namespace CallCreatePhoneCallParams {
7581
7591
  | 'eleven_flash_v2_5'
7582
7592
  | 'eleven_multilingual_v2'
7583
7593
  | 'eleven_v3'
7594
+ | 'eleven_v3_conversational'
7595
+ | 'eleven_v4'
7584
7596
  | 'eleven_v4_turbo'
7585
7597
  | 'sonic-3'
7586
7598
  | 'sonic-3-latest'
@@ -9215,7 +9227,7 @@ export namespace CallCreatePhoneCallParams {
9215
9227
  /**
9216
9228
  * The model choice for the conversation flow.
9217
9229
  */
9218
- model_choice?: ConversationFlow.ModelChoice;
9230
+ model_choice?: ConversationFlow.ModelChoiceCascading | ConversationFlow.ModelChoiceS2S;
9219
9231
 
9220
9232
  /**
9221
9233
  * Controls the randomness of the model's responses. Lower values make responses
@@ -9251,10 +9263,7 @@ export namespace CallCreatePhoneCallParams {
9251
9263
  top_k?: number;
9252
9264
  }
9253
9265
 
9254
- /**
9255
- * The model choice for the conversation flow.
9256
- */
9257
- export interface ModelChoice {
9266
+ export interface ModelChoiceCascading {
9258
9267
  /**
9259
9268
  * The LLM model to use
9260
9269
  */
@@ -9302,6 +9311,24 @@ export namespace CallCreatePhoneCallParams {
9302
9311
  */
9303
9312
  high_priority?: boolean;
9304
9313
  }
9314
+
9315
+ export interface ModelChoiceS2S {
9316
+ /**
9317
+ * The speech-to-speech model to use
9318
+ */
9319
+ model:
9320
+ | 'gpt-realtime-2.1'
9321
+ | 'gpt-realtime-2.1-mini'
9322
+ | 'gpt-realtime-2'
9323
+ | 'gpt-realtime-1.5'
9324
+ | 'gpt-realtime'
9325
+ | 'gpt-realtime-mini';
9326
+
9327
+ /**
9328
+ * Type of model choice
9329
+ */
9330
+ type: 's2s';
9331
+ }
9305
9332
  }
9306
9333
 
9307
9334
  /**
@@ -9646,6 +9673,16 @@ export namespace CallCreateWebCallParams {
9646
9673
  */
9647
9674
  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
9648
9675
 
9676
+ /**
9677
+ * Controls the enhancement level for background voice cancellation. Set to 0 to
9678
+ * bypass background voice cancellation without BVC charges. Value ranging from
9679
+ * [0,1]. Only applicable when denoising_mode is
9680
+ * noise-and-background-speech-cancellation. Defaults to 0.8 if no value is
9681
+ * configured. Set to null to clear the configured value. Omitting this field
9682
+ * preserves the existing value.
9683
+ */
9684
+ denoising_enhancement_level?: number | null;
9685
+
9649
9686
  /**
9650
9687
  * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
9651
9688
  * audio denoising. Default to noise-cancellation.
@@ -10087,6 +10124,8 @@ export namespace CallCreateWebCallParams {
10087
10124
  | 'eleven_flash_v2_5'
10088
10125
  | 'eleven_multilingual_v2'
10089
10126
  | 'eleven_v3'
10127
+ | 'eleven_v3_conversational'
10128
+ | 'eleven_v4'
10090
10129
  | 'eleven_v4_turbo'
10091
10130
  | 'sonic-3'
10092
10131
  | 'sonic-3-latest'
@@ -11721,7 +11760,7 @@ export namespace CallCreateWebCallParams {
11721
11760
  /**
11722
11761
  * The model choice for the conversation flow.
11723
11762
  */
11724
- model_choice?: ConversationFlow.ModelChoice;
11763
+ model_choice?: ConversationFlow.ModelChoiceCascading | ConversationFlow.ModelChoiceS2S;
11725
11764
 
11726
11765
  /**
11727
11766
  * Controls the randomness of the model's responses. Lower values make responses
@@ -11757,10 +11796,7 @@ export namespace CallCreateWebCallParams {
11757
11796
  top_k?: number;
11758
11797
  }
11759
11798
 
11760
- /**
11761
- * The model choice for the conversation flow.
11762
- */
11763
- export interface ModelChoice {
11799
+ export interface ModelChoiceCascading {
11764
11800
  /**
11765
11801
  * The LLM model to use
11766
11802
  */
@@ -11808,6 +11844,24 @@ export namespace CallCreateWebCallParams {
11808
11844
  */
11809
11845
  high_priority?: boolean;
11810
11846
  }
11847
+
11848
+ export interface ModelChoiceS2S {
11849
+ /**
11850
+ * The speech-to-speech model to use
11851
+ */
11852
+ model:
11853
+ | 'gpt-realtime-2.1'
11854
+ | 'gpt-realtime-2.1-mini'
11855
+ | 'gpt-realtime-2'
11856
+ | 'gpt-realtime-1.5'
11857
+ | 'gpt-realtime'
11858
+ | 'gpt-realtime-mini';
11859
+
11860
+ /**
11861
+ * Type of model choice
11862
+ */
11863
+ type: 's2s';
11864
+ }
11811
11865
  }
11812
11866
 
11813
11867
  /**
@@ -12152,6 +12206,16 @@ export namespace CallRegisterPhoneCallParams {
12152
12206
  */
12153
12207
  data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
12154
12208
 
12209
+ /**
12210
+ * Controls the enhancement level for background voice cancellation. Set to 0 to
12211
+ * bypass background voice cancellation without BVC charges. Value ranging from
12212
+ * [0,1]. Only applicable when denoising_mode is
12213
+ * noise-and-background-speech-cancellation. Defaults to 0.8 if no value is
12214
+ * configured. Set to null to clear the configured value. Omitting this field
12215
+ * preserves the existing value.
12216
+ */
12217
+ denoising_enhancement_level?: number | null;
12218
+
12155
12219
  /**
12156
12220
  * If set, determines what denoising mode to use. Use "no-denoise" to bypass all
12157
12221
  * audio denoising. Default to noise-cancellation.
@@ -12593,6 +12657,8 @@ export namespace CallRegisterPhoneCallParams {
12593
12657
  | 'eleven_flash_v2_5'
12594
12658
  | 'eleven_multilingual_v2'
12595
12659
  | 'eleven_v3'
12660
+ | 'eleven_v3_conversational'
12661
+ | 'eleven_v4'
12596
12662
  | 'eleven_v4_turbo'
12597
12663
  | 'sonic-3'
12598
12664
  | 'sonic-3-latest'
@@ -14227,7 +14293,7 @@ export namespace CallRegisterPhoneCallParams {
14227
14293
  /**
14228
14294
  * The model choice for the conversation flow.
14229
14295
  */
14230
- model_choice?: ConversationFlow.ModelChoice;
14296
+ model_choice?: ConversationFlow.ModelChoiceCascading | ConversationFlow.ModelChoiceS2S;
14231
14297
 
14232
14298
  /**
14233
14299
  * Controls the randomness of the model's responses. Lower values make responses
@@ -14263,10 +14329,7 @@ export namespace CallRegisterPhoneCallParams {
14263
14329
  top_k?: number;
14264
14330
  }
14265
14331
 
14266
- /**
14267
- * The model choice for the conversation flow.
14268
- */
14269
- export interface ModelChoice {
14332
+ export interface ModelChoiceCascading {
14270
14333
  /**
14271
14334
  * The LLM model to use
14272
14335
  */
@@ -14314,6 +14377,24 @@ export namespace CallRegisterPhoneCallParams {
14314
14377
  */
14315
14378
  high_priority?: boolean;
14316
14379
  }
14380
+
14381
+ export interface ModelChoiceS2S {
14382
+ /**
14383
+ * The speech-to-speech model to use
14384
+ */
14385
+ model:
14386
+ | 'gpt-realtime-2.1'
14387
+ | 'gpt-realtime-2.1-mini'
14388
+ | 'gpt-realtime-2'
14389
+ | 'gpt-realtime-1.5'
14390
+ | 'gpt-realtime'
14391
+ | 'gpt-realtime-mini';
14392
+
14393
+ /**
14394
+ * Type of model choice
14395
+ */
14396
+ type: 's2s';
14397
+ }
14317
14398
  }
14318
14399
 
14319
14400
  /**