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
@@ -2,7 +2,6 @@
2
2
 
3
3
  import { APIResource } from '../resource';
4
4
  import * as Core from '../core';
5
- import * as CallAPI from './call';
6
5
 
7
6
  export class Call extends APIResource {
8
7
  /**
@@ -138,32 +137,16 @@ export interface PhoneCallResponse {
138
137
  | 'error_user_not_joined'
139
138
  | 'registered_call_timeout';
140
139
 
141
- /**
142
- * End to end latency (from user stops talking to agent start talking) tracking of
143
- * the call, available after call ends. This latency does not account for the
144
- * network trip time from Retell server to user frontend. The latency is tracked
145
- * every time turn change between user and agent.
146
- */
147
- e2e_latency?: PhoneCallResponse.E2ELatency;
148
-
149
140
  /**
150
141
  * End timestamp (milliseconds since epoch) of the call. Available after call ends.
151
142
  */
152
143
  end_timestamp?: number;
153
144
 
154
145
  /**
155
- * LLM latency (from issue of LLM call to first token received) tracking of the
156
- * call, available after call ends. When using custom LLM. this latency includes
157
- * LLM websocket roundtrip time between user server and Retell server.
158
- */
159
- llm_latency?: PhoneCallResponse.LlmLatency;
160
-
161
- /**
162
- * LLM websocket roundtrip latency (between user server and Retell server) tracking
163
- * of the call, available after call ends. Only populated for calls using custom
164
- * LLM.
146
+ * Latency tracking of the call, available after call ends. Not all fields here
147
+ * will be available, as it depends on the type of call and feature used.
165
148
  */
166
- llm_websocket_network_rtt_latency?: PhoneCallResponse.LlmWebsocketNetworkRttLatency;
149
+ latency?: PhoneCallResponse.Latency;
167
150
 
168
151
  /**
169
152
  * An arbitrary object for storage purpose only. You can put anything here like
@@ -261,130 +244,333 @@ export namespace PhoneCallResponse {
261
244
  }
262
245
 
263
246
  /**
264
- * End to end latency (from user stops talking to agent start talking) tracking of
265
- * the call, available after call ends. This latency does not account for the
266
- * network trip time from Retell server to user frontend. The latency is tracked
267
- * every time turn change between user and agent.
247
+ * Latency tracking of the call, available after call ends. Not all fields here
248
+ * will be available, as it depends on the type of call and feature used.
268
249
  */
269
- export interface E2ELatency {
250
+ export interface Latency {
270
251
  /**
271
- * Maximum latency in the call, measured in milliseconds.
252
+ * End to end latency (from user stops talking to agent start talking) tracking of
253
+ * the call. This latency does not account for the network trip time from Retell
254
+ * server to user frontend. The latency is tracked every time turn change between
255
+ * user and agent.
272
256
  */
273
- max?: number;
257
+ e2e?: Latency.E2E;
274
258
 
275
259
  /**
276
- * Minimum latency in the call, measured in milliseconds.
260
+ * Knowledge base latency (from the triggering of knowledge base retrival to all
261
+ * relevant context received) tracking of the call. Only populated when using
262
+ * knowledge base feature for the agent of the call.
277
263
  */
278
- min?: number;
264
+ knowledge_base?: Latency.KnowledgeBase;
279
265
 
280
266
  /**
281
- * Number of data points (number of times latency is tracked).
267
+ * LLM latency (from issue of LLM call to first speakable chunk received) tracking
268
+ * of the call. When using custom LLM. this latency includes LLM websocket
269
+ * roundtrip time between user server and Retell server.
282
270
  */
283
- num?: number;
271
+ llm?: Latency.Llm;
284
272
 
285
273
  /**
286
- * 50 percentile of latency, measured in milliseconds.
274
+ * LLM websocket roundtrip latency (between user server and Retell server) tracking
275
+ * of the call. Only populated for calls using custom LLM.
287
276
  */
288
- p50?: number;
277
+ llm_websocket_network_rtt?: Latency.LlmWebsocketNetworkRtt;
289
278
 
290
279
  /**
291
- * 90 percentile of latency, measured in milliseconds.
280
+ * Speech-to-speech latency (from requesting responses of a S2S model to first byte
281
+ * received) tracking of the call. Only populated for calls that uses S2S model
282
+ * like Realtime API.
292
283
  */
293
- p90?: number;
284
+ s2s?: Latency.S2s;
294
285
 
295
286
  /**
296
- * 95 percentile of latency, measured in milliseconds.
287
+ * Text-to-speech latency (from the triggering of TTS to first byte received)
288
+ * tracking of the call.
297
289
  */
298
- p95?: number;
299
-
300
- /**
301
- * 99 percentile of latency, measured in milliseconds.
302
- */
303
- p99?: number;
290
+ tts?: Latency.Tts;
304
291
  }
305
292
 
306
- /**
307
- * LLM latency (from issue of LLM call to first token received) tracking of the
308
- * call, available after call ends. When using custom LLM. this latency includes
309
- * LLM websocket roundtrip time between user server and Retell server.
310
- */
311
- export interface LlmLatency {
293
+ export namespace Latency {
312
294
  /**
313
- * Maximum latency in the call, measured in milliseconds.
295
+ * End to end latency (from user stops talking to agent start talking) tracking of
296
+ * the call. This latency does not account for the network trip time from Retell
297
+ * server to user frontend. The latency is tracked every time turn change between
298
+ * user and agent.
314
299
  */
315
- max?: number;
300
+ export interface E2E {
301
+ /**
302
+ * Maximum latency in the call, measured in milliseconds.
303
+ */
304
+ max?: number;
316
305
 
317
- /**
318
- * Minimum latency in the call, measured in milliseconds.
319
- */
320
- min?: number;
306
+ /**
307
+ * Minimum latency in the call, measured in milliseconds.
308
+ */
309
+ min?: number;
321
310
 
322
- /**
323
- * Number of data points (number of times latency is tracked).
324
- */
325
- num?: number;
311
+ /**
312
+ * Number of data points (number of times latency is tracked).
313
+ */
314
+ num?: number;
326
315
 
327
- /**
328
- * 50 percentile of latency, measured in milliseconds.
329
- */
330
- p50?: number;
316
+ /**
317
+ * 50 percentile of latency, measured in milliseconds.
318
+ */
319
+ p50?: number;
331
320
 
332
- /**
333
- * 90 percentile of latency, measured in milliseconds.
334
- */
335
- p90?: number;
321
+ /**
322
+ * 90 percentile of latency, measured in milliseconds.
323
+ */
324
+ p90?: number;
336
325
 
337
- /**
338
- * 95 percentile of latency, measured in milliseconds.
339
- */
340
- p95?: number;
326
+ /**
327
+ * 95 percentile of latency, measured in milliseconds.
328
+ */
329
+ p95?: number;
341
330
 
342
- /**
343
- * 99 percentile of latency, measured in milliseconds.
344
- */
345
- p99?: number;
346
- }
331
+ /**
332
+ * 99 percentile of latency, measured in milliseconds.
333
+ */
334
+ p99?: number;
347
335
 
348
- /**
349
- * LLM websocket roundtrip latency (between user server and Retell server) tracking
350
- * of the call, available after call ends. Only populated for calls using custom
351
- * LLM.
352
- */
353
- export interface LlmWebsocketNetworkRttLatency {
354
- /**
355
- * Maximum latency in the call, measured in milliseconds.
356
- */
357
- max?: number;
336
+ /**
337
+ * All the latency data points in the call, measured in milliseconds.
338
+ */
339
+ values?: Array<number>;
340
+ }
358
341
 
359
342
  /**
360
- * Minimum latency in the call, measured in milliseconds.
343
+ * Knowledge base latency (from the triggering of knowledge base retrival to all
344
+ * relevant context received) tracking of the call. Only populated when using
345
+ * knowledge base feature for the agent of the call.
361
346
  */
362
- min?: number;
347
+ export interface KnowledgeBase {
348
+ /**
349
+ * Maximum latency in the call, measured in milliseconds.
350
+ */
351
+ max?: number;
363
352
 
364
- /**
365
- * Number of data points (number of times latency is tracked).
366
- */
367
- num?: number;
353
+ /**
354
+ * Minimum latency in the call, measured in milliseconds.
355
+ */
356
+ min?: number;
357
+
358
+ /**
359
+ * Number of data points (number of times latency is tracked).
360
+ */
361
+ num?: number;
362
+
363
+ /**
364
+ * 50 percentile of latency, measured in milliseconds.
365
+ */
366
+ p50?: number;
367
+
368
+ /**
369
+ * 90 percentile of latency, measured in milliseconds.
370
+ */
371
+ p90?: number;
372
+
373
+ /**
374
+ * 95 percentile of latency, measured in milliseconds.
375
+ */
376
+ p95?: number;
377
+
378
+ /**
379
+ * 99 percentile of latency, measured in milliseconds.
380
+ */
381
+ p99?: number;
382
+
383
+ /**
384
+ * All the latency data points in the call, measured in milliseconds.
385
+ */
386
+ values?: Array<number>;
387
+ }
368
388
 
369
389
  /**
370
- * 50 percentile of latency, measured in milliseconds.
390
+ * LLM latency (from issue of LLM call to first speakable chunk received) tracking
391
+ * of the call. When using custom LLM. this latency includes LLM websocket
392
+ * roundtrip time between user server and Retell server.
371
393
  */
372
- p50?: number;
394
+ export interface Llm {
395
+ /**
396
+ * Maximum latency in the call, measured in milliseconds.
397
+ */
398
+ max?: number;
399
+
400
+ /**
401
+ * Minimum latency in the call, measured in milliseconds.
402
+ */
403
+ min?: number;
404
+
405
+ /**
406
+ * Number of data points (number of times latency is tracked).
407
+ */
408
+ num?: number;
409
+
410
+ /**
411
+ * 50 percentile of latency, measured in milliseconds.
412
+ */
413
+ p50?: number;
414
+
415
+ /**
416
+ * 90 percentile of latency, measured in milliseconds.
417
+ */
418
+ p90?: number;
419
+
420
+ /**
421
+ * 95 percentile of latency, measured in milliseconds.
422
+ */
423
+ p95?: number;
424
+
425
+ /**
426
+ * 99 percentile of latency, measured in milliseconds.
427
+ */
428
+ p99?: number;
429
+
430
+ /**
431
+ * All the latency data points in the call, measured in milliseconds.
432
+ */
433
+ values?: Array<number>;
434
+ }
373
435
 
374
436
  /**
375
- * 90 percentile of latency, measured in milliseconds.
437
+ * LLM websocket roundtrip latency (between user server and Retell server) tracking
438
+ * of the call. Only populated for calls using custom LLM.
376
439
  */
377
- p90?: number;
440
+ export interface LlmWebsocketNetworkRtt {
441
+ /**
442
+ * Maximum latency in the call, measured in milliseconds.
443
+ */
444
+ max?: number;
445
+
446
+ /**
447
+ * Minimum latency in the call, measured in milliseconds.
448
+ */
449
+ min?: number;
450
+
451
+ /**
452
+ * Number of data points (number of times latency is tracked).
453
+ */
454
+ num?: number;
455
+
456
+ /**
457
+ * 50 percentile of latency, measured in milliseconds.
458
+ */
459
+ p50?: number;
460
+
461
+ /**
462
+ * 90 percentile of latency, measured in milliseconds.
463
+ */
464
+ p90?: number;
465
+
466
+ /**
467
+ * 95 percentile of latency, measured in milliseconds.
468
+ */
469
+ p95?: number;
470
+
471
+ /**
472
+ * 99 percentile of latency, measured in milliseconds.
473
+ */
474
+ p99?: number;
475
+
476
+ /**
477
+ * All the latency data points in the call, measured in milliseconds.
478
+ */
479
+ values?: Array<number>;
480
+ }
378
481
 
379
482
  /**
380
- * 95 percentile of latency, measured in milliseconds.
483
+ * Speech-to-speech latency (from requesting responses of a S2S model to first byte
484
+ * received) tracking of the call. Only populated for calls that uses S2S model
485
+ * like Realtime API.
381
486
  */
382
- p95?: number;
487
+ export interface S2s {
488
+ /**
489
+ * Maximum latency in the call, measured in milliseconds.
490
+ */
491
+ max?: number;
492
+
493
+ /**
494
+ * Minimum latency in the call, measured in milliseconds.
495
+ */
496
+ min?: number;
497
+
498
+ /**
499
+ * Number of data points (number of times latency is tracked).
500
+ */
501
+ num?: number;
502
+
503
+ /**
504
+ * 50 percentile of latency, measured in milliseconds.
505
+ */
506
+ p50?: number;
507
+
508
+ /**
509
+ * 90 percentile of latency, measured in milliseconds.
510
+ */
511
+ p90?: number;
512
+
513
+ /**
514
+ * 95 percentile of latency, measured in milliseconds.
515
+ */
516
+ p95?: number;
517
+
518
+ /**
519
+ * 99 percentile of latency, measured in milliseconds.
520
+ */
521
+ p99?: number;
522
+
523
+ /**
524
+ * All the latency data points in the call, measured in milliseconds.
525
+ */
526
+ values?: Array<number>;
527
+ }
383
528
 
384
529
  /**
385
- * 99 percentile of latency, measured in milliseconds.
530
+ * Text-to-speech latency (from the triggering of TTS to first byte received)
531
+ * tracking of the call.
386
532
  */
387
- p99?: number;
533
+ export interface Tts {
534
+ /**
535
+ * Maximum latency in the call, measured in milliseconds.
536
+ */
537
+ max?: number;
538
+
539
+ /**
540
+ * Minimum latency in the call, measured in milliseconds.
541
+ */
542
+ min?: number;
543
+
544
+ /**
545
+ * Number of data points (number of times latency is tracked).
546
+ */
547
+ num?: number;
548
+
549
+ /**
550
+ * 50 percentile of latency, measured in milliseconds.
551
+ */
552
+ p50?: number;
553
+
554
+ /**
555
+ * 90 percentile of latency, measured in milliseconds.
556
+ */
557
+ p90?: number;
558
+
559
+ /**
560
+ * 95 percentile of latency, measured in milliseconds.
561
+ */
562
+ p95?: number;
563
+
564
+ /**
565
+ * 99 percentile of latency, measured in milliseconds.
566
+ */
567
+ p99?: number;
568
+
569
+ /**
570
+ * All the latency data points in the call, measured in milliseconds.
571
+ */
572
+ values?: Array<number>;
573
+ }
388
574
  }
389
575
 
390
576
  export interface TranscriptObject {
@@ -584,32 +770,16 @@ export interface WebCallResponse {
584
770
  | 'error_user_not_joined'
585
771
  | 'registered_call_timeout';
586
772
 
587
- /**
588
- * End to end latency (from user stops talking to agent start talking) tracking of
589
- * the call, available after call ends. This latency does not account for the
590
- * network trip time from Retell server to user frontend. The latency is tracked
591
- * every time turn change between user and agent.
592
- */
593
- e2e_latency?: WebCallResponse.E2ELatency;
594
-
595
773
  /**
596
774
  * End timestamp (milliseconds since epoch) of the call. Available after call ends.
597
775
  */
598
776
  end_timestamp?: number;
599
777
 
600
778
  /**
601
- * LLM latency (from issue of LLM call to first token received) tracking of the
602
- * call, available after call ends. When using custom LLM. this latency includes
603
- * LLM websocket roundtrip time between user server and Retell server.
604
- */
605
- llm_latency?: WebCallResponse.LlmLatency;
606
-
607
- /**
608
- * LLM websocket roundtrip latency (between user server and Retell server) tracking
609
- * of the call, available after call ends. Only populated for calls using custom
610
- * LLM.
779
+ * Latency tracking of the call, available after call ends. Not all fields here
780
+ * will be available, as it depends on the type of call and feature used.
611
781
  */
612
- llm_websocket_network_rtt_latency?: WebCallResponse.LlmWebsocketNetworkRttLatency;
782
+ latency?: WebCallResponse.Latency;
613
783
 
614
784
  /**
615
785
  * An arbitrary object for storage purpose only. You can put anything here like
@@ -707,130 +877,333 @@ export namespace WebCallResponse {
707
877
  }
708
878
 
709
879
  /**
710
- * End to end latency (from user stops talking to agent start talking) tracking of
711
- * the call, available after call ends. This latency does not account for the
712
- * network trip time from Retell server to user frontend. The latency is tracked
713
- * every time turn change between user and agent.
880
+ * Latency tracking of the call, available after call ends. Not all fields here
881
+ * will be available, as it depends on the type of call and feature used.
714
882
  */
715
- export interface E2ELatency {
883
+ export interface Latency {
716
884
  /**
717
- * Maximum latency in the call, measured in milliseconds.
885
+ * End to end latency (from user stops talking to agent start talking) tracking of
886
+ * the call. This latency does not account for the network trip time from Retell
887
+ * server to user frontend. The latency is tracked every time turn change between
888
+ * user and agent.
718
889
  */
719
- max?: number;
890
+ e2e?: Latency.E2E;
720
891
 
721
892
  /**
722
- * Minimum latency in the call, measured in milliseconds.
893
+ * Knowledge base latency (from the triggering of knowledge base retrival to all
894
+ * relevant context received) tracking of the call. Only populated when using
895
+ * knowledge base feature for the agent of the call.
723
896
  */
724
- min?: number;
897
+ knowledge_base?: Latency.KnowledgeBase;
725
898
 
726
899
  /**
727
- * Number of data points (number of times latency is tracked).
900
+ * LLM latency (from issue of LLM call to first speakable chunk received) tracking
901
+ * of the call. When using custom LLM. this latency includes LLM websocket
902
+ * roundtrip time between user server and Retell server.
728
903
  */
729
- num?: number;
904
+ llm?: Latency.Llm;
730
905
 
731
906
  /**
732
- * 50 percentile of latency, measured in milliseconds.
907
+ * LLM websocket roundtrip latency (between user server and Retell server) tracking
908
+ * of the call. Only populated for calls using custom LLM.
733
909
  */
734
- p50?: number;
910
+ llm_websocket_network_rtt?: Latency.LlmWebsocketNetworkRtt;
735
911
 
736
912
  /**
737
- * 90 percentile of latency, measured in milliseconds.
913
+ * Speech-to-speech latency (from requesting responses of a S2S model to first byte
914
+ * received) tracking of the call. Only populated for calls that uses S2S model
915
+ * like Realtime API.
738
916
  */
739
- p90?: number;
917
+ s2s?: Latency.S2s;
740
918
 
741
919
  /**
742
- * 95 percentile of latency, measured in milliseconds.
920
+ * Text-to-speech latency (from the triggering of TTS to first byte received)
921
+ * tracking of the call.
743
922
  */
744
- p95?: number;
745
-
746
- /**
747
- * 99 percentile of latency, measured in milliseconds.
748
- */
749
- p99?: number;
923
+ tts?: Latency.Tts;
750
924
  }
751
925
 
752
- /**
753
- * LLM latency (from issue of LLM call to first token received) tracking of the
754
- * call, available after call ends. When using custom LLM. this latency includes
755
- * LLM websocket roundtrip time between user server and Retell server.
756
- */
757
- export interface LlmLatency {
926
+ export namespace Latency {
758
927
  /**
759
- * Maximum latency in the call, measured in milliseconds.
928
+ * End to end latency (from user stops talking to agent start talking) tracking of
929
+ * the call. This latency does not account for the network trip time from Retell
930
+ * server to user frontend. The latency is tracked every time turn change between
931
+ * user and agent.
760
932
  */
761
- max?: number;
933
+ export interface E2E {
934
+ /**
935
+ * Maximum latency in the call, measured in milliseconds.
936
+ */
937
+ max?: number;
762
938
 
763
- /**
764
- * Minimum latency in the call, measured in milliseconds.
765
- */
766
- min?: number;
939
+ /**
940
+ * Minimum latency in the call, measured in milliseconds.
941
+ */
942
+ min?: number;
767
943
 
768
- /**
769
- * Number of data points (number of times latency is tracked).
770
- */
771
- num?: number;
944
+ /**
945
+ * Number of data points (number of times latency is tracked).
946
+ */
947
+ num?: number;
772
948
 
773
- /**
774
- * 50 percentile of latency, measured in milliseconds.
775
- */
776
- p50?: number;
949
+ /**
950
+ * 50 percentile of latency, measured in milliseconds.
951
+ */
952
+ p50?: number;
777
953
 
778
- /**
779
- * 90 percentile of latency, measured in milliseconds.
780
- */
781
- p90?: number;
954
+ /**
955
+ * 90 percentile of latency, measured in milliseconds.
956
+ */
957
+ p90?: number;
782
958
 
783
- /**
784
- * 95 percentile of latency, measured in milliseconds.
785
- */
786
- p95?: number;
959
+ /**
960
+ * 95 percentile of latency, measured in milliseconds.
961
+ */
962
+ p95?: number;
787
963
 
788
- /**
789
- * 99 percentile of latency, measured in milliseconds.
790
- */
791
- p99?: number;
792
- }
964
+ /**
965
+ * 99 percentile of latency, measured in milliseconds.
966
+ */
967
+ p99?: number;
793
968
 
794
- /**
795
- * LLM websocket roundtrip latency (between user server and Retell server) tracking
796
- * of the call, available after call ends. Only populated for calls using custom
797
- * LLM.
798
- */
799
- export interface LlmWebsocketNetworkRttLatency {
800
- /**
801
- * Maximum latency in the call, measured in milliseconds.
802
- */
803
- max?: number;
969
+ /**
970
+ * All the latency data points in the call, measured in milliseconds.
971
+ */
972
+ values?: Array<number>;
973
+ }
804
974
 
805
975
  /**
806
- * Minimum latency in the call, measured in milliseconds.
976
+ * Knowledge base latency (from the triggering of knowledge base retrival to all
977
+ * relevant context received) tracking of the call. Only populated when using
978
+ * knowledge base feature for the agent of the call.
807
979
  */
808
- min?: number;
980
+ export interface KnowledgeBase {
981
+ /**
982
+ * Maximum latency in the call, measured in milliseconds.
983
+ */
984
+ max?: number;
809
985
 
810
- /**
811
- * Number of data points (number of times latency is tracked).
812
- */
813
- num?: number;
986
+ /**
987
+ * Minimum latency in the call, measured in milliseconds.
988
+ */
989
+ min?: number;
990
+
991
+ /**
992
+ * Number of data points (number of times latency is tracked).
993
+ */
994
+ num?: number;
995
+
996
+ /**
997
+ * 50 percentile of latency, measured in milliseconds.
998
+ */
999
+ p50?: number;
1000
+
1001
+ /**
1002
+ * 90 percentile of latency, measured in milliseconds.
1003
+ */
1004
+ p90?: number;
1005
+
1006
+ /**
1007
+ * 95 percentile of latency, measured in milliseconds.
1008
+ */
1009
+ p95?: number;
1010
+
1011
+ /**
1012
+ * 99 percentile of latency, measured in milliseconds.
1013
+ */
1014
+ p99?: number;
1015
+
1016
+ /**
1017
+ * All the latency data points in the call, measured in milliseconds.
1018
+ */
1019
+ values?: Array<number>;
1020
+ }
814
1021
 
815
1022
  /**
816
- * 50 percentile of latency, measured in milliseconds.
1023
+ * LLM latency (from issue of LLM call to first speakable chunk received) tracking
1024
+ * of the call. When using custom LLM. this latency includes LLM websocket
1025
+ * roundtrip time between user server and Retell server.
817
1026
  */
818
- p50?: number;
1027
+ export interface Llm {
1028
+ /**
1029
+ * Maximum latency in the call, measured in milliseconds.
1030
+ */
1031
+ max?: number;
1032
+
1033
+ /**
1034
+ * Minimum latency in the call, measured in milliseconds.
1035
+ */
1036
+ min?: number;
1037
+
1038
+ /**
1039
+ * Number of data points (number of times latency is tracked).
1040
+ */
1041
+ num?: number;
1042
+
1043
+ /**
1044
+ * 50 percentile of latency, measured in milliseconds.
1045
+ */
1046
+ p50?: number;
1047
+
1048
+ /**
1049
+ * 90 percentile of latency, measured in milliseconds.
1050
+ */
1051
+ p90?: number;
1052
+
1053
+ /**
1054
+ * 95 percentile of latency, measured in milliseconds.
1055
+ */
1056
+ p95?: number;
1057
+
1058
+ /**
1059
+ * 99 percentile of latency, measured in milliseconds.
1060
+ */
1061
+ p99?: number;
1062
+
1063
+ /**
1064
+ * All the latency data points in the call, measured in milliseconds.
1065
+ */
1066
+ values?: Array<number>;
1067
+ }
819
1068
 
820
1069
  /**
821
- * 90 percentile of latency, measured in milliseconds.
1070
+ * LLM websocket roundtrip latency (between user server and Retell server) tracking
1071
+ * of the call. Only populated for calls using custom LLM.
822
1072
  */
823
- p90?: number;
1073
+ export interface LlmWebsocketNetworkRtt {
1074
+ /**
1075
+ * Maximum latency in the call, measured in milliseconds.
1076
+ */
1077
+ max?: number;
1078
+
1079
+ /**
1080
+ * Minimum latency in the call, measured in milliseconds.
1081
+ */
1082
+ min?: number;
1083
+
1084
+ /**
1085
+ * Number of data points (number of times latency is tracked).
1086
+ */
1087
+ num?: number;
1088
+
1089
+ /**
1090
+ * 50 percentile of latency, measured in milliseconds.
1091
+ */
1092
+ p50?: number;
1093
+
1094
+ /**
1095
+ * 90 percentile of latency, measured in milliseconds.
1096
+ */
1097
+ p90?: number;
1098
+
1099
+ /**
1100
+ * 95 percentile of latency, measured in milliseconds.
1101
+ */
1102
+ p95?: number;
1103
+
1104
+ /**
1105
+ * 99 percentile of latency, measured in milliseconds.
1106
+ */
1107
+ p99?: number;
1108
+
1109
+ /**
1110
+ * All the latency data points in the call, measured in milliseconds.
1111
+ */
1112
+ values?: Array<number>;
1113
+ }
824
1114
 
825
1115
  /**
826
- * 95 percentile of latency, measured in milliseconds.
1116
+ * Speech-to-speech latency (from requesting responses of a S2S model to first byte
1117
+ * received) tracking of the call. Only populated for calls that uses S2S model
1118
+ * like Realtime API.
827
1119
  */
828
- p95?: number;
1120
+ export interface S2s {
1121
+ /**
1122
+ * Maximum latency in the call, measured in milliseconds.
1123
+ */
1124
+ max?: number;
1125
+
1126
+ /**
1127
+ * Minimum latency in the call, measured in milliseconds.
1128
+ */
1129
+ min?: number;
1130
+
1131
+ /**
1132
+ * Number of data points (number of times latency is tracked).
1133
+ */
1134
+ num?: number;
1135
+
1136
+ /**
1137
+ * 50 percentile of latency, measured in milliseconds.
1138
+ */
1139
+ p50?: number;
1140
+
1141
+ /**
1142
+ * 90 percentile of latency, measured in milliseconds.
1143
+ */
1144
+ p90?: number;
1145
+
1146
+ /**
1147
+ * 95 percentile of latency, measured in milliseconds.
1148
+ */
1149
+ p95?: number;
1150
+
1151
+ /**
1152
+ * 99 percentile of latency, measured in milliseconds.
1153
+ */
1154
+ p99?: number;
1155
+
1156
+ /**
1157
+ * All the latency data points in the call, measured in milliseconds.
1158
+ */
1159
+ values?: Array<number>;
1160
+ }
829
1161
 
830
1162
  /**
831
- * 99 percentile of latency, measured in milliseconds.
1163
+ * Text-to-speech latency (from the triggering of TTS to first byte received)
1164
+ * tracking of the call.
832
1165
  */
833
- p99?: number;
1166
+ export interface Tts {
1167
+ /**
1168
+ * Maximum latency in the call, measured in milliseconds.
1169
+ */
1170
+ max?: number;
1171
+
1172
+ /**
1173
+ * Minimum latency in the call, measured in milliseconds.
1174
+ */
1175
+ min?: number;
1176
+
1177
+ /**
1178
+ * Number of data points (number of times latency is tracked).
1179
+ */
1180
+ num?: number;
1181
+
1182
+ /**
1183
+ * 50 percentile of latency, measured in milliseconds.
1184
+ */
1185
+ p50?: number;
1186
+
1187
+ /**
1188
+ * 90 percentile of latency, measured in milliseconds.
1189
+ */
1190
+ p90?: number;
1191
+
1192
+ /**
1193
+ * 95 percentile of latency, measured in milliseconds.
1194
+ */
1195
+ p95?: number;
1196
+
1197
+ /**
1198
+ * 99 percentile of latency, measured in milliseconds.
1199
+ */
1200
+ p99?: number;
1201
+
1202
+ /**
1203
+ * All the latency data points in the call, measured in milliseconds.
1204
+ */
1205
+ values?: Array<number>;
1206
+ }
834
1207
  }
835
1208
 
836
1209
  export interface TranscriptObject {
@@ -1095,13 +1468,15 @@ export interface CallRegisterPhoneCallParams {
1095
1468
  to_number?: string;
1096
1469
  }
1097
1470
 
1098
- export namespace Call {
1099
- export import CallResponse = CallAPI.CallResponse;
1100
- export import PhoneCallResponse = CallAPI.PhoneCallResponse;
1101
- export import WebCallResponse = CallAPI.WebCallResponse;
1102
- export import CallListResponse = CallAPI.CallListResponse;
1103
- export import CallListParams = CallAPI.CallListParams;
1104
- export import CallCreatePhoneCallParams = CallAPI.CallCreatePhoneCallParams;
1105
- export import CallCreateWebCallParams = CallAPI.CallCreateWebCallParams;
1106
- export import CallRegisterPhoneCallParams = CallAPI.CallRegisterPhoneCallParams;
1471
+ export declare namespace Call {
1472
+ export {
1473
+ type CallResponse as CallResponse,
1474
+ type PhoneCallResponse as PhoneCallResponse,
1475
+ type WebCallResponse as WebCallResponse,
1476
+ type CallListResponse as CallListResponse,
1477
+ type CallListParams as CallListParams,
1478
+ type CallCreatePhoneCallParams as CallCreatePhoneCallParams,
1479
+ type CallCreateWebCallParams as CallCreateWebCallParams,
1480
+ type CallRegisterPhoneCallParams as CallRegisterPhoneCallParams,
1481
+ };
1107
1482
  }