com.ibm.watson.speech_to_text.v1.model

Class SpeechRecognitionResults

java.lang.Object

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

com.ibm.watson.speech_to_text.v1.model.SpeechRecognitionResults

All Implemented Interfaces:

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

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

The complete results for a speech recognition request.

Method Summary

Modifier and Type	Method and Description
AudioMetrics	getAudioMetrics() Gets the audioMetrics.
ProcessingMetrics	getProcessingMetrics() Gets the processingMetrics.
Long	getResultIndex() Gets the resultIndex.
List<SpeechRecognitionResult>	getResults() Gets the results.
List<SpeakerLabelsResult>	getSpeakerLabels() Gets the speakerLabels.
List<String>	getWarnings() Gets the warnings.

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

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getResults

public List<SpeechRecognitionResult> getResults()

Gets the results.

An array of `SpeechRecognitionResult` objects that can include interim and final results (interim results are returned only if supported by the method). Final results are guaranteed not to change; interim results might be replaced by further interim results and eventually final results.

For the HTTP interfaces, all results arrive at the same time. For the WebSocket interface, results can be sent as multiple separate responses. The service periodically sends updates to the results list. The `result_index` is incremented to the lowest index in the array that has changed for new results.

For more information, see [Understanding speech recognition results](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-basic-response).

Returns:

the results

getResultIndex

public Long getResultIndex()

Gets the resultIndex.

An index that indicates a change point in the `results` array. The service increments the index for additional results that it sends for new audio for the same request. All results with the same index are delivered at the same time. The same index can include multiple final results that are delivered with the same response.

Returns:

the resultIndex

getSpeakerLabels

public List<SpeakerLabelsResult> getSpeakerLabels()

Gets the speakerLabels.

An array of `SpeakerLabelsResult` objects that identifies which words were spoken by which speakers in a multi-person exchange. The array is returned only if the `speaker_labels` parameter is `true`. When interim results are also requested for methods that support them, it is possible for a `SpeechRecognitionResults` object to include only the `speaker_labels` field.

Returns:

the speakerLabels

getProcessingMetrics

public ProcessingMetrics getProcessingMetrics()

Gets the processingMetrics.

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](#recognize) method.

Returns:

the processingMetrics

getAudioMetrics

public AudioMetrics getAudioMetrics()

Gets the audioMetrics.

If audio metrics are requested, information about the signal characteristics of the input audio.

Returns:

the audioMetrics

getWarnings

public List<String> getWarnings()

Gets the warnings.

An array of warning messages associated with the request: * Warnings for invalid parameters or fields can include a descriptive message and a list of invalid argument strings, for example, `"Unknown arguments:"` or `"Unknown url query arguments:"` followed by a list of the form `"{invalid_arg_1}, {invalid_arg_2}."` (If you use the `character_insertion_bias` parameter with a previous-generation model, the warning message refers to the parameter as `lambdaBias`.) * The following warning is returned if the request passes a custom model that is based on an older version of a base model for which an updated version is available: `"Using previous version of base model, because your custom model has been built with it. Please note that this version will be supported only for a limited time. Consider updating your custom model to the new base model. If you do not do that you will be automatically switched to base model when you used the non-updated custom model."`

In both cases, the request succeeds despite the warnings.

Returns:

the warnings