Class: Google::Apis::SpeechV1::WordInfo

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

Overview

Word-specific information for recognized words.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WordInfo

Returns a new instance of WordInfo.

[View source]

1268
1269
1270
# File 'lib/google/apis/speech_v1/classes.rb', line 1268

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

Instance Attribute Details

#confidenceFloat

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)

1236
1237
1238
# File 'lib/google/apis/speech_v1/classes.rb', line 1236

def confidence
  @confidence
end

#end_timeString

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 endTime

Returns:

  • (String)

1244
1245
1246
# File 'lib/google/apis/speech_v1/classes.rb', line 1244

def end_time
  @end_time
end

#speaker_tagFixnum

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 in the top alternative. Corresponds to the JSON property speakerTag

Returns:

  • (Fixnum)

1253
1254
1255
# File 'lib/google/apis/speech_v1/classes.rb', line 1253

def speaker_tag
  @speaker_tag
end

#start_timeString

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 startTime

Returns:

  • (String)

1261
1262
1263
# File 'lib/google/apis/speech_v1/classes.rb', line 1261

def start_time
  @start_time
end

#wordString

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

Returns:

  • (String)

1266
1267
1268
# File 'lib/google/apis/speech_v1/classes.rb', line 1266

def word
  @word
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1273
1274
1275
1276
1277
1278
1279
# File 'lib/google/apis/speech_v1/classes.rb', line 1273

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