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

Inherits:

Object

• Object
• Google::Apis::SpeechV1::WordInfo

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

Overview

Word-specific information for recognized words.

Instance Attribute Summary

• #confidence ⇒ Float

  The confidence estimate between 0.0 and 1.0.

• #end_time ⇒ String

  Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word.

• #speaker_label ⇒ String

  Output only.

• #speaker_tag ⇒ Fixnum

  Output only.

• #start_time ⇒ String

  Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word.

• #word ⇒ String

  The word corresponding to this set of information.

Instance Method Summary

• #initialize(**args) ⇒ WordInfo constructor

  A new instance of WordInfo.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ WordInfo

Returns a new instance of WordInfo.

# File 'lib/google/apis/speech_v1/classes.rb', line 1316

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

Instance Attribute Details

#confidence ⇒ Float

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)

# File 'lib/google/apis/speech_v1/classes.rb', line 1274

def confidence
  @confidence
end

#end_time ⇒ String

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)

# File 'lib/google/apis/speech_v1/classes.rb', line 1282

def end_time
  @end_time
end

#speaker_label ⇒ String

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

Returns:

• (String)

# File 'lib/google/apis/speech_v1/classes.rb', line 1292

def speaker_label
  @speaker_label
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_speaker_count. speaker_tag is set if enable_speaker_diarization = 'true' and only for the top alternative. Note: Use speaker_label instead. Corresponds to the JSON property speakerTag

Returns:

• (Fixnum)

# File 'lib/google/apis/speech_v1/classes.rb', line 1301

def speaker_tag
  @speaker_tag
end

#start_time ⇒ String

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)

# File 'lib/google/apis/speech_v1/classes.rb', line 1309

def start_time
  @start_time
end

#word ⇒ String

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

Returns:

• (String)

# File 'lib/google/apis/speech_v1/classes.rb', line 1314

def word
  @word
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/speech_v1/classes.rb', line 1321

def update!(**args)
  @confidence = args[:confidence] if args.key?(:confidence)
  @end_time = args[:end_time] if args.key?(:end_time)
  @speaker_label = args[:speaker_label] if args.key?(:speaker_label)
  @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