Documentation

STT extends Message
in package

The agent's perception of the caller.

Generated from protobuf message livekit.SimulationRun.JobMetrics.STT

Table of Contents

Properties

$cer  : mixed
character error rate, pooled
$keyterm_recall  : mixed
recall of uttered key entities (names, IDs, amounts)
$keyterms_recognized  : mixed
Generated from protobuf field <code>optional uint32 keyterms_recognized = 7;</code>
$keyterms_uttered  : mixed
Generated from protobuf field <code>optional uint32 keyterms_uttered = 6;</code>
$transcription_latency_ms  : mixed
agent-reported STT/endpointing delay, mean
$wer  : mixed
word error rate, pooled: word_errors / words
$word_errors  : mixed
Generated from protobuf field <code>optional uint32 word_errors = 3;</code>
$words  : mixed
pooling stats: run WER = sum errors / sum words

Methods

__construct()  : mixed
Constructor.
clearCer()  : mixed
clearKeytermRecall()  : mixed
clearKeytermsRecognized()  : mixed
clearKeytermsUttered()  : mixed
clearTranscriptionLatencyMs()  : mixed
clearWer()  : mixed
clearWordErrors()  : mixed
clearWords()  : mixed
getCer()  : float
character error rate, pooled
getKeytermRecall()  : float
recall of uttered key entities (names, IDs, amounts)
getKeytermsRecognized()  : int
Generated from protobuf field <code>optional uint32 keyterms_recognized = 7;</code>
getKeytermsUttered()  : int
Generated from protobuf field <code>optional uint32 keyterms_uttered = 6;</code>
getTranscriptionLatencyMs()  : int
agent-reported STT/endpointing delay, mean
getWer()  : float
word error rate, pooled: word_errors / words
getWordErrors()  : int
Generated from protobuf field <code>optional uint32 word_errors = 3;</code>
getWords()  : int
pooling stats: run WER = sum errors / sum words
hasCer()  : mixed
hasKeytermRecall()  : mixed
hasKeytermsRecognized()  : mixed
hasKeytermsUttered()  : mixed
hasTranscriptionLatencyMs()  : mixed
hasWer()  : mixed
hasWordErrors()  : mixed
hasWords()  : mixed
setCer()  : $this
character error rate, pooled
setKeytermRecall()  : $this
recall of uttered key entities (names, IDs, amounts)
setKeytermsRecognized()  : $this
Generated from protobuf field <code>optional uint32 keyterms_recognized = 7;</code>
setKeytermsUttered()  : $this
Generated from protobuf field <code>optional uint32 keyterms_uttered = 6;</code>
setTranscriptionLatencyMs()  : $this
agent-reported STT/endpointing delay, mean
setWer()  : $this
word error rate, pooled: word_errors / words
setWordErrors()  : $this
Generated from protobuf field <code>optional uint32 word_errors = 3;</code>
setWords()  : $this
pooling stats: run WER = sum errors / sum words

Properties

$cer

character error rate, pooled

protected mixed $cer = null

Generated from protobuf field optional float cer = 4;

$keyterm_recall

recall of uttered key entities (names, IDs, amounts)

protected mixed $keyterm_recall = null

Generated from protobuf field optional float keyterm_recall = 5;

$keyterms_recognized

Generated from protobuf field <code>optional uint32 keyterms_recognized = 7;</code>

protected mixed $keyterms_recognized = null

$keyterms_uttered

Generated from protobuf field <code>optional uint32 keyterms_uttered = 6;</code>

protected mixed $keyterms_uttered = null

$transcription_latency_ms

agent-reported STT/endpointing delay, mean

protected mixed $transcription_latency_ms = null

Generated from protobuf field optional uint32 transcription_latency_ms = 8;

$wer

word error rate, pooled: word_errors / words

protected mixed $wer = null

Generated from protobuf field optional float wer = 1;

$word_errors

Generated from protobuf field <code>optional uint32 word_errors = 3;</code>

protected mixed $word_errors = null

$words

pooling stats: run WER = sum errors / sum words

protected mixed $words = null

Generated from protobuf field optional uint32 words = 2;

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type float $wer
      word error rate, pooled: word_errors / words
@type int $words
      pooling stats: run WER = sum errors / sum words
