com.google.cloud.speech.v1.StreamingRecognitionResultOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-speech-v1 Show documentation
PROTO library for proto-google-cloud-speech-v1
There is a newer version: 4.49.0
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/speech/v1/cloud_speech.proto

// Protobuf Java Version: 3.25.3
package com.google.cloud.speech.v1;

public interface StreamingRecognitionResultOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.speech.v1.StreamingRecognitionResult)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * May contain one or more recognition hypotheses (up to the
   * maximum specified in `max_alternatives`).
   * These alternatives are ordered in terms of accuracy, with the top (first)
   * alternative being the most probable, as ranked by the recognizer.
   * 
   *
   * repeated .google.cloud.speech.v1.SpeechRecognitionAlternative alternatives = 1;
   */
  java.util.List getAlternativesList();
  /**
   *
   *
   *    * May contain one or more recognition hypotheses (up to the
   * maximum specified in `max_alternatives`).
   * These alternatives are ordered in terms of accuracy, with the top (first)
   * alternative being the most probable, as ranked by the recognizer.
   * 
   *
   * repeated .google.cloud.speech.v1.SpeechRecognitionAlternative alternatives = 1;
   */
  com.google.cloud.speech.v1.SpeechRecognitionAlternative getAlternatives(int index);
  /**
   *
   *
   *    * May contain one or more recognition hypotheses (up to the
   * maximum specified in `max_alternatives`).
   * These alternatives are ordered in terms of accuracy, with the top (first)
   * alternative being the most probable, as ranked by the recognizer.
   * 
   *
   * repeated .google.cloud.speech.v1.SpeechRecognitionAlternative alternatives = 1;
   */
  int getAlternativesCount();
  /**
   *
   *
   *    * May contain one or more recognition hypotheses (up to the
   * maximum specified in `max_alternatives`).
   * These alternatives are ordered in terms of accuracy, with the top (first)
   * alternative being the most probable, as ranked by the recognizer.
   * 
   *
   * repeated .google.cloud.speech.v1.SpeechRecognitionAlternative alternatives = 1;
   */
  java.util.List
      getAlternativesOrBuilderList();
  /**
   *
   *
   *    * May contain one or more recognition hypotheses (up to the
   * maximum specified in `max_alternatives`).
   * These alternatives are ordered in terms of accuracy, with the top (first)
   * alternative being the most probable, as ranked by the recognizer.
   * 
   *
   * repeated .google.cloud.speech.v1.SpeechRecognitionAlternative alternatives = 1;
   */
  com.google.cloud.speech.v1.SpeechRecognitionAlternativeOrBuilder getAlternativesOrBuilder(
      int index);

  /**
   *
   *
   *    * If `false`, this `StreamingRecognitionResult` represents an
   * interim result that may change. If `true`, this is the final time the
   * speech service will return this particular `StreamingRecognitionResult`,
   * the recognizer will not return any further hypotheses for this portion of
   * the transcript and corresponding audio.
   * 
   *
   * bool is_final = 2;
   *
   * @return The isFinal.
   */
  boolean getIsFinal();

  /**
   *
   *
   *    * An estimate of the likelihood that the recognizer will not
   * change its guess about this interim result. Values range from 0.0
   * (completely unstable) to 1.0 (completely stable).
   * This field is only provided for interim results (`is_final=false`).
   * The default of 0.0 is a sentinel value indicating `stability` was not set.
   * 
   *
   * float stability = 3;
   *
   * @return The stability.
   */
  float getStability();

  /**
   *
   *
   *    * Time offset of the end of this result relative to the
   * beginning of the audio.
   * 
   *
   * .google.protobuf.Duration result_end_time = 4;
   *
   * @return Whether the resultEndTime field is set.
   */
  boolean hasResultEndTime();
  /**
   *
   *
   *    * Time offset of the end of this result relative to the
   * beginning of the audio.
   * 
   *
   * .google.protobuf.Duration result_end_time = 4;
   *
   * @return The resultEndTime.
   */
  com.google.protobuf.Duration getResultEndTime();
  /**
   *
   *
   *    * Time offset of the end of this result relative to the
   * beginning of the audio.
   * 
   *
   * .google.protobuf.Duration result_end_time = 4;
   */
  com.google.protobuf.DurationOrBuilder getResultEndTimeOrBuilder();

  /**
   *
   *
   *    * For multi-channel audio, this is the channel number corresponding to the
   * recognized result for the audio from that channel.
   * For audio_channel_count = N, its output values can range from '1' to 'N'.
   * 
   *
   * int32 channel_tag = 5;
   *
   * @return The channelTag.
   */
  int getChannelTag();

  /**
   *
   *
   *    * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
   * language tag of the language in this result. This language code was
   * detected to have the most likelihood of being spoken in the audio.
   * 
   *
   * string language_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The languageCode.
   */
  java.lang.String getLanguageCode();
  /**
   *
   *
   *    * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt)
   * language tag of the language in this result. This language code was
   * detected to have the most likelihood of being spoken in the audio.
   * 
   *
   * string language_code = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The bytes for languageCode.
   */
  com.google.protobuf.ByteString getLanguageCodeBytes();
}