@livekit/protocol 1.50.2 → 1.50.3

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.
package/dist/index.d.cts CHANGED
@@ -10364,11 +10364,15 @@ declare class SimulationRun_JobMetrics extends Message<SimulationRun_JobMetrics>
10364
10364
  * accuracy = task_completion x3 + stt.keyterm_recall + (1 - stt.wer) + tts.enunciation_score
10365
10365
  * experience = conversation.turn_taking_score x2 + tts.naturalness_score + llm.conciseness_score
10366
10366
  *
10367
+ * absent when the simulator spoiled the call
10368
+ *
10367
10369
  * @generated from field: optional float accuracy_score = 1;
10368
10370
  */
10369
10371
  accuracyScore?: number;
10370
10372
 
10371
10373
  /**
10374
+ * absent when the simulator spoiled the call
10375
+ *
10372
10376
  * @generated from field: optional float experience_score = 2;
10373
10377
  */
10374
10378
  experienceScore?: number;
@@ -10376,6 +10380,8 @@ declare class SimulationRun_JobMetrics extends Message<SimulationRun_JobMetrics>
10376
10380
  /**
10377
10381
  * The accuracy anchor: the scenario verdict as 1/0, or the fraction of the declared target state the call reached.
10378
10382
  *
10383
+ * absent when the simulator spoiled the call
10384
+ *
10379
10385
  * @generated from field: optional float task_completion = 3;
10380
10386
  */
10381
10387
  taskCompletion?: number;
@@ -10434,7 +10440,7 @@ declare class SimulationRun_JobMetrics extends Message<SimulationRun_JobMetrics>
10434
10440
  hasRemoteSession: boolean;
10435
10441
 
10436
10442
  /**
10437
- * call start (first speech edge); turn times relative to it
10443
+ * audio only; call start (first speech edge); turn times relative to it
10438
10444
  *
10439
10445
  * @generated from field: google.protobuf.Timestamp t0 = 13;
10440
10446
  */
@@ -10456,66 +10462,76 @@ declare class SimulationRun_JobMetrics extends Message<SimulationRun_JobMetrics>
10456
10462
  }
10457
10463
 
10458
10464
  /**
10459
- * The agent's perception of the caller.
10465
+ * The agent's perception of the caller. Audio only.
10460
10466
  *
10461
10467
  * @generated from message livekit.SimulationRun.JobMetrics.STT
10462
10468
  */
