Class: Google::Cloud::Speech::InterimResult

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/speech/result.rb

Overview

# InterimResult

A streaming speech recognition result corresponding to a portion of the audio that is currently being processed.

See Project#stream and Stream#on_interim.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = audio.stream encoding: :raw, sample_rate: 16000

# register callback for when an interim result is returned
stream.on_interim do |final_results, interim_results|
  interim_result = interim_results.first
  puts interim_result.transcript # "how old is the Brooklyn Bridge"
  puts interim_result.confidence # 0.9826789498329163
  puts interim_result.stability # 0.8999
end

# Stream 5 seconds of audio from the microhone
# Actual implementation of microphone input varies by platform
5.times.do
  stream.send MicrophoneInput.read(32000)
end

stream.stop

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transcript, confidence, stability, alternatives = []) ⇒ InterimResult

Returns a new instance of InterimResult.



176
177
178
179
180
181
 
# File 'lib/google/cloud/speech/result.rb', line 176

def initialize transcript, confidence, stability, alternatives = []
  @transcript  = transcript
  @confidence = confidence
  @stability = stability
  @alternatives = alternatives
end

Instance Attribute Details

#alternatives ⇒ Array<Result::Alternative> (readonly)

Additional recognition hypotheses (up to the value specified in ‘max_alternatives`).

Returns:



171
172
173
 
# File 'lib/google/cloud/speech/result.rb', line 171

def alternatives
  @alternatives
end

#confidence ⇒ Float (readonly)

The confidence estimate between 0.0 and 1.0. A higher number means the system is more confident that the recognition is correct. This field is typically provided only for the top hypothesis. A value of 0.0 is a sentinel value indicating confidence was not set.

Returns:

  • (Float) —

    the current value of confidence



171
172
173
 
# File 'lib/google/cloud/speech/result.rb', line 171

def confidence
  @confidence
end

#stability ⇒ Float (readonly)

An estimate of the probability that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable). Note that this is not the same as confidence, which estimates the probability that a recognition result is correct.

Returns:

  • (Float) —

    the current value of stability



171
172
173
 
# File 'lib/google/cloud/speech/result.rb', line 171

def stability
  @stability
end

#transcript ⇒ String (readonly)

Transcript text representing the words that the user spoke.

Returns:

  • (String) —

    the current value of transcript



171
172
173
 
# File 'lib/google/cloud/speech/result.rb', line 171

def transcript
  @transcript
end

Class Method Details

.from_grpc(grpc) ⇒ Object 



185
186
187
188
189
190
191
192
 
# File 'lib/google/cloud/speech/result.rb', line 185

def self.from_grpc grpc
  head, *tail = *grpc.alternatives
  return nil if head.nil?
  alternatives = tail.map do |alt|
    Result::Alternative.new alt.transcript, alt.confidence
  end
  new head.transcript, head.confidence, grpc.stability, alternatives
end