Class: Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1WordInfo

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

Overview

Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as enable_word_time_offsets.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudVideointelligenceV1p3beta1WordInfo

Returns a new instance of GoogleCloudVideointelligenceV1p3beta1WordInfo.



6410
6411
6412
 
# File 'generated/google/apis/videointelligence_v1p3beta1/classes.rb', line 6410

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. 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) 


6379
6380
6381
 
# File 'generated/google/apis/videointelligence_v1p3beta1/classes.rb', line 6379

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) 


6387
6388
6389
 
# File 'generated/google/apis/videointelligence_v1p3beta1/classes.rb', line 6387

def end_time
  @end_time
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 up to diarization_speaker_count, and is only set if speaker diarization is enabled. Corresponds to the JSON property speakerTag

Returns:

  • (Fixnum) 


6395
6396
6397
 
# File 'generated/google/apis/videointelligence_v1p3beta1/classes.rb', line 6395

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) 


6403
6404
6405
 
# File 'generated/google/apis/videointelligence_v1p3beta1/classes.rb', line 6403

def start_time
  @start_time
end

#word ⇒ String

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

Returns:

  • (String) 


6408
6409
6410
 
# File 'generated/google/apis/videointelligence_v1p3beta1/classes.rb', line 6408

def word
  @word
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6415
6416
6417
6418
6419
6420
6421
 
# File 'generated/google/apis/videointelligence_v1p3beta1/classes.rb', line 6415

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