10463
10469
  declare class SimulationRun_JobMetrics_STT extends Message<SimulationRun_JobMetrics_STT> {
10464
10470
  /**
10465
- * word error rate, pooled: word_errors / words
10471
+ * needs the RemoteSession; word error rate, pooled: word_errors / words
10466
10472
  *
10467
10473
  * @generated from field: optional float wer = 1;
10468
10474
  */
10469
10475
  wer?: number;
10470
10476
 
10471
10477
  /**
10472
- * pooling stats: run WER = sum errors / sum words
10478
+ * needs the RemoteSession; pooling stats: run WER = sum errors / sum words
10473
10479
  *
10474
10480
  * @generated from field: optional uint32 words = 2;
10475
10481
  */
10476
10482
  words?: number;
10477
10483
 
10478
10484
  /**
10485
+ * needs the RemoteSession
10486
+ *
10479
10487
  * @generated from field: optional uint32 word_errors = 3;
10480
10488
  */
10481
10489
  wordErrors?: number;
10482
10490
 
10483
10491
  /**
10484
- * character error rate, pooled
10492
+ * needs the RemoteSession; character error rate, pooled
10485
10493
  *
10486
10494
  * @generated from field: optional float cer = 4;
10487
10495
  */
10488
10496
  cer?: number;
10489
10497
 
10490
10498
  /**
10499
+ * needs the RemoteSession
10500
+ *
10491
10501
  * @generated from field: optional uint32 chars = 9;
10492
10502
  */
10493
10503
  chars?: number;
10494
10504
 
10495
10505
  /**
10506
+ * needs the RemoteSession
10507
+ *
10496
10508
  * @generated from field: optional uint32 char_errors = 10;
10497
10509
  */
10498
10510
  charErrors?: number;
10499
10511
 
10500
10512
  /**
10501
- * recall of uttered key entities (names, IDs, amounts)
10513
+ * needs the RemoteSession; recall of uttered key entities (names, IDs, amounts)
10502
10514
  *
10503
10515
  * @generated from field: optional float keyterm_recall = 5;
10504
10516
  */
10505
10517
  keytermRecall?: number;
10506
10518
 
10507
10519
  /**
10520
+ * needs the RemoteSession
10521
+ *
10508
10522
  * @generated from field: optional uint32 keyterms_uttered = 6;
10509
10523
  */
10510
10524
  keytermsUttered?: number;
10511
10525
 
10512
10526
  /**
10527
+ * needs the RemoteSession
10528
+ *
10513
10529
  * @generated from field: optional uint32 keyterms_recognized = 7;
10514
10530
  */
10515
10531
  keytermsRecognized?: number;
10516
10532
 
10517
10533
  /**
10518
- * agent-reported STT/endpointing delay, mean
10534
+ * needs the RemoteSession; agent-reported STT/endpointing delay, mean
10519
10535
  *
10520
10536
  * @generated from field: optional uint32 transcription_latency_ms = 8;
10521
10537
  */
@@ -10541,28 +10557,28 @@ declare class SimulationRun_JobMetrics_STT extends Message<SimulationRun_JobMetr
10541
10557
  */
10542
10558
  declare class SimulationRun_JobMetrics_LLM extends Message<SimulationRun_JobMetrics_LLM> {
10543
10559
  /**
10544
- * time to first token, mean (per-turn in turns)
10560
+ * needs the RemoteSession; time to first token, mean (per-turn in turns)
10545
10561
  *
10546
10562
  * @generated from field: optional uint32 ttft_ms = 1;
10547
10563
  */
10548
10564
  ttftMs?: number;
10549
10565
 
10550
10566
  /**
10551
- * time to first sentence — the smallest speakable unit
10567
+ * needs the RemoteSession; time to first sentence (the smallest speakable unit)
10552
10568
  *
10553
10569
  * @generated from field: optional uint32 ttfs_ms = 2;
10554
10570
  */
10555
10571
  ttfsMs?: number;
10556
10572
 
10557
10573
  /**
10558
- * decode rate, mean
10574
+ * needs the RemoteSession; decode rate, mean (per-turn in turns.llm)
10559
10575
  *
10560
10576
  * @generated from field: optional float tokens_per_second = 3;
10561
10577
  */
10562
10578
  tokensPerSecond?: number;
10563
10579
 
10564
10580
  /**
10565
- * judged 0-1: brief enough for voice
10581
+ * audio only; needs the audio judge; judged 0-1: brief enough for voice
10566
10582
  *
10567
10583
  * @generated from field: optional float conciseness_score = 4;
10568
10584
  */
@@ -10584,57 +10600,63 @@ declare class SimulationRun_JobMetrics_LLM extends Message<SimulationRun_JobMetr
10584
10600
  }
10585
10601
 
10586
10602
  /**
10587
- * The agent's voice.
10603
+ * The agent's voice. audio only.
10588
10604
  *
10589
10605
  * @generated from message livekit.SimulationRun.JobMetrics.TTS
10590
10606
  */
10591
10607
  declare class SimulationRun_JobMetrics_TTS extends Message<SimulationRun_JobMetrics_TTS> {
10592
10608
  /**
10593
- * Time to first AUDIO — the user-relevant signal. Some providers stream
10594
- * bytes before actual speech, so byte-level TTFB alone over-promises;
10595
- * it is kept below for disambiguation.
10609
+ * needs the RemoteSession
10596
10610
  *
10597
10611
  * @generated from field: optional uint32 ttfa_ms = 1;
10598
10612
  */
10599
10613
  ttfaMs?: number;
10600
10614
 
10601
10615
  /**
10602
- * provider byte-level TTFB, agent-reported
10616
+ * needs the RemoteSession; provider byte-level TTFB
10603
10617
  *
10604
10618
  * @generated from field: optional uint32 ttfb_ms = 2;
10605
10619
  */
10606
10620
  ttfbMs?: number;
10607
10621
 
10608
10622
  /**
10609
- * word error rate, pooled: word_errors / words
10623
+ * needs the RemoteSession; word error rate, pooled: word_errors / words
10610
10624
  *
10611
10625
  * @generated from field: optional float wer = 3;
10612
10626
  */
10613
10627
  wer?: number;
10614
10628
 
10615
10629
  /**
10630
+ * needs the RemoteSession
10631
+ *
10616
10632
  * @generated from field: optional uint32 words = 7;
10617
10633
  */
10618
10634
  words?: number;
10619
10635
 
10620
10636
  /**
10637
+ * needs the RemoteSession
10638
+ *
10621
10639
  * @generated from field: optional uint32 word_errors = 8;
10622
10640
  */
10623
10641
  wordErrors?: number;
10624
10642
 
10625
10643
  /**
10626
- * character error rate, pooled
10644
+ * needs the RemoteSession; character error rate, pooled
10627
10645
  *
10628
10646
  * @generated from field: optional float cer = 9;
10629
10647
  */
10630
10648
  cer?: number;
10631
10649
 
10632
10650
  /**
10651
+ * needs the RemoteSession
10652
+ *
10633
10653
  * @generated from field: optional uint32 chars = 10;
10634
10654
  */
10635
10655
  chars?: number;
10636
10656
 
10637
10657
  /**
10658
+ * needs the RemoteSession
10659
+ *
10638
10660
  * @generated from field: optional uint32 char_errors = 11;
10639
10661
  */
10640
10662
  charErrors?: number;
@@ -10647,14 +10669,28 @@ declare class SimulationRun_JobMetrics_TTS extends Message<SimulationRun_JobMetr
10647
10669
  speechRateWpm?: number;
10648
10670
 
10649
10671
  /**
10650
- * judged 0-1: prosody / expressiveness
10672
+ * pooling stats for speech_rate_wpm: raw heard words (not WER tokens)
10673
+ *
10674
+ * @generated from field: optional uint32 heard_words = 12;
10675
+ */
10676
+ heardWords?: number;
10677
+
10678
+ /**
10679
+ * agent voiced time, sum of raw VAD segments
10680
+ *
10681
+ * @generated from field: optional uint32 speech_ms = 13;
10682
+ */
10683
+ speechMs?: number;
10684
+
10685
+ /**
10686
+ * needs the audio judge; judged 0-1: prosody / expressiveness
10651
10687
  *
10652
10688
  * @generated from field: optional float naturalness_score = 5;
10653
10689
  */
10654
10690
  naturalnessScore?: number;
10655
10691
 
10656
10692
  /**
10657
- * judged 0-1: key entities audibly intact
10693
+ * needs the audio judge; judged 0-1: key entities audibly intact
10658
10694
  *
10659
10695
  * @generated from field: optional float enunciation_score = 6;
10660
10696
  */
@@ -10676,8 +10712,7 @@ declare class SimulationRun_JobMetrics_TTS extends Message<SimulationRun_JobMetr
10676
10712
  }
10677
10713
 
10678
10714
  /**
10679
- * End-to-end floor dynamics, measured off the audio timeline — the ground
10680
- * truth of what the caller hears, independent of agent self-reports.
10715
+ * Audio only.
10681
10716
  *
10682
10717
  * @generated from message livekit.SimulationRun.JobMetrics.Conversation
10683
10718
  */
@@ -10707,14 +10742,21 @@ declare class SimulationRun_JobMetrics_Conversation extends Message<SimulationRu
10707
10742
  responseLatencyP99Ms?: number;
10708
10743
 
10709
10744
  /**
10710
- * how long the agent talks after a barge-in, mean
10745
+ * one turn's floor-transfer offset, cut-in if negative; job/run serve the percentiles
10746
+ *
10747
+ * @generated from field: optional int32 response_latency_ms = 16;
10748
+ */
10749
+ responseLatencyMs?: number;
10750
+
10751
+ /**
10752
+ * agent audio continuing past a barge-in — per turn: on the barging persona row (presence = barge-in); job: mean
10711
10753
  *
10712
10754
  * @generated from field: optional uint32 agent_yield_latency_ms = 5;
10713
10755
  */
10714
10756
  agentYieldLatencyMs?: number;
10715
10757
 
10716
10758
  /**
10717
- * agent started before the caller's turn ended
10759
+ * agent started before the caller's turn ended; 0/1 per turn
10718
10760
  *
10719
10761
  * @generated from field: optional uint32 eot_misprediction_count = 6;
10720
10762
  */
@@ -10747,35 +10789,35 @@ declare class SimulationRun_JobMetrics_Conversation extends Message<SimulationRu
10747
10789
  silenceTotalMs?: number;
10748
10790
 
10749
10791
  /**
10750
- * gaps past the natural-pause threshold
10792
+ * gaps past the natural-pause threshold; 0/1 per turn
10751
10793
  *
10752
10794
  * @generated from field: optional uint32 awkward_silence_count = 11;
10753
10795
  */
10754
10796
  awkwardSilenceCount?: number;
10755
10797
 
10756
10798
  /**
10757
- * the simulated party spoke, the agent never responded
10799
+ * the simulated party spoke, the agent never responded; 0/1 per turn
10758
10800
  *
10759
10801
  * @generated from field: optional uint32 unanswered_persona_turns = 12;
10760
10802
  */
10761
10803
  unansweredPersonaTurns?: number;
10762
10804
 
10763
10805
  /**
10764
- * agent paused for a non-interruption
10806
+ * needs the RemoteSession; agent paused for a non-interruption
10765
10807
  *
10766
10808
  * @generated from field: optional uint32 false_interruption_count = 13;
10767
10809
  */
10768
10810
  falseInterruptionCount?: number;
10769
10811
 
10770
10812
  /**
10771
- * of those, never resumed
10813
+ * needs the RemoteSession; of those, never resumed
10772
10814
  *
10773
10815
  * @generated from field: optional uint32 false_interruption_unrecovered_count = 14;
10774
10816
  */
10775
10817
  falseInterruptionUnrecoveredCount?: number;
10776
10818
 
10777
10819
  /**
10778
- * the agent's own claim, mean
10820
+ * needs the RemoteSession; the agent's own claim, mean
10779
10821
  *
10780
10822
  * @generated from field: optional uint32 agent_reported_e2e_latency_ms = 15;
10781
10823
  */
@@ -10834,6 +10876,8 @@ declare class SimulationRun_JobMetrics_Simulator extends Message<SimulationRun_J
10834
10876
  }
