com.ibm.watson.speech_to_text.v1.model

Class ProcessingMetrics

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.speech_to_text.v1.model.ProcessingMetrics

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class ProcessingMetrics
extends com.ibm.cloud.sdk.core.service.model.GenericModel

If processing metrics are requested, information about the service's processing of the input audio. Processing metrics are not available with the synchronous **Recognize audio** method.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	periodic
protected ProcessedAudio	processedAudio
protected java.lang.Float	wallClockSinceFirstByteReceived

Constructor Summary

Constructors

Constructor and Description
ProcessingMetrics()

Method Summary

Methods

Modifier and Type	Method and Description
ProcessedAudio	getProcessedAudio() Gets the processedAudio.
java.lang.Float	getWallClockSinceFirstByteReceived() Gets the wallClockSinceFirstByteReceived.
java.lang.Boolean	isPeriodic() Gets the periodic.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

processedAudio

@SerializedName(value="processed_audio")
protected ProcessedAudio processedAudio

wallClockSinceFirstByteReceived

@SerializedName(value="wall_clock_since_first_byte_received")
protected java.lang.Float wallClockSinceFirstByteReceived

periodic

protected java.lang.Boolean periodic

Constructor Detail

ProcessingMetrics

public ProcessingMetrics()

Method Detail

getProcessedAudio

public ProcessedAudio getProcessedAudio()

Gets the processedAudio.

Detailed timing information about the service's processing of the input audio.

Returns:

the processedAudio

getWallClockSinceFirstByteReceived

public java.lang.Float getWallClockSinceFirstByteReceived()

Gets the wallClockSinceFirstByteReceived.

The amount of real time in seconds that has passed since the service received the first byte of input audio. Values in this field are generally multiples of the specified metrics interval, with two differences: * Values might not reflect exact intervals (for instance, 0.25, 0.5, and so on). Actual values might be 0.27, 0.52, and so on, depending on when the service receives and processes audio. * The service also returns values for transcription events if you set the `interim_results` parameter to `true`. The service returns both processing metrics and transcription results when such events occur.

Returns:

the wallClockSinceFirstByteReceived

isPeriodic

public java.lang.Boolean isPeriodic()

Gets the periodic.

An indication of whether the metrics apply to a periodic interval or a transcription event: * `true` means that the response was triggered by a specified processing interval. The information contains processing metrics only. * `false` means that the response was triggered by a transcription event. The information contains processing metrics plus transcription results.

Use the field to identify why the service generated the response and to filter different results if necessary.

Returns:

the periodic