com.google.cloud.speech.v1.WordInfoOrBuilder 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 WordInfoOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.speech.v1.WordInfo)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Time offset relative to the beginning of the audio,
   * and corresponding to the start of the spoken word.
   * This field is only set if `enable_word_time_offsets=true` and only
   * in the top hypothesis.
   * This is an experimental feature and the accuracy of the time offset can
   * vary.
   * 
   *
   * .google.protobuf.Duration start_time = 1;
   *
   * @return Whether the startTime field is set.
   */
  boolean hasStartTime();
  /**
   *
   *
   *    * Time offset relative to the beginning of the audio,
   * and corresponding to the start of the spoken word.
   * This field is only set if `enable_word_time_offsets=true` and only
   * in the top hypothesis.
   * This is an experimental feature and the accuracy of the time offset can
   * vary.
   * 
   *
   * .google.protobuf.Duration start_time = 1;
   *
   * @return The startTime.
   */
  com.google.protobuf.Duration getStartTime();
  /**
   *
   *
   *    * Time offset relative to the beginning of the audio,
   * and corresponding to the start of the spoken word.
   * This field is only set if `enable_word_time_offsets=true` and only
   * in the top hypothesis.
   * This is an experimental feature and the accuracy of the time offset can
   * vary.
   * 
   *
   * .google.protobuf.Duration start_time = 1;
   */
  com.google.protobuf.DurationOrBuilder getStartTimeOrBuilder();

  /**
   *
   *
   *    * Time offset relative to the beginning of the audio,
   * and corresponding to the end of the spoken word.
   * This field is only set if `enable_word_time_offsets=true` and only
   * in the top hypothesis.
   * This is an experimental feature and the accuracy of the time offset can
   * vary.
   * 
   *
   * .google.protobuf.Duration end_time = 2;
   *
   * @return Whether the endTime field is set.
   */
  boolean hasEndTime();
  /**
   *
   *
   *    * Time offset relative to the beginning of the audio,
   * and corresponding to the end of the spoken word.
   * This field is only set if `enable_word_time_offsets=true` and only
   * in the top hypothesis.
   * This is an experimental feature and the accuracy of the time offset can
   * vary.
   * 
   *
   * .google.protobuf.Duration end_time = 2;
   *
   * @return The endTime.
   */
  com.google.protobuf.Duration getEndTime();
  /**
   *
   *
   *    * Time offset relative to the beginning of the audio,
   * and corresponding to the end of the spoken word.
   * This field is only set if `enable_word_time_offsets=true` and only
   * in the top hypothesis.
   * This is an experimental feature and the accuracy of the time offset can
   * vary.
   * 
   *
   * .google.protobuf.Duration end_time = 2;
   */
  com.google.protobuf.DurationOrBuilder getEndTimeOrBuilder();

  /**
   *
   *
   *    * The word corresponding to this set of information.
   * 
   *
   * string word = 3;
   *
   * @return The word.
   */
  java.lang.String getWord();
  /**
   *
   *
   *    * The word corresponding to this set of information.
   * 
   *
   * string word = 3;
   *
   * @return The bytes for word.
   */
  com.google.protobuf.ByteString getWordBytes();

  /**
   *
   *
   *    * 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 set only for the top alternative of a non-streaming
   * result or, of a streaming result where `is_final=true`.
   * This field is not guaranteed to be accurate and users should not rely on it
   * to be always provided.
   * The default of 0.0 is a sentinel value indicating `confidence` was not set.
   * 
   *
   * float confidence = 4;
   *
   * @return The confidence.
   */
  float getConfidence();

  /**
   *
   *
   *    * Output only. A distinct integer value is assigned for every speaker within
   * the audio. This field specifies which one of those speakers was detected to
   * have spoken this word. Value ranges from '1' to diarization_speaker_count.
   * speaker_tag is set if enable_speaker_diarization = 'true' and only for the
   * top alternative.
   * Note: Use speaker_label instead.
   * 
   *
   * int32 speaker_tag = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @deprecated google.cloud.speech.v1.WordInfo.speaker_tag is deprecated. See
   *     google/cloud/speech/v1/cloud_speech.proto;l=974
   * @return The speakerTag.
   */
  @java.lang.Deprecated
  int getSpeakerTag();

  /**
   *
   *
   *    * Output only. A label value assigned for every unique speaker within the
   * audio. This field specifies which speaker was detected to have spoken this
   * word. For some models, like medical_conversation this can be actual speaker
   * role, for example "patient" or "provider", but generally this would be a
   * number identifying a speaker. This field is only set if
   * enable_speaker_diarization = 'true' and only for the top alternative.
   * 
   *
   * string speaker_label = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The speakerLabel.
   */
  java.lang.String getSpeakerLabel();
  /**
   *
   *
   *    * Output only. A label value assigned for every unique speaker within the
   * audio. This field specifies which speaker was detected to have spoken this
   * word. For some models, like medical_conversation this can be actual speaker
   * role, for example "patient" or "provider", but generally this would be a
   * number identifying a speaker. This field is only set if
   * enable_speaker_diarization = 'true' and only for the top alternative.
   * 
   *
   * string speaker_label = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The bytes for speakerLabel.
   */
  com.google.protobuf.ByteString getSpeakerLabelBytes();
}