10835
10877
 
10836
10878
  /**
10879
+ * Rows exist for text and audio;
10880
+ *
10837
10881
  * @generated from message livekit.SimulationRun.JobMetrics.Turn
10838
10882
  */
10839
10883
  declare class SimulationRun_JobMetrics_Turn extends Message<SimulationRun_JobMetrics_Turn> {
@@ -10852,78 +10896,48 @@ declare class SimulationRun_JobMetrics_Turn extends Message<SimulationRun_JobMet
10852
10896
  role: ChatRole;
10853
10897
 
10854
10898
  /**
10855
- * relative to t0; unset if the turn could not be aligned to the audio
10899
+ * audio only; relative to t0; unset if the turn could not be aligned to the audio
10856
10900
  *
10857
10901
  * @generated from field: optional uint32 start_ms = 3;
10858
10902
  */
10859
10903
  startMs?: number;
10860
10904
 
10861
10905
  /**
10906
+ * audio only
10907
+ *
10862
10908
  * @generated from field: optional uint32 end_ms = 4;
10863
10909
  */
10864
10910
  endMs?: number;
10865
10911
 
10866
10912
  /**
10867
- * Agent-turn measurements; a negative response latency is a cut-in (the
10868
- * agent started before the caller's turn ended).
10913
+ * Job groups hold means/pools of these; a field with no per-turn measurement stays unset here.
10869
10914
  *
10870
- * @generated from field: optional int32 response_latency_ms = 5;
10871
- */
10872
- responseLatencyMs?: number;
10873
-
10874
- /**
10875
- * @generated from field: optional uint32 transcription_delay_ms = 6;
10876
- */
10877
- transcriptionDelayMs?: number;
10878
-
10879
- /**
10880
- * @generated from field: optional uint32 llm_ttft_ms = 7;
10881
- */
10882
- llmTtftMs?: number;
10883
-
10884
- /**
10885
- * @generated from field: optional uint32 llm_ttfs_ms = 8;
10886
- */
10887
- llmTtfsMs?: number;
10888
-
10889
- /**
10890
- * @generated from field: optional uint32 tts_ttfa_ms = 9;
10891
- */
10892
- ttsTtfaMs?: number;
10893
-
10894
- /**
10895
- * @generated from field: optional uint32 tts_ttfb_ms = 10;
10896
- */
10897
- ttsTtfbMs?: number;
10898
-
10899
- /**
10900
- * @generated from field: optional uint32 agent_reported_e2e_latency_ms = 11;
10901
- */
10902
- agentReportedE2eLatencyMs?: number;
10903
-
10904
- /**
10905
- * @generated from field: optional float conciseness_score = 12;
10915
+ * transcription_latency_ms
10916
+ *
10917
+ * @generated from field: livekit.SimulationRun.JobMetrics.STT stt = 5;
10906
10918
  */
10907
- concisenessScore?: number;
10919
+ stt?: SimulationRun_JobMetrics_STT;
10908
10920
 
10909
10921
  /**
10910
- * @generated from field: optional float naturalness_score = 13;
10922
+ * ttft_ms, ttfs_ms, tokens_per_second, conciseness_score
10923
+ *
10924
+ * @generated from field: livekit.SimulationRun.JobMetrics.LLM llm = 6;
10911
10925
  */
10912
- naturalnessScore?: number;
10926
+ llm?: SimulationRun_JobMetrics_LLM;
10913
10927
 
10914
10928
  /**
10915
- * judged 0-1: this turn's key entities audibly intact
10929
+ * ttfa_ms, ttfb_ms, naturalness_score, enunciation_score
10916
10930
  *
10917
- * @generated from field: optional float enunciation_score = 14;
10931
+ * @generated from field: livekit.SimulationRun.JobMetrics.TTS tts = 7;
10918
10932
  */
10919
- enunciationScore?: number;
10933
+ tts?: SimulationRun_JobMetrics_TTS;
10920
10934
 
10921
10935
  /**
10922
- * judge failure tags ("verbosity_or_filler", ...)
10936
+ * response_latency_ms, agent_yield_latency_ms, agent_reported_e2e_latency_ms, 0/1 counts
10923
10937
  *
10924
- * @generated from field: repeated string flags = 15;
10938
+ * @generated from field: livekit.SimulationRun.JobMetrics.Conversation conversation = 8;
10925
10939
  */
10926
- flags: string[];
10940
+ conversation?: SimulationRun_JobMetrics_Conversation;
10927
10941
 
10928
10942
  constructor(data?: PartialMessage<SimulationRun_JobMetrics_Turn>);
10929
10943