retell-sdk 4.8.0 → 4.10.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.
Files changed (85) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/README.md +26 -8
  3. package/core.d.ts +3 -3
  4. package/core.d.ts.map +1 -1
  5. package/core.js.map +1 -1
  6. package/core.mjs.map +1 -1
  7. package/error.d.ts.map +1 -1
  8. package/index.d.mts +19 -40
  9. package/index.d.ts +19 -40
  10. package/index.d.ts.map +1 -1
  11. package/index.js +33 -14
  12. package/index.js.map +1 -1
  13. package/index.mjs +17 -13
  14. package/index.mjs.map +1 -1
  15. package/package.json +1 -1
  16. package/resources/agent.d.ts +69 -19
  17. package/resources/agent.d.ts.map +1 -1
  18. package/resources/agent.js +0 -2
  19. package/resources/agent.js.map +1 -1
  20. package/resources/agent.mjs +0 -2
  21. package/resources/agent.mjs.map +1 -1
  22. package/resources/call.d.ts +503 -199
  23. package/resources/call.d.ts.map +1 -1
  24. package/resources/call.js +0 -2
  25. package/resources/call.js.map +1 -1
  26. package/resources/call.mjs +0 -2
  27. package/resources/call.mjs.map +1 -1
  28. package/resources/concurrency.d.ts +22 -5
  29. package/resources/concurrency.d.ts.map +1 -1
  30. package/resources/concurrency.js +1 -3
  31. package/resources/concurrency.js.map +1 -1
  32. package/resources/concurrency.mjs +1 -3
  33. package/resources/concurrency.mjs.map +1 -1
  34. package/resources/index.d.ts +7 -7
  35. package/resources/index.d.ts.map +1 -1
  36. package/resources/index.js.map +1 -1
  37. package/resources/index.mjs +2 -2
  38. package/resources/index.mjs.map +1 -1
  39. package/resources/knowledge-base.d.ts +1 -4
  40. package/resources/knowledge-base.d.ts.map +1 -1
  41. package/resources/knowledge-base.js +0 -2
  42. package/resources/knowledge-base.js.map +1 -1
  43. package/resources/knowledge-base.mjs +0 -2
  44. package/resources/knowledge-base.mjs.map +1 -1
  45. package/resources/llm.d.ts +37 -10
  46. package/resources/llm.d.ts.map +1 -1
  47. package/resources/llm.js +0 -2
  48. package/resources/llm.js.map +1 -1
  49. package/resources/llm.mjs +0 -2
  50. package/resources/llm.mjs.map +1 -1
  51. package/resources/phone-number.d.ts +1 -6
  52. package/resources/phone-number.d.ts.map +1 -1
  53. package/resources/phone-number.js +0 -2
  54. package/resources/phone-number.js.map +1 -1
  55. package/resources/phone-number.mjs +0 -2
  56. package/resources/phone-number.mjs.map +1 -1
  57. package/resources/voice.d.ts +1 -3
  58. package/resources/voice.d.ts.map +1 -1
  59. package/resources/voice.js +0 -2
  60. package/resources/voice.js.map +1 -1
  61. package/resources/voice.mjs +0 -2
  62. package/resources/voice.mjs.map +1 -1
  63. package/src/core.ts +5 -5
  64. package/src/error.ts +1 -1
  65. package/src/index.ts +99 -52
  66. package/src/resources/agent.ts +88 -21
  67. package/src/resources/call.ts +581 -206
  68. package/src/resources/concurrency.ts +27 -6
  69. package/src/resources/index.ts +32 -20
  70. package/src/resources/knowledge-base.ts +6 -5
  71. package/src/resources/llm.ts +49 -12
  72. package/src/resources/phone-number.ts +8 -7
  73. package/src/resources/voice.ts +2 -4
  74. package/src/uploads.ts +8 -4
  75. package/src/version.ts +1 -1
  76. package/uploads.js +9 -2
  77. package/uploads.js.map +1 -1
  78. package/uploads.mjs +9 -2
  79. package/uploads.mjs.map +1 -1
  80. package/version.d.ts +1 -1
  81. package/version.d.ts.map +1 -1
  82. package/version.js +1 -1
  83. package/version.js.map +1 -1
  84. package/version.mjs +1 -1
  85. package/version.mjs.map +1 -1
@@ -1,6 +1,5 @@
1
1
  import { APIResource } from "../resource.js";
2
2
  import * as Core from "../core.js";
