com.google.api.services.speech.v1beta1.model.SpeechRecognitionAlternative Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2010 Google Inc.
 *
 * 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.
 */
/*
 * This code was generated by https://code.google.com/p/google-apis-client-generator/
 * (build: 2017-02-15 17:18:02 UTC)
 * on 2017-04-08 at 18:29:03 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.speech.v1beta1.model;

/**
 * Alternative hypotheses (a.k.a. n-best list).
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Google Cloud Speech API. For a detailed explanation
 * see:
 * http://code.google.com/p/google-http-java-client/wiki/JSON
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class SpeechRecognitionAlternative extends com.google.api.client.json.GenericJson {

  /**
   * *Output-only* The confidence estimate between 0.0 and 1.0. A higher number indicates an
   * estimated greater likelihood that the recognized words are correct. This field is typically
   * provided only for the top hypothesis, and only for `is_final=true` results. Clients should not
   * rely on the `confidence` field as it is not guaranteed to be accurate, or even set, in any of
   * the results. The default of 0.0 is a sentinel value indicating `confidence` was not set.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float confidence;

  /**
   * *Output-only* Transcript text representing the words that the user spoke.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String transcript;

  /**
   * *Output-only* The confidence estimate between 0.0 and 1.0. A higher number indicates an
   * estimated greater likelihood that the recognized words are correct. This field is typically
   * provided only for the top hypothesis, and only for `is_final=true` results. Clients should not
   * rely on the `confidence` field as it is not guaranteed to be accurate, or even set, in any of
   * the results. The default of 0.0 is a sentinel value indicating `confidence` was not set.
   * @return value or {@code null} for none
   */
  public java.lang.Float getConfidence() {
    return confidence;
  }

  /**
   * *Output-only* The confidence estimate between 0.0 and 1.0. A higher number indicates an
   * estimated greater likelihood that the recognized words are correct. This field is typically
   * provided only for the top hypothesis, and only for `is_final=true` results. Clients should not
   * rely on the `confidence` field as it is not guaranteed to be accurate, or even set, in any of
   * the results. The default of 0.0 is a sentinel value indicating `confidence` was not set.
   * @param confidence confidence or {@code null} for none
   */
  public SpeechRecognitionAlternative setConfidence(java.lang.Float confidence) {
    this.confidence = confidence;
    return this;
  }

  /**
   * *Output-only* Transcript text representing the words that the user spoke.
   * @return value or {@code null} for none
   */
  public java.lang.String getTranscript() {
    return transcript;
  }

  /**
   * *Output-only* Transcript text representing the words that the user spoke.
   * @param transcript transcript or {@code null} for none
   */
  public SpeechRecognitionAlternative setTranscript(java.lang.String transcript) {
    this.transcript = transcript;
    return this;
  }

  @Override
  public SpeechRecognitionAlternative set(String fieldName, Object value) {
    return (SpeechRecognitionAlternative) super.set(fieldName, value);
  }

  @Override
  public SpeechRecognitionAlternative clone() {
    return (SpeechRecognitionAlternative) super.clone();
  }

}