Class: Bandwidth::Transcript
- Defined in:
- lib/bandwidth/voice_lib/voice/models/transcript.rb
Overview
Transcript Model.
Instance Attribute Summary collapse
-
#confidence ⇒ Float
TODO: Write general description for this method.
-
#text ⇒ String
TODO: Write general description for this method.
Class Method Summary collapse
-
.from_hash(hash) ⇒ Object
Creates an instance of the object from a hash.
-
.names ⇒ Object
A mapping from model property names to API property names.
Instance Method Summary collapse
-
#initialize(text = nil, confidence = nil) ⇒ Transcript
constructor
A new instance of Transcript.
-
#nullables ⇒ Object
An array for nullable fields.
-
#optionals ⇒ Object
An array for optional fields.
Methods inherited from BaseModel
Constructor Details
#initialize(text = nil, confidence = nil) ⇒ Transcript
Returns a new instance of Transcript.
41 42 43 44 45 |
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 41 def initialize(text = nil, confidence = nil) @text = text unless text == SKIP @confidence = confidence unless confidence == SKIP end |
Instance Attribute Details
#confidence ⇒ Float
TODO: Write general description for this method
18 19 20 |
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 18 def confidence @confidence end |
#text ⇒ String
TODO: Write general description for this method
14 15 16 |
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 14 def text @text end |
Class Method Details
.from_hash(hash) ⇒ Object
Creates an instance of the object from a hash.
48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 48 def self.from_hash(hash) return nil unless hash # Extract variables from the hash. text = hash.key?('text') ? hash['text'] : SKIP confidence = hash.key?('confidence') ? hash['confidence'] : SKIP # Create object from extracted values. Transcript.new(text, confidence) end |
.names ⇒ Object
A mapping from model property names to API property names.
21 22 23 24 25 26 |
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 21 def self.names @_hash = {} if @_hash.nil? @_hash['text'] = 'text' @_hash['confidence'] = 'confidence' @_hash end |
Instance Method Details
#nullables ⇒ Object
An array for nullable fields
37 38 39 |
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 37 def nullables [] end |
#optionals ⇒ Object
An array for optional fields
29 30 31 32 33 34 |
# File 'lib/bandwidth/voice_lib/voice/models/transcript.rb', line 29 def optionals %w[ text confidence ] end |