3
- import * as CallAPI from "./call.js";
4
3
  export declare class Call extends APIResource {
5
4
  /**
6
5
  * Retrieve details of a specific call
@@ -75,29 +74,15 @@ export interface PhoneCallResponse {
75
74
  * [Disconnection Reason Doc](/get-started/debug-guide#disconnection-reason).
76
75
  */
77
76
  disconnection_reason?: 'user_hangup' | 'agent_hangup' | 'call_transfer' | 'voicemail_reached' | 'inactivity' | 'machine_detected' | 'max_duration_reached' | 'concurrency_limit_reached' | 'no_valid_payment' | 'scam_detected' | 'error_inbound_webhook' | 'dial_busy' | 'dial_failed' | 'dial_no_answer' | 'error_llm_websocket_open' | 'error_llm_websocket_lost_connection' | 'error_llm_websocket_runtime' | 'error_llm_websocket_corrupt_payload' | 'error_frontend_corrupted_payload' | 'error_twilio' | 'error_no_audio_received' | 'error_asr' | 'error_retell' | 'error_unknown' | 'error_user_not_joined' | 'registered_call_timeout';
78
- /**
79
- * End to end latency (from user stops talking to agent start talking) tracking of
80
- * the call, available after call ends. This latency does not account for the
81
- * network trip time from Retell server to user frontend. The latency is tracked
82
- * every time turn change between user and agent.
83
- */
84
- e2e_latency?: PhoneCallResponse.E2ELatency;
85
77
  /**
86
78
  * End timestamp (milliseconds since epoch) of the call. Available after call ends.
87
79
  */
88
80
  end_timestamp?: number;
89
81
  /**
90
- * LLM latency (from issue of LLM call to first token received) tracking of the
91
- * call, available after call ends. When using custom LLM. this latency includes
92
- * LLM websocket roundtrip time between user server and Retell server.
82
+ * Latency tracking of the call, available after call ends. Not all fields here
83
+ * will be available, as it depends on the type of call and feature used.
93
84
  */
94
- llm_latency?: PhoneCallResponse.LlmLatency;
95
- /**
96
- * LLM websocket roundtrip latency (between user server and Retell server) tracking
97
- * of the call, available after call ends. Only populated for calls using custom
98
- * LLM.
99
- */
100
- llm_websocket_network_rtt_latency?: PhoneCallResponse.LlmWebsocketNetworkRttLatency;
85
+ latency?: PhoneCallResponse.Latency;
101
86
  /**
102
87
  * An arbitrary object for storage purpose only. You can put anything here like
103
88
  * your internal customer id associated with the call. Not used for processing. You
@@ -176,110 +161,280 @@ export declare namespace PhoneCallResponse {
176
161
  user_sentiment?: 'Negative' | 'Positive' | 'Neutral' | 'Unknown';
177
162
  }
178
163
  /**
179
- * End to end latency (from user stops talking to agent start talking) tracking of
180
- * the call, available after call ends. This latency does not account for the
181
- * network trip time from Retell server to user frontend. The latency is tracked
182
- * every time turn change between user and agent.
164
+ * Latency tracking of the call, available after call ends. Not all fields here
165
+ * will be available, as it depends on the type of call and feature used.
183
166
  */
184
- interface E2ELatency {
167
+ interface Latency {
185
168
  /**
186
- * Maximum latency in the call, measured in milliseconds.
169
+ * End to end latency (from user stops talking to agent start talking) tracking of
170
+ * the call. This latency does not account for the network trip time from Retell
171
+ * server to user frontend. The latency is tracked every time turn change between
172
+ * user and agent.
187
173
  */
188
- max?: number;
174
+ e2e?: Latency.E2E;
189
175
  /**
190
- * Minimum latency in the call, measured in milliseconds.
176
+ * Knowledge base latency (from the triggering of knowledge base retrival to all
177
+ * relevant context received) tracking of the call. Only populated when using
178
+ * knowledge base feature for the agent of the call.
191
179
  */
192
- min?: number;
180
+ knowledge_base?: Latency.KnowledgeBase;
193
181
  /**
194
- * Number of data points (number of times latency is tracked).
182
+ * LLM latency (from issue of LLM call to first speakable chunk received) tracking
183
+ * of the call. When using custom LLM. this latency includes LLM websocket
184
+ * roundtrip time between user server and Retell server.
195
185
  */
196
- num?: number;
186
+ llm?: Latency.Llm;
197
187
  /**
198
- * 50 percentile of latency, measured in milliseconds.
188
+ * LLM websocket roundtrip latency (between user server and Retell server) tracking
189
+ * of the call. Only populated for calls using custom LLM.
199
190
  */
200
- p50?: number;
191
+ llm_websocket_network_rtt?: Latency.LlmWebsocketNetworkRtt;
201
192
  /**
202
- * 90 percentile of latency, measured in milliseconds.
193
+ * Speech-to-speech latency (from requesting responses of a S2S model to first byte
194
+ * received) tracking of the call. Only populated for calls that uses S2S model
195
+ * like Realtime API.
203
196
  */
204
- p90?: number;
197
+ s2s?: Latency.S2s;
205
198
  /**
206
- * 95 percentile of latency, measured in milliseconds.
199
+ * Text-to-speech latency (from the triggering of TTS to first byte received)
200
+ * tracking of the call.
207
201
  */
208
- p95?: number;
209
- /**
210
- * 99 percentile of latency, measured in milliseconds.
211
- */
212
- p99?: number;
202
+ tts?: Latency.Tts;
213
203
  }
214
- /**
215
- * LLM latency (from issue of LLM call to first token received) tracking of the
216
- * call, available after call ends. When using custom LLM. this latency includes
217
- * LLM websocket roundtrip time between user server and Retell server.
218
- */
219
- interface LlmLatency {
204
+ namespace Latency {
220
205
  /**
221
- * Maximum latency in the call, measured in milliseconds.
206
+ * End to end latency (from user stops talking to agent start talking) tracking of
207
+ * the call. This latency does not account for the network trip time from Retell
208
+ * server to user frontend. The latency is tracked every time turn change between
209
+ * user and agent.
222
210
  */
223
- max?: number;
224
- /**
225
- * Minimum latency in the call, measured in milliseconds.
226
- */
227
- min?: number;
228
- /**
229
- * Number of data points (number of times latency is tracked).
230
- */
231
- num?: number;
232
- /**
233
- * 50 percentile of latency, measured in milliseconds.
234
- */
235
- p50?: number;
236
- /**
237
- * 90 percentile of latency, measured in milliseconds.
238
- */
239
- p90?: number;
240
- /**
241
- * 95 percentile of latency, measured in milliseconds.
242
- */
243
- p95?: number;
244
- /**
245
- * 99 percentile of latency, measured in milliseconds.
246
- */
247
- p99?: number;
248
- }
249
- /**
250
- * LLM websocket roundtrip latency (between user server and Retell server) tracking
251
- * of the call, available after call ends. Only populated for calls using custom
252
- * LLM.
253
- */
254
- interface LlmWebsocketNetworkRttLatency {
255
- /**
256
- * Maximum latency in the call, measured in milliseconds.
257
- */
258
- max?: number;
259
- /**
260
- * Minimum latency in the call, measured in milliseconds.
261
- */
262
- min?: number;
211
+ interface E2E {
212
+ /**
213
+ * Maximum latency in the call, measured in milliseconds.
214
+ */
215
+ max?: number;
216
+ /**
217
+ * Minimum latency in the call, measured in milliseconds.
218
+ */
219
+ min?: number;
220
+ /**
221
+ * Number of data points (number of times latency is tracked).
222
+ */
223
+ num?: number;
224
+ /**
225
+ * 50 percentile of latency, measured in milliseconds.
226
+ */
227
+ p50?: number;
228
+ /**
229
+ * 90 percentile of latency, measured in milliseconds.
230
+ */
231
+ p90?: number;
232
+ /**
233
+ * 95 percentile of latency, measured in milliseconds.
234
+ */
235
+ p95?: number;
236
+ /**
237
+ * 99 percentile of latency, measured in milliseconds.
238
+ */
239
+ p99?: number;
240
+ /**
241
+ * All the latency data points in the call, measured in milliseconds.
242
+ */
243
+ values?: Array<number>;
244
+ }
263
245
  /**
264
- * Number of data points (number of times latency is tracked).
246
+ * Knowledge base latency (from the triggering of knowledge base retrival to all
247
+ * relevant context received) tracking of the call. Only populated when using
248
+ * knowledge base feature for the agent of the call.
265
249
  */
266
- num?: number;
250
+ interface KnowledgeBase {
251
+ /**
252
+ * Maximum latency in the call, measured in milliseconds.
253
+ */
254
+ max?: number;
255
+ /**
256
+ * Minimum latency in the call, measured in milliseconds.
257
+ */
258
+ min?: number;
259
+ /**
260
+ * Number of data points (number of times latency is tracked).
261
+ */
262
+ num?: number;
263
+ /**
264
+ * 50 percentile of latency, measured in milliseconds.
265
+ */
266
+ p50?: number;
267
+ /**
268
+ * 90 percentile of latency, measured in milliseconds.
269
+ */
270
+ p90?: number;
271
+ /**
272
+ * 95 percentile of latency, measured in milliseconds.
273
+ */
274
+ p95?: number;
275
+ /**
276
+ * 99 percentile of latency, measured in milliseconds.
277
+ */
278
+ p99?: number;
279
+ /**
280
+ * All the latency data points in the call, measured in milliseconds.
281
+ */
282
+ values?: Array<number>;
283
+ }
267
284
  /**
268
- * 50 percentile of latency, measured in milliseconds.
285
+ * LLM latency (from issue of LLM call to first speakable chunk received) tracking
286
+ * of the call. When using custom LLM. this latency includes LLM websocket
287
+ * roundtrip time between user server and Retell server.
269
288
  */
270
- p50?: number;
289
+ interface Llm {
290
+ /**
291
+ * Maximum latency in the call, measured in milliseconds.
292
+ */
293
+ max?: number;
294
+ /**
295
+ * Minimum latency in the call, measured in milliseconds.
296
+ */
297
+ min?: number;
298
+ /**
299
+ * Number of data points (number of times latency is tracked).
300
+ */
301
+ num?: number;
302
+ /**
303
+ * 50 percentile of latency, measured in milliseconds.
304
+ */
305
+ p50?: number;
306
+ /**
307
+ * 90 percentile of latency, measured in milliseconds.
308
+ */
309
+ p90?: number;
310
+ /**
311
+ * 95 percentile of latency, measured in milliseconds.
312
+ */
313
+ p95?: number;
314
+ /**
315
+ * 99 percentile of latency, measured in milliseconds.
316
+ */
317
+ p99?: number;
318
+ /**
319
+ * All the latency data points in the call, measured in milliseconds.
320
+ */
321
+ values?: Array<number>;
322
+ }
271
323
  /**
272
- * 90 percentile of latency, measured in milliseconds.
324
+ * LLM websocket roundtrip latency (between user server and Retell server) tracking
325
+ * of the call. Only populated for calls using custom LLM.
273
326
  */
274
- p90?: number;
327
+ interface LlmWebsocketNetworkRtt {
328
+ /**
329
+ * Maximum latency in the call, measured in milliseconds.
330
+ */
331
+ max?: number;
332
+ /**
333
+ * Minimum latency in the call, measured in milliseconds.
334
+ */
335
+ min?: number;
336
+ /**
337
+ * Number of data points (number of times latency is tracked).
338
+ */
339
+ num?: number;
340
+ /**
341
+ * 50 percentile of latency, measured in milliseconds.
342
+ */
343
+ p50?: number;
344
+ /**
345
+ * 90 percentile of latency, measured in milliseconds.
346
+ */
347
+ p90?: number;
348
+ /**
349
+ * 95 percentile of latency, measured in milliseconds.
350
+ */
351
+ p95?: number;
352
+ /**
353
+ * 99 percentile of latency, measured in milliseconds.
354
+ */
355
+ p99?: number;
356
+ /**
357
+ * All the latency data points in the call, measured in milliseconds.
358
+ */
359
+ values?: Array<number>;
360
+ }
275
361
  /**
276
- * 95 percentile of latency, measured in milliseconds.
362
+ * Speech-to-speech latency (from requesting responses of a S2S model to first byte
363
+ * received) tracking of the call. Only populated for calls that uses S2S model
364
+ * like Realtime API.
277
365
  */
278
- p95?: number;
366
+ interface S2s {
367
+ /**
368
+ * Maximum latency in the call, measured in milliseconds.
369
+ */
370
+ max?: number;
371
+ /**
372
+ * Minimum latency in the call, measured in milliseconds.
373
+ */
374
+ min?: number;
375
+ /**
376
+ * Number of data points (number of times latency is tracked).
377
+ */
378
+ num?: number;
379
+ /**
380
+ * 50 percentile of latency, measured in milliseconds.
381
+ */
382
+ p50?: number;
383
+ /**
384
+ * 90 percentile of latency, measured in milliseconds.
385
+ */
386
+ p90?: number;
387
+ /**
388
+ * 95 percentile of latency, measured in milliseconds.
389
+ */
390
+ p95?: number;
391
+ /**
392
+ * 99 percentile of latency, measured in milliseconds.
393
+ */
394
+ p99?: number;
395
+ /**
396
+ * All the latency data points in the call, measured in milliseconds.
397
+ */
398
+ values?: Array<number>;
399
+ }
279
400
  /**
280
- * 99 percentile of latency, measured in milliseconds.
401
+ * Text-to-speech latency (from the triggering of TTS to first byte received)
402
+ * tracking of the call.
281
403
  */
282
- p99?: number;
404
+ interface Tts {
405
+ /**
406
+ * Maximum latency in the call, measured in milliseconds.
407
+ */
408
+ max?: number;
409
+ /**
410
+ * Minimum latency in the call, measured in milliseconds.
411
+ */
412
+ min?: number;
413
+ /**
414
+ * Number of data points (number of times latency is tracked).
415
+ */
416
+ num?: number;
417
+ /**
418
+ * 50 percentile of latency, measured in milliseconds.
419
+ */
420
+ p50?: number;
421
+ /**
422
+ * 90 percentile of latency, measured in milliseconds.
423
+ */
424
+ p90?: number;
425
+ /**
426
+ * 95 percentile of latency, measured in milliseconds.
427
+ */
428
+ p95?: number;
429
+ /**
430
+ * 99 percentile of latency, measured in milliseconds.
431
+ */
432
+ p99?: number;
433
+ /**
434
+ * All the latency data points in the call, measured in milliseconds.
435
+ */
436
+ values?: Array<number>;
437
+ }
283
438
  }
284
439
  interface TranscriptObject {
285
440
  /**
@@ -426,29 +581,15 @@ export interface WebCallResponse {
426
581
  * [Disconnection Reason Doc](/get-started/debug-guide#disconnection-reason).
427
582
  */
428
583
  disconnection_reason?: 'user_hangup' | 'agent_hangup' | 'call_transfer' | 'voicemail_reached' | 'inactivity' | 'machine_detected' | 'max_duration_reached' | 'concurrency_limit_reached' | 'no_valid_payment' | 'scam_detected' | 'error_inbound_webhook' | 'dial_busy' | 'dial_failed' | 'dial_no_answer' | 'error_llm_websocket_open' | 'error_llm_websocket_lost_connection' | 'error_llm_websocket_runtime' | 'error_llm_websocket_corrupt_payload' | 'error_frontend_corrupted_payload' | 'error_twilio' | 'error_no_audio_received' | 'error_asr' | 'error_retell' | 'error_unknown' | 'error_user_not_joined' | 'registered_call_timeout';
429
- /**
430
- * End to end latency (from user stops talking to agent start talking) tracking of
431
- * the call, available after call ends. This latency does not account for the
432
- * network trip time from Retell server to user frontend. The latency is tracked
433
- * every time turn change between user and agent.
434
- */
435
- e2e_latency?: WebCallResponse.E2ELatency;
436
584
  /**
437
585
  * End timestamp (milliseconds since epoch) of the call. Available after call ends.
438
586
  */
439
587
  end_timestamp?: number;
440
588
  /**
441
- * LLM latency (from issue of LLM call to first token received) tracking of the
442
- * call, available after call ends. When using custom LLM. this latency includes
443
- * LLM websocket roundtrip time between user server and Retell server.
589
+ * Latency tracking of the call, available after call ends. Not all fields here
590
+ * will be available, as it depends on the type of call and feature used.
444
591
  */
445
- llm_latency?: WebCallResponse.LlmLatency;
446
- /**
447
- * LLM websocket roundtrip latency (between user server and Retell server) tracking
448
- * of the call, available after call ends. Only populated for calls using custom
449
- * LLM.
450
- */
451
- llm_websocket_network_rtt_latency?: WebCallResponse.LlmWebsocketNetworkRttLatency;
592
+ latency?: WebCallResponse.Latency;
452
593
  /**
453
594
  * An arbitrary object for storage purpose only. You can put anything here like
454
595
  * your internal customer id associated with the call. Not used for processing. You
@@ -527,110 +668,280 @@ export declare namespace WebCallResponse {
527
668
  user_sentiment?: 'Negative' | 'Positive' | 'Neutral' | 'Unknown';
528
669
  }
529
670
  /**
530
- * End to end latency (from user stops talking to agent start talking) tracking of
531
- * the call, available after call ends. This latency does not account for the
532
- * network trip time from Retell server to user frontend. The latency is tracked
533
- * every time turn change between user and agent.
671
+ * Latency tracking of the call, available after call ends. Not all fields here
672
+ * will be available, as it depends on the type of call and feature used.
534
673
  */
535
- interface E2ELatency {
674
+ interface Latency {
536
675
  /**
537
- * Maximum latency in the call, measured in milliseconds.
676
+ * End to end latency (from user stops talking to agent start talking) tracking of
677
+ * the call. This latency does not account for the network trip time from Retell
678
+ * server to user frontend. The latency is tracked every time turn change between
679
+ * user and agent.
538
680
  */
539
- max?: number;
681
+ e2e?: Latency.E2E;
540
682
  /**
541
- * Minimum latency in the call, measured in milliseconds.
683
+ * Knowledge base latency (from the triggering of knowledge base retrival to all
684
+ * relevant context received) tracking of the call. Only populated when using
685
+ * knowledge base feature for the agent of the call.
542
686
  */
543
- min?: number;
687
+ knowledge_base?: Latency.KnowledgeBase;
544
688
  /**
545
- * Number of data points (number of times latency is tracked).
689
+ * LLM latency (from issue of LLM call to first speakable chunk received) tracking
690
+ * of the call. When using custom LLM. this latency includes LLM websocket
691
+ * roundtrip time between user server and Retell server.
546
692
  */
547
- num?: number;
693
+ llm?: Latency.Llm;
548
694
  /**
549
- * 50 percentile of latency, measured in milliseconds.
695
+ * LLM websocket roundtrip latency (between user server and Retell server) tracking
696
+ * of the call. Only populated for calls using custom LLM.
550
697
  */
551
- p50?: number;
698
+ llm_websocket_network_rtt?: Latency.LlmWebsocketNetworkRtt;
552
699
  /**
553
- * 90 percentile of latency, measured in milliseconds.
700
+ * Speech-to-speech latency (from requesting responses of a S2S model to first byte
701
+ * received) tracking of the call. Only populated for calls that uses S2S model
702
+ * like Realtime API.
554
703
  */
555
- p90?: number;
704
+ s2s?: Latency.S2s;
556
705
  /**
557
- * 95 percentile of latency, measured in milliseconds.
706
+ * Text-to-speech latency (from the triggering of TTS to first byte received)
707
+ * tracking of the call.
558
708
  */
559
- p95?: number;
560
- /**
561
- * 99 percentile of latency, measured in milliseconds.
562
- */
563
- p99?: number;
709
+ tts?: Latency.Tts;
564
710
  }
565
- /**
566
- * LLM latency (from issue of LLM call to first token received) tracking of the
567
- * call, available after call ends. When using custom LLM. this latency includes
568
- * LLM websocket roundtrip time between user server and Retell server.
569
- */
570
- interface LlmLatency {
711
+ namespace Latency {
571
712
  /**
572
- * Maximum latency in the call, measured in milliseconds.
713
+ * End to end latency (from user stops talking to agent start talking) tracking of
714
+ * the call. This latency does not account for the network trip time from Retell
715
+ * server to user frontend. The latency is tracked every time turn change between
716
+ * user and agent.
573
717
  */
574
- max?: number;
575
- /**
576
- * Minimum latency in the call, measured in milliseconds.
577
- */
578
- min?: number;
579
- /**
580
- * Number of data points (number of times latency is tracked).
581
- */
582
- num?: number;
583
- /**
584
- * 50 percentile of latency, measured in milliseconds.
585
- */
586
- p50?: number;
587
- /**
588
- * 90 percentile of latency, measured in milliseconds.
589
- */
590
- p90?: number;
591
- /**
592
- * 95 percentile of latency, measured in milliseconds.
593
- */
594
- p95?: number;
595
- /**
596
- * 99 percentile of latency, measured in milliseconds.
597
- */
598
- p99?: number;
599
- }
600
- /**
601
- * LLM websocket roundtrip latency (between user server and Retell server) tracking
602
- * of the call, available after call ends. Only populated for calls using custom
603
- * LLM.
604
- */
605
- interface LlmWebsocketNetworkRttLatency {
606
- /**
607
- * Maximum latency in the call, measured in milliseconds.
608
- */
609
- max?: number;
610
- /**
611
- * Minimum latency in the call, measured in milliseconds.
612
- */
613
- min?: number;
718
+ interface E2E {
719
+ /**
720
+ * Maximum latency in the call, measured in milliseconds.
721
+ */
722
+ max?: number;
723
+ /**
724
+ * Minimum latency in the call, measured in milliseconds.
725
+ */
726
+ min?: number;
727
+ /**
728
+ * Number of data points (number of times latency is tracked).
729
+ */
730
+ num?: number;
731
+ /**
732
+ * 50 percentile of latency, measured in milliseconds.
733
+ */
734
+ p50?: number;
735
+ /**
736
+ * 90 percentile of latency, measured in milliseconds.
737
+ */
738
+ p90?: number;
739
+ /**
740
+ * 95 percentile of latency, measured in milliseconds.
741
+ */
742
+ p95?: number;
743
+ /**
744
+ * 99 percentile of latency, measured in milliseconds.
745
+ */
746
+ p99?: number;
747
+ /**
748
+ * All the latency data points in the call, measured in milliseconds.
749
+ */
750
+ values?: Array<number>;
751
+ }
614
752
  /**
615
- * Number of data points (number of times latency is tracked).
753
+ * Knowledge base latency (from the triggering of knowledge base retrival to all
754
+ * relevant context received) tracking of the call. Only populated when using
755
+ * knowledge base feature for the agent of the call.
616
756
  */
617
- num?: number;
757
+ interface KnowledgeBase {
758
+ /**
759
+ * Maximum latency in the call, measured in milliseconds.
760
+ */
761
+ max?: number;
762
+ /**
763
+ * Minimum latency in the call, measured in milliseconds.
764
+ */
765
+ min?: number;
766
+ /**
767
+ * Number of data points (number of times latency is tracked).
768
+ */
769
+ num?: number;
770
+ /**
771
+ * 50 percentile of latency, measured in milliseconds.
772
+ */
773
+ p50?: number;
774
+ /**
775
+ * 90 percentile of latency, measured in milliseconds.
776
+ */
777
+ p90?: number;
778
+ /**
779
+ * 95 percentile of latency, measured in milliseconds.
780
+ */
781
+ p95?: number;
782
+ /**
783
+ * 99 percentile of latency, measured in milliseconds.
784
+ */
785
+ p99?: number;
786
+ /**
787
+ * All the latency data points in the call, measured in milliseconds.
788
+ */
789
+ values?: Array<number>;
790
+ }
618
791
  /**
619
- * 50 percentile of latency, measured in milliseconds.
792
+ * LLM latency (from issue of LLM call to first speakable chunk received) tracking
793
+ * of the call. When using custom LLM. this latency includes LLM websocket
794
+ * roundtrip time between user server and Retell server.
620
795
  */
621
- p50?: number;
796
+ interface Llm {
797
+ /**
798
+ * Maximum latency in the call, measured in milliseconds.
799
+ */
800
+ max?: number;
801
+ /**
802
+ * Minimum latency in the call, measured in milliseconds.
803
+ */
804
+ min?: number;
805
+ /**
806
+ * Number of data points (number of times latency is tracked).
807
+ */
808
+ num?: number;
809
+ /**
810
+ * 50 percentile of latency, measured in milliseconds.
811
+ */
812
+ p50?: number;
813
+ /**
814
+ * 90 percentile of latency, measured in milliseconds.
815
+ */
816
+ p90?: number;
817
+ /**
818
+ * 95 percentile of latency, measured in milliseconds.
819
+ */
820
+ p95?: number;
821
+ /**
822
+ * 99 percentile of latency, measured in milliseconds.
823
+ */
824
+ p99?: number;
825
+ /**
826
+ * All the latency data points in the call, measured in milliseconds.
827
+ */
828
+ values?: Array<number>;
829
+ }
622
830
  /**
623
- * 90 percentile of latency, measured in milliseconds.
831
+ * LLM websocket roundtrip latency (between user server and Retell server) tracking
832
+ * of the call. Only populated for calls using custom LLM.
624
833
  */
625
- p90?: number;
834
+ interface LlmWebsocketNetworkRtt {
835
+ /**
836
+ * Maximum latency in the call, measured in milliseconds.
837
+ */
838
+ max?: number;
839
+ /**
840
+ * Minimum latency in the call, measured in milliseconds.
841
+ */
842
+ min?: number;
843
+ /**
844
+ * Number of data points (number of times latency is tracked).
845
+ */
846
+ num?: number;
847
+ /**
848
+ * 50 percentile of latency, measured in milliseconds.
849
+ */
850
+ p50?: number;
851
+ /**
852
+ * 90 percentile of latency, measured in milliseconds.
853
+ */
854
+ p90?: number;
855
+ /**
856
+ * 95 percentile of latency, measured in milliseconds.
857
+ */
858
+ p95?: number;
859
+ /**
860
+ * 99 percentile of latency, measured in milliseconds.
861
+ */
862
+ p99?: number;
863
+ /**
864
+ * All the latency data points in the call, measured in milliseconds.
865
+ */
866
+ values?: Array<number>;
867
+ }
626
868
  /**
627
- * 95 percentile of latency, measured in milliseconds.
869
+ * Speech-to-speech latency (from requesting responses of a S2S model to first byte
870
+ * received) tracking of the call. Only populated for calls that uses S2S model
871
+ * like Realtime API.
628
872
  */
629
- p95?: number;
873
+ interface S2s {
874
+ /**
875
+ * Maximum latency in the call, measured in milliseconds.
876
+ */
877
+ max?: number;
878
+ /**
879
+ * Minimum latency in the call, measured in milliseconds.
880
+ */
881
+ min?: number;
882
+ /**
883
+ * Number of data points (number of times latency is tracked).
884
+ */
885
+ num?: number;
886
+ /**
887
+ * 50 percentile of latency, measured in milliseconds.
888
+ */
889
+ p50?: number;
890
+ /**
891
+ * 90 percentile of latency, measured in milliseconds.
892
+ */
893
+ p90?: number;
894
+ /**
895
+ * 95 percentile of latency, measured in milliseconds.
896
+ */
897
+ p95?: number;
898
+ /**
899
+ * 99 percentile of latency, measured in milliseconds.
900
+ */
901
+ p99?: number;
902
+ /**
903
+ * All the latency data points in the call, measured in milliseconds.
904
+ */
905
+ values?: Array<number>;
906
+ }
630
907
  /**
631
- * 99 percentile of latency, measured in milliseconds.
908
+ * Text-to-speech latency (from the triggering of TTS to first byte received)
909
+ * tracking of the call.
632
910
  */
633
- p99?: number;
911
+ interface Tts {
912
+ /**
913
+ * Maximum latency in the call, measured in milliseconds.
914
+ */
915
+ max?: number;
916
+ /**
917
+ * Minimum latency in the call, measured in milliseconds.
918
+ */
919
+ min?: number;
920
+ /**
921
+ * Number of data points (number of times latency is tracked).
922
+ */
923
+ num?: number;
924
+ /**
925
+ * 50 percentile of latency, measured in milliseconds.
926
+ */
927
+ p50?: number;
928
+ /**
929
+ * 90 percentile of latency, measured in milliseconds.
930
+ */
931
+ p90?: number;
932
+ /**
933
+ * 95 percentile of latency, measured in milliseconds.
934
+ */
935
+ p95?: number;
936
+ /**
937
+ * 99 percentile of latency, measured in milliseconds.
938
+ */
939
+ p99?: number;
940
+ /**
941
+ * All the latency data points in the call, measured in milliseconds.
942
+ */
943
+ values?: Array<number>;
944
+ }
634
945
  }
635
946
  interface TranscriptObject {
636
947
  /**
@@ -852,13 +1163,6 @@ export interface CallRegisterPhoneCallParams {
852
1163
  to_number?: string;
853
1164
  }
854
1165
  export declare namespace Call {
855
- export import CallResponse = CallAPI.CallResponse;
856
- export import PhoneCallResponse = CallAPI.PhoneCallResponse;
857
- export import WebCallResponse = CallAPI.WebCallResponse;
858
- export import CallListResponse = CallAPI.CallListResponse;
859
- export import CallListParams = CallAPI.CallListParams;
860
- export import CallCreatePhoneCallParams = CallAPI.CallCreatePhoneCallParams;
861
- export import CallCreateWebCallParams = CallAPI.CallCreateWebCallParams;
862
- export import CallRegisterPhoneCallParams = CallAPI.CallRegisterPhoneCallParams;
1166
+ export { type CallResponse as CallResponse, type PhoneCallResponse as PhoneCallResponse, type WebCallResponse as WebCallResponse, type CallListResponse as CallListResponse, type CallListParams as CallListParams, type CallCreatePhoneCallParams as CallCreatePhoneCallParams, type CallCreateWebCallParams as CallCreateWebCallParams, type CallRegisterPhoneCallParams as CallRegisterPhoneCallParams, };
863
1167
  }
864
1168
  //# sourceMappingURL=call.d.ts.map