com.ibm.watson.speech_to_text.v1.model.SpeechRecognitionResults Maven / Gradle / Ivy

Go to download
/*
 * (C) Copyright IBM Corp. 2018, 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package com.ibm.watson.speech_to_text.v1.model;

import com.google.gson.annotations.SerializedName;
import com.ibm.cloud.sdk.core.service.model.GenericModel;
import java.util.List;

/** The complete results for a speech recognition request. */
public class SpeechRecognitionResults extends GenericModel {

  protected List results;

  @SerializedName("result_index")
  protected Long resultIndex;

  @SerializedName("speaker_labels")
  protected List speakerLabels;

  @SerializedName("processing_metrics")
  protected ProcessingMetrics processingMetrics;

  @SerializedName("audio_metrics")
  protected AudioMetrics audioMetrics;

  protected List warnings;

  /**
   * 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 final results.
   * The service periodically sends updates to the results list; the `result_index` is set to the
   * lowest index in the array that has changed; it is incremented for new results.
   *
   * @return the results
   */
  public List getResults() {
    return results;
  }

  /**
   * Gets the resultIndex.
   *
   * 
An index that indicates a change point in the `results` array. The service increments the
   * index only for additional results that it sends for new audio for the same request.
   *
   * @return the resultIndex
   */
  public Long getResultIndex() {
    return resultIndex;
  }

  /**
   * 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.
   *
   * @return the speakerLabels
   */
  public List getSpeakerLabels() {
    return speakerLabels;
  }

  /**
   * 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** method.
   *
   * @return the processingMetrics
   */
  public ProcessingMetrics getProcessingMetrics() {
    return processingMetrics;
  }

  /**
   * Gets the audioMetrics.
   *
   * 
If audio metrics are requested, information about the signal characteristics of the input
   * audio.
   *
   * @return the audioMetrics
   */
  public AudioMetrics getAudioMetrics() {
    return audioMetrics;
  }

  /**
   * 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}."` * 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.
   *
   * @return the warnings
   */
  public List getWarnings() {
    return warnings;
  }
}