Class: Google::Cloud::VideoIntelligence::V1::WordInfo

Inherits:

Object

• Object
• Google::Cloud::VideoIntelligence::V1::WordInfo

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/videointelligence/v1/video_intelligence.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

• #confidence ⇒ ::Float readonly

  Output only.

• #end_time ⇒ ::Google::Protobuf::Duration

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

• #speaker_tag ⇒ ::Integer readonly

  Output only.

• #start_time ⇒ ::Google::Protobuf::Duration

  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 Attribute Details

#confidence ⇒ ::Float (readonly)

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

Returns:

• (::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.

# File 'proto_docs/google/cloud/videointelligence/v1/video_intelligence.rb', line 768

class WordInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#end_time ⇒ ::Google::Protobuf::Duration

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

Returns:

• (::Google::Protobuf::Duration) —

  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.

# File 'proto_docs/google/cloud/videointelligence/v1/video_intelligence.rb', line 768

class WordInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#speaker_tag ⇒ ::Integer (readonly)

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

Returns:

• (::Integer) —

  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.

# File 'proto_docs/google/cloud/videointelligence/v1/video_intelligence.rb', line 768

class WordInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#start_time ⇒ ::Google::Protobuf::Duration

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

Returns:

• (::Google::Protobuf::Duration) —

  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.

# File 'proto_docs/google/cloud/videointelligence/v1/video_intelligence.rb', line 768

class WordInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#word ⇒ ::String

Returns The word corresponding to this set of information.

Returns:

• (::String) —

  The word corresponding to this set of information.

# File 'proto_docs/google/cloud/videointelligence/v1/video_intelligence.rb', line 768

class WordInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end