retell-sdk 5.3.1 → 5.5.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.
@@ -17,7 +17,7 @@ export class Agent extends APIResource {
17
17
  * llm_id: 'llm_234sdertfsdsfsdf',
18
18
  * type: 'retell-llm',
19
19
  * },
20
- * voice_id: '11labs-Adrian',
20
+ * voice_id: 'retell-Cimo',
21
21
  * });
22
22
  * ```
23
23
  */
@@ -295,6 +295,13 @@ export interface AgentResponse {
295
295
  */
296
296
  enable_backchannel?: boolean;
297
297
 
298
+ /**
299
+ * If set to true, the agent will dynamically adjust how quickly it responds based
300
+ * on the user's speech rate and past turn-taking behavior in the call. If unset,
301
+ * default value false will apply.
302
+ */
303
+ enable_dynamic_responsiveness?: boolean;
304
+
298
305
  /**
299
306
  * If set to true, will enable dynamic voice speed adjustment based on the user's
300
307
  * speech rate and conversation context. If unset, default value false will apply.
@@ -490,8 +497,9 @@ export interface AgentResponse {
490
497
 
491
498
  /**
492
499
  * A list of words / phrases and their pronunciation to be used to guide the audio
493
- * synthesize for consistent pronunciation. Currently only supported for English &
494
- * 11labs voices. Set to null to remove pronunciation dictionary from this agent.
500
+ * synthesize for consistent pronunciation. Check the dashboard to see what
501
+ * provider supports this feature. Set to null to remove pronunciation dictionary
502
+ * from this agent.
495
503
  */
496
504
  pronunciation_dictionary?: Array<AgentResponse.PronunciationDictionary> | null;
497
505
 
@@ -589,9 +597,9 @@ export interface AgentResponse {
589
597
 
590
598
  /**
591
599
  * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
592
- * more stable, and higher value means more variant speech generation. Currently
593
- * this setting only applies to `11labs` voices. If unset, default value 1 will
594
- * apply.
600
+ * more stable, and higher value means more variant speech generation. Check the
601
+ * dashboard to see what provider supports this feature. If unset, default value 1
602
+ * will apply.
595
603
  */
596
604
  voice_temperature?: number;
597
605
 
@@ -1110,6 +1118,13 @@ export interface AgentCreateParams {
1110
1118
  */
1111
1119
  enable_backchannel?: boolean;
1112
1120
 
1121
+ /**
1122
+ * If set to true, the agent will dynamically adjust how quickly it responds based
1123
+ * on the user's speech rate and past turn-taking behavior in the call. If unset,
1124
+ * default value false will apply.
1125
+ */
1126
+ enable_dynamic_responsiveness?: boolean;
1127
+
1113
1128
  /**
1114
1129
  * If set to true, will enable dynamic voice speed adjustment based on the user's
1115
1130
  * speech rate and conversation context. If unset, default value false will apply.
@@ -1300,8 +1315,9 @@ export interface AgentCreateParams {
1300
1315
 
1301
1316
  /**
1302
1317
  * A list of words / phrases and their pronunciation to be used to guide the audio
1303
- * synthesize for consistent pronunciation. Currently only supported for English &
1304
- * 11labs voices. Set to null to remove pronunciation dictionary from this agent.
1318
+ * synthesize for consistent pronunciation. Check the dashboard to see what
1319
+ * provider supports this feature. Set to null to remove pronunciation dictionary
1320
+ * from this agent.
1305
1321
  */
1306
1322
  pronunciation_dictionary?: Array<AgentCreateParams.PronunciationDictionary> | null;
1307
1323
 
@@ -1399,9 +1415,9 @@ export interface AgentCreateParams {
1399
1415
 
1400
1416
  /**
1401
1417
  * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
1402
- * more stable, and higher value means more variant speech generation. Currently
1403
- * this setting only applies to `11labs` voices. If unset, default value 1 will
1404
- * apply.
1418
+ * more stable, and higher value means more variant speech generation. Check the
1419
+ * dashboard to see what provider supports this feature. If unset, default value 1
1420
+ * will apply.
1405
1421
  */
1406
1422
  voice_temperature?: number;
1407
1423
 
@@ -1914,6 +1930,13 @@ export interface AgentUpdateParams {
1914
1930
  */
1915
1931
  enable_backchannel?: boolean;
1916
1932
 
1933
+ /**
1934
+ * Body param: If set to true, the agent will dynamically adjust how quickly it
1935
+ * responds based on the user's speech rate and past turn-taking behavior in the
1936
+ * call. If unset, default value false will apply.
1937
+ */
1938
+ enable_dynamic_responsiveness?: boolean;
1939
+
1917
1940
  /**
1918
1941
  * Body param: If set to true, will enable dynamic voice speed adjustment based on
1919
1942
  * the user's speech rate and conversation context. If unset, default value false
@@ -2106,8 +2129,8 @@ export interface AgentUpdateParams {
2106
2129
 
2107
2130
  /**
2108
2131
  * Body param: A list of words / phrases and their pronunciation to be used to
2109
- * guide the audio synthesize for consistent pronunciation. Currently only
2110
- * supported for English & 11labs voices. Set to null to remove pronunciation
2132
+ * guide the audio synthesize for consistent pronunciation. Check the dashboard to
2133
+ * see what provider supports this feature. Set to null to remove pronunciation
2111
2134
  * dictionary from this agent.
2112
2135
  */
2113
2136
  pronunciation_dictionary?: Array<AgentUpdateParams.PronunciationDictionary> | null;
@@ -2230,8 +2253,8 @@ export interface AgentUpdateParams {
2230
2253
  /**
2231
2254
  * Body param: Controls how stable the voice is. Value ranging from [0,2]. Lower
2232
2255
  * value means more stable, and higher value means more variant speech generation.
2233
- * Currently this setting only applies to `11labs` voices. If unset, default value
2234
- * 1 will apply.
2256
+ * Check the dashboard to see what provider supports this feature. If unset,
2257
+ * default value 1 will apply.
2235
2258
  */
2236
2259
  voice_temperature?: number;
2237
2260
 
@@ -150,6 +150,11 @@ export namespace BatchCallCreateBatchCallParams {
150
150
  */
151
151
  agent_override?: Task.AgentOverride;
152
152
 
153
+ /**
154
+ * Add optional custom SIP headers to the call.
155
+ */
156
+ custom_sip_headers?: { [key: string]: string };
157
+
153
158
  /**
154
159
  * If true, the e.164 validation will be ignored for the from_number. This can be
155
160
  * useful when you want to dial to internal pseudo numbers. This only applies when
@@ -360,6 +365,13 @@ export namespace BatchCallCreateBatchCallParams {
360
365
  */
361
366
  enable_backchannel?: boolean;
362
367
 
368
+ /**
369
+ * If set to true, the agent will dynamically adjust how quickly it responds based
370
+ * on the user's speech rate and past turn-taking behavior in the call. If unset,
371
+ * default value false will apply.
372
+ */
373
+ enable_dynamic_responsiveness?: boolean;
374
+
363
375
  /**
364
376
  * If set to true, will enable dynamic voice speed adjustment based on the user's
365
377
  * speech rate and conversation context. If unset, default value false will apply.
@@ -550,8 +562,9 @@ export namespace BatchCallCreateBatchCallParams {
550
562
 
551
563
  /**
552
564
  * A list of words / phrases and their pronunciation to be used to guide the audio
553
- * synthesize for consistent pronunciation. Currently only supported for English &
554
- * 11labs voices. Set to null to remove pronunciation dictionary from this agent.
565
+ * synthesize for consistent pronunciation. Check the dashboard to see what
566
+ * provider supports this feature. Set to null to remove pronunciation dictionary
567
+ * from this agent.
555
568
  */
556
569
  pronunciation_dictionary?: Array<Agent.PronunciationDictionary> | null;
557
570
 
@@ -665,9 +678,9 @@ export namespace BatchCallCreateBatchCallParams {
665
678
 
666
679
  /**
667
680
  * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
668
- * more stable, and higher value means more variant speech generation. Currently
669
- * this setting only applies to `11labs` voices. If unset, default value 1 will
670
- * apply.
681
+ * more stable, and higher value means more variant speech generation. Check the
682
+ * dashboard to see what provider supports this feature. If unset, default value 1
683
+ * will apply.
671
684
  */
672
685
  voice_temperature?: number;
673
686
 
@@ -223,6 +223,7 @@ export interface PhoneCallResponse {
223
223
  | 'agent_hangup'
224
224
  | 'call_transfer'
225
225
  | 'voicemail_reached'
226
+ | 'ivr_reached'
226
227
  | 'inactivity'
227
228
  | 'max_duration_reached'
228
229
  | 'concurrency_limit_reached'
@@ -246,7 +247,9 @@ export interface PhoneCallResponse {
246
247
  | 'error_retell'
247
248
  | 'error_unknown'
248
249
  | 'error_user_not_joined'
249
- | 'registered_call_timeout';
250
+ | 'registered_call_timeout'
251
+ | 'transfer_bridged'
252
+ | 'transfer_cancelled';
250
253
 
251
254
  /**
252
255
  * Duration of the call in milliseconds. Available after call ends.
@@ -1276,6 +1279,7 @@ export interface WebCallResponse {
1276
1279
  | 'agent_hangup'
1277
1280
  | 'call_transfer'
1278
1281
  | 'voicemail_reached'
1282
+ | 'ivr_reached'
1279
1283
  | 'inactivity'
1280
1284
  | 'max_duration_reached'
1281
1285
  | 'concurrency_limit_reached'
@@ -1299,7 +1303,9 @@ export interface WebCallResponse {
1299
1303
  | 'error_retell'
1300
1304
  | 'error_unknown'
1301
1305
  | 'error_user_not_joined'
1302
- | 'registered_call_timeout';
1306
+ | 'registered_call_timeout'
1307
+ | 'transfer_bridged'
1308
+ | 'transfer_cancelled';
1303
1309
 
1304
1310
  /**
1305
1311
  * Duration of the call in milliseconds. Available after call ends.
@@ -2307,7 +2313,7 @@ export namespace CallListParams {
2307
2313
  /**
2308
2314
  * Only retrieve calls with specific call status(es).
2309
2315
  */
2310
- call_status?: Array<'registered' | 'not_connected' | 'ongoing' | 'ended' | 'error'>;
2316
+ call_status?: Array<'not_connected' | 'ongoing' | 'ended' | 'error'>;
2311
2317
 
2312
2318
  /**
2313
2319
  * Only retrieve calls with specific call successful(s).
@@ -2332,6 +2338,7 @@ export namespace CallListParams {
2332
2338
  | 'agent_hangup'
2333
2339
  | 'call_transfer'
2334
2340
  | 'voicemail_reached'
2341
+ | 'ivr_reached'
2335
2342
  | 'inactivity'
2336
2343
  | 'max_duration_reached'
2337
2344
  | 'concurrency_limit_reached'
@@ -2356,6 +2363,8 @@ export namespace CallListParams {
2356
2363
  | 'error_unknown'
2357
2364
  | 'error_user_not_joined'
2358
2365
  | 'registered_call_timeout'
2366
+ | 'transfer_bridged'
2367
+ | 'transfer_cancelled'
2359
2368
  >;
2360
2369
 
2361
2370
  /**
@@ -2685,6 +2694,13 @@ export namespace CallCreatePhoneCallParams {
2685
2694
  */
2686
2695
  enable_backchannel?: boolean;
2687
2696
 
2697
+ /**
2698
+ * If set to true, the agent will dynamically adjust how quickly it responds based
2699
+ * on the user's speech rate and past turn-taking behavior in the call. If unset,
2700
+ * default value false will apply.
2701
+ */
2702
+ enable_dynamic_responsiveness?: boolean;
2703
+
2688
2704
  /**
2689
2705
  * If set to true, will enable dynamic voice speed adjustment based on the user's
2690
2706
  * speech rate and conversation context. If unset, default value false will apply.
@@ -2875,8 +2891,9 @@ export namespace CallCreatePhoneCallParams {
2875
2891
 
2876
2892
  /**
2877
2893
  * A list of words / phrases and their pronunciation to be used to guide the audio
2878
- * synthesize for consistent pronunciation. Currently only supported for English &
2879
- * 11labs voices. Set to null to remove pronunciation dictionary from this agent.
2894
+ * synthesize for consistent pronunciation. Check the dashboard to see what
2895
+ * provider supports this feature. Set to null to remove pronunciation dictionary
2896
+ * from this agent.
2880
2897
  */
2881
2898
  pronunciation_dictionary?: Array<Agent.PronunciationDictionary> | null;
2882
2899
 
@@ -2990,9 +3007,9 @@ export namespace CallCreatePhoneCallParams {
2990
3007
 
2991
3008
  /**
2992
3009
  * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
2993
- * more stable, and higher value means more variant speech generation. Currently
2994
- * this setting only applies to `11labs` voices. If unset, default value 1 will
2995
- * apply.
3010
+ * more stable, and higher value means more variant speech generation. Check the
3011
+ * dashboard to see what provider supports this feature. If unset, default value 1
3012
+ * will apply.
2996
3013
  */
2997
3014
  voice_temperature?: number;
2998
3015
 
@@ -3763,6 +3780,13 @@ export namespace CallCreateWebCallParams {
3763
3780
  */
3764
3781
  enable_backchannel?: boolean;
3765
3782
 
3783
+ /**
3784
+ * If set to true, the agent will dynamically adjust how quickly it responds based
3785
+ * on the user's speech rate and past turn-taking behavior in the call. If unset,
3786
+ * default value false will apply.
3787
+ */
3788
+ enable_dynamic_responsiveness?: boolean;
3789
+
3766
3790
  /**
3767
3791
  * If set to true, will enable dynamic voice speed adjustment based on the user's
3768
3792
  * speech rate and conversation context. If unset, default value false will apply.
@@ -3953,8 +3977,9 @@ export namespace CallCreateWebCallParams {
3953
3977
 
3954
3978
  /**
3955
3979
  * A list of words / phrases and their pronunciation to be used to guide the audio
3956
- * synthesize for consistent pronunciation. Currently only supported for English &
3957
- * 11labs voices. Set to null to remove pronunciation dictionary from this agent.
3980
+ * synthesize for consistent pronunciation. Check the dashboard to see what
3981
+ * provider supports this feature. Set to null to remove pronunciation dictionary
3982
+ * from this agent.
3958
3983
  */
3959
3984
  pronunciation_dictionary?: Array<Agent.PronunciationDictionary> | null;
3960
3985
 
@@ -4068,9 +4093,9 @@ export namespace CallCreateWebCallParams {
4068
4093
 
4069
4094
  /**
4070
4095
  * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
4071
- * more stable, and higher value means more variant speech generation. Currently
4072
- * this setting only applies to `11labs` voices. If unset, default value 1 will
4073
- * apply.
4096
+ * more stable, and higher value means more variant speech generation. Check the
4097
+ * dashboard to see what provider supports this feature. If unset, default value 1
4098
+ * will apply.
4074
4099
  */
4075
4100
  voice_temperature?: number;
4076
4101
 
@@ -4855,6 +4880,13 @@ export namespace CallRegisterPhoneCallParams {
4855
4880
  */
4856
4881
  enable_backchannel?: boolean;
4857
4882
 
4883
+ /**
4884
+ * If set to true, the agent will dynamically adjust how quickly it responds based
4885
+ * on the user's speech rate and past turn-taking behavior in the call. If unset,
4886
+ * default value false will apply.
4887
+ */
4888
+ enable_dynamic_responsiveness?: boolean;
4889
+
4858
4890
  /**
4859
4891
  * If set to true, will enable dynamic voice speed adjustment based on the user's
4860
4892
  * speech rate and conversation context. If unset, default value false will apply.
@@ -5045,8 +5077,9 @@ export namespace CallRegisterPhoneCallParams {
5045
5077
 
5046
5078
  /**
5047
5079
  * A list of words / phrases and their pronunciation to be used to guide the audio
5048
- * synthesize for consistent pronunciation. Currently only supported for English &
5049
- * 11labs voices. Set to null to remove pronunciation dictionary from this agent.
5080
+ * synthesize for consistent pronunciation. Check the dashboard to see what
5081
+ * provider supports this feature. Set to null to remove pronunciation dictionary
5082
+ * from this agent.
5050
5083
  */
5051
5084
  pronunciation_dictionary?: Array<Agent.PronunciationDictionary> | null;
5052
5085
 
@@ -5160,9 +5193,9 @@ export namespace CallRegisterPhoneCallParams {
5160
5193
 
5161
5194
  /**
5162
5195
  * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
5163
- * more stable, and higher value means more variant speech generation. Currently
5164
- * this setting only applies to `11labs` voices. If unset, default value 1 will
5165
- * apply.
5196
+ * more stable, and higher value means more variant speech generation. Check the
5197
+ * dashboard to see what provider supports this feature. If unset, default value 1
5198
+ * will apply.
5166
5199
  */
5167
5200
  voice_temperature?: number;
5168
5201
 
@@ -153,6 +153,17 @@ export interface KnowledgeBaseResponse {
153
153
  * enable_auto_refresh is true.
154
154
  */
155
155
  last_refreshed_timestamp?: number;
156
+
157
+ /**
158
+ * Maximum number of characters per chunk when splitting knowledge base content.
159
+ */
160
+ max_chunk_size?: number;
161
+
162
+ /**
163
+ * Minimum number of characters per chunk. Chunks smaller than this are merged with
164
+ * adjacent chunks.
165
+ */
166
+ min_chunk_size?: number;
156
167
  }
157
168
 
158
169
  export namespace KnowledgeBaseResponse {
@@ -247,6 +258,19 @@ export interface KnowledgeBaseCreateParams {
247
258
  * URLs to be scraped and added to the knowledge base. Must be valid urls.
248
259
  */
249
260
  knowledge_base_urls?: Array<string>;
261
+
262
+ /**
263
+ * Maximum number of characters per chunk when splitting knowledge base. Default
264
+ * is 2000. content. Immutable after creation.
265
+ */
266
+ max_chunk_size?: number;
267
+
268
+ /**
269
+ * Minimum number of characters per chunk. Chunks smaller than this will be merged
270
+ * with adjacent chunks. Must be less than max_chunk_size. Immutable after
271
+ * creation. Default is 400.
272
+ */
273
+ min_chunk_size?: number;
250
274
  }
251
275
 
252
276
  export namespace KnowledgeBaseCreateParams {
@@ -53,7 +53,7 @@ export interface VoiceResponse {
53
53
  /**
54
54
  * Indicates the provider of voice.
55
55
  */
56
- provider: 'elevenlabs' | 'openai' | 'deepgram' | 'cartesia' | 'minimax' | 'fish_audio';
56
+ provider: 'elevenlabs' | 'openai' | 'deepgram' | 'cartesia' | 'minimax' | 'fish_audio' | 'platform';
57
57
 
58
58
  /**
59
59
  * Unique id for the voice.
@@ -151,7 +151,7 @@ export interface VoiceCloneParams {
151
151
  /**
152
152
  * Voice provider to use for cloning.
153
153
  */
154
- voice_provider: 'elevenlabs' | 'cartesia' | 'minimax' | 'fish_audio';
154
+ voice_provider: 'elevenlabs' | 'cartesia' | 'minimax' | 'fish_audio' | 'platform';
155
155
  }
156
156
 
157
157
  export interface VoiceSearchParams {
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '5.3.1'; // x-release-please-version
1
+ export const VERSION = '5.5.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "5.3.1";
1
+ export declare const VERSION = "5.5.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "5.3.1";
1
+ export declare const VERSION = "5.5.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '5.3.1'; // x-release-please-version
4
+ exports.VERSION = '5.5.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '5.3.1'; // x-release-please-version
1
+ export const VERSION = '5.5.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map