Class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1WordInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/videointelligence_v1p1beta1/classes.rb,
generated/google/apis/videointelligence_v1p1beta1/representations.rb,
generated/google/apis/videointelligence_v1p1beta1/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudVideointelligenceV1p1beta1WordInfo

Returns a new instance of GoogleCloudVideointelligenceV1p1beta1WordInfo.



2846
2847
2848
 
# File 'generated/google/apis/videointelligence_v1p1beta1/classes.rb', line 2846

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) 


2815
2816
2817
 
# File 'generated/google/apis/videointelligence_v1p1beta1/classes.rb', line 2815

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) 


2823
2824
2825
 
# File 'generated/google/apis/videointelligence_v1p1beta1/classes.rb', line 2823

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) 


2831
2832
2833
 
# File 'generated/google/apis/videointelligence_v1p1beta1/classes.rb', line 2831

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) 


2839
2840
2841
 
# File 'generated/google/apis/videointelligence_v1p1beta1/classes.rb', line 2839

def start_time
  @start_time
end

#word ⇒ String

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

Returns:

  • (String) 


2844
2845
2846
 
# File 'generated/google/apis/videointelligence_v1p1beta1/classes.rb', line 2844

def word
  @word
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2851
2852
2853
2854
2855
2856
2857
 
# File 'generated/google/apis/videointelligence_v1p1beta1/classes.rb', line 2851

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