Class: Bandwidth::Transcript

Inherits:
BaseModel show all
Defined in:
lib/bandwidth/voice_lib/voice/models/transcript.rb

Overview

Transcript Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(text = nil, confidence = nil) ⇒ Transcript

Returns a new instance of Transcript.



25
26
27
28
29
 
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 25

def initialize(text = nil,
               confidence = nil)
  @text = text
  @confidence = confidence
end

Instance Attribute Details

#confidence ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


15
16
17
 
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 15

def confidence
  @confidence
end

#text ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


11
12
13
 
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 11

def text
  @text
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 32

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  text = hash['text']
  confidence = hash['confidence']

  # Create object from extracted values.
  Transcript.new(text,
                 confidence)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
23
 
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 18

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['text'] = 'text'
  @_hash['confidence'] = 'confidence'
  @_hash
end