@type int $word_errors
@type float $cer
      character error rate, pooled
@type float $keyterm_recall
      recall of uttered key entities (names, IDs, amounts)
@type int $keyterms_uttered
@type int $keyterms_recognized
@type int $transcription_latency_ms
      agent-reported STT/endpointing delay, mean

}

clearCer()

public clearCer() : mixed

clearKeytermRecall()

public clearKeytermRecall() : mixed

clearKeytermsRecognized()

public clearKeytermsRecognized() : mixed

clearKeytermsUttered()

public clearKeytermsUttered() : mixed

clearTranscriptionLatencyMs()

public clearTranscriptionLatencyMs() : mixed

clearWer()

public clearWer() : mixed

clearWordErrors()

public clearWordErrors() : mixed

clearWords()

public clearWords() : mixed

getCer()

character error rate, pooled

public getCer() : float

Generated from protobuf field optional float cer = 4;

Return values
float

getKeytermRecall()

recall of uttered key entities (names, IDs, amounts)

public getKeytermRecall() : float

Generated from protobuf field optional float keyterm_recall = 5;

Return values
float

getKeytermsRecognized()

Generated from protobuf field <code>optional uint32 keyterms_recognized = 7;</code>

public getKeytermsRecognized() : int
Return values
int

getKeytermsUttered()

Generated from protobuf field <code>optional uint32 keyterms_uttered = 6;</code>

public getKeytermsUttered() : int
Return values
int

getTranscriptionLatencyMs()

agent-reported STT/endpointing delay, mean

public getTranscriptionLatencyMs() : int

Generated from protobuf field optional uint32 transcription_latency_ms = 8;

Return values
int

getWer()

word error rate, pooled: word_errors / words

public getWer() : float

Generated from protobuf field optional float wer = 1;

Return values
float

getWordErrors()

Generated from protobuf field <code>optional uint32 word_errors = 3;</code>

public getWordErrors() : int
Return values
int

getWords()

pooling stats: run WER = sum errors / sum words

public getWords() : int

Generated from protobuf field optional uint32 words = 2;

Return values
int

hasCer()

public hasCer() : mixed

hasKeytermRecall()

public hasKeytermRecall() : mixed

hasKeytermsRecognized()

public hasKeytermsRecognized() : mixed

hasKeytermsUttered()

public hasKeytermsUttered() : mixed

hasTranscriptionLatencyMs()

public hasTranscriptionLatencyMs() : mixed

hasWer()

public hasWer() : mixed

hasWordErrors()

public hasWordErrors() : mixed

hasWords()

public hasWords() : mixed

setCer()

character error rate, pooled

public setCer(float $var) : $this

Generated from protobuf field optional float cer = 4;

Parameters
$var : float
Return values
$this

setKeytermRecall()

recall of uttered key entities (names, IDs, amounts)

public setKeytermRecall(float $var) : $this

Generated from protobuf field optional float keyterm_recall = 5;

Parameters
$var : float
Return values
$this

setKeytermsRecognized()

Generated from protobuf field <code>optional uint32 keyterms_recognized = 7;</code>

public setKeytermsRecognized(int $var) : $this
Parameters
$var : int
Return values
$this

setKeytermsUttered()

Generated from protobuf field <code>optional uint32 keyterms_uttered = 6;</code>

public setKeytermsUttered(int $var) : $this
Parameters
$var : int
Return values
$this

setTranscriptionLatencyMs()

agent-reported STT/endpointing delay, mean

public setTranscriptionLatencyMs(int $var) : $this

Generated from protobuf field optional uint32 transcription_latency_ms = 8;

Parameters
$var : int
Return values
$this

setWer()

word error rate, pooled: word_errors / words

public setWer(float $var) : $this

Generated from protobuf field optional float wer = 1;

Parameters
$var : float
Return values
$this

setWordErrors()

Generated from protobuf field <code>optional uint32 word_errors = 3;</code>

public setWordErrors(int $var) : $this
Parameters
$var : int
Return values
$this

setWords()

pooling stats: run WER = sum errors / sum words

public setWords(int $var) : $this

Generated from protobuf field optional uint32 words = 2;

Parameters
$var : int
Return values
$this
On this page

Search results