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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of speech-to-text Show documentation

Java client library to use the IBM Speech to Text API

There is a newer version: 13.0.0

/*
 * (C) Copyright IBM Corp. 2019.
 *
 * 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 java.util.List;
import java.util.Map;

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

/**
 * Component results for a speech recognition request.
 */
public class SpeechRecognitionResult extends GenericModel {

  @SerializedName("final")
  private Boolean xFinal;
  private List alternatives;
  @SerializedName("keywords_result")
  private Map> keywordsResult;
  @SerializedName("word_alternatives")
  private List wordAlternatives;

  /**
   * Gets the xFinal.
   *
   * An indication of whether the transcription results are final. If `true`, the results for this utterance are not
   * updated further; no additional results are sent for a `result_index` once its results are indicated as final.
   *
   * @return the xFinal
   */
  public Boolean isXFinal() {
    return xFinal;
  }

  /**
   * Gets the alternatives.
   *
   * An array of alternative transcripts. The `alternatives` array can include additional requested output such as word
   * confidence or timestamps.
   *
   * @return the alternatives
   */
  public List getAlternatives() {
    return alternatives;
  }

  /**
   * Gets the keywordsResult.
   *
   * A dictionary (or associative array) whose keys are the strings specified for `keywords` if both that parameter and
   * `keywords_threshold` are specified. The value for each key is an array of matches spotted in the audio for that
   * keyword. Each match is described by a `KeywordResult` object. A keyword for which no matches are found is omitted
   * from the dictionary. The dictionary is omitted entirely if no matches are found for any keywords.
   *
   * @return the keywordsResult
   */
  public Map> getKeywordsResult() {
    return keywordsResult;
  }

  /**
   * Gets the wordAlternatives.
   *
   * An array of alternative hypotheses found for words of the input audio if a `word_alternatives_threshold` is
   * specified.
   *
   * @return the wordAlternatives
   */
  public List getWordAlternatives() {
    return wordAlternatives;
  }
}