Class: Google::Apis::SpeechV2beta1::WordInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/speech_v2beta1/classes.rb,
generated/google/apis/speech_v2beta1/representations.rb,
generated/google/apis/speech_v2beta1/representations.rb

Overview

Word-specific information for recognized words.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ WordInfo

Returns a new instance of WordInfo.



341
342
343
 
# File 'generated/google/apis/speech_v2beta1/classes.rb', line 341

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#confidence ⇒ Float

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 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. Corresponds to the JSON property confidence

Returns:

  • (Float) 


304
305
306
 
# File 'generated/google/apis/speech_v2beta1/classes.rb', line 304

def confidence
  @confidence
end

#end_offset ⇒ String

Output only. 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. Corresponds to the JSON property endOffset

Returns:

  • (String) 


314
315
316
 
# File 'generated/google/apis/speech_v2beta1/classes.rb', line 314

def end_offset
  @end_offset
end

#speaker_tag ⇒ Fixnum

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_config.max_speaker_count . speaker_tag is set if diarization_config.enable_speaker_diarization = true and only in the top alternative. Corresponds to the JSON property speakerTag

Returns:

  • (Fixnum) 


324
325
326
 
# File 'generated/google/apis/speech_v2beta1/classes.rb', line 324

def speaker_tag
  @speaker_tag
end

#start_offset ⇒ String

Output only. 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. Corresponds to the JSON property startOffset

Returns:

  • (String) 


334
335
336
 
# File 'generated/google/apis/speech_v2beta1/classes.rb', line 334

def start_offset
  @start_offset
end

#word ⇒ String

Output only. The word corresponding to this set of information. Corresponds to the JSON property word

Returns:

  • (String) 


339
340
341
 
# File 'generated/google/apis/speech_v2beta1/classes.rb', line 339

def word
  @word
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



346
347
348
349
350
351
352
 
# File 'generated/google/apis/speech_v2beta1/classes.rb', line 346

def update!(**args)
  @confidence = args[:confidence] if args.key?(:confidence)
  @end_offset = args[:end_offset] if args.key?(:end_offset)
  @speaker_tag = args[:speaker_tag] if args.key?(:speaker_tag)
  @start_offset = args[:start_offset] if args.key?(:start_offset)
  @word = args[:word] if args.key?(:word)
end