Class: Daily::TranscriptionProperties
- Inherits:
-
Object
- Object
- Daily::TranscriptionProperties
- Defined in:
- lib/daily-ruby/models/transcription_properties.rb
Instance Attribute Summary collapse
-
#endpointing ⇒ Object
Returns the value of attribute endpointing.
-
#extra ⇒ Object
Specify any Deepgram parameters.
-
#language ⇒ Object
See Deepgram’s documentation for [‘language`](developers.deepgram.com/docs/language).
-
#model ⇒ Object
See Deepgram’s documentation for [‘model`](developers.deepgram.com/docs/model).
-
#profanity_filter ⇒ Object
See Deepgram’s documentation for [‘profanity filter`](developers.deepgram.com/docs/profanity-filter).
-
#punctuate ⇒ Object
See Deepgram’s documentation for [‘punctuate`](developers.deepgram.com/docs/punctuation).
-
#redact ⇒ Object
Returns the value of attribute redact.
-
#tier ⇒ Object
See Deepgram’s documentation for [‘tier`](developers.deepgram.com/docs/tier).
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ TranscriptionProperties
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ TranscriptionProperties
Initializes the object
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 81 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Daily::TranscriptionProperties` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Daily::TranscriptionProperties`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'language') self.language = attributes[:'language'] end if attributes.key?(:'model') self.model = attributes[:'model'] end if attributes.key?(:'tier') self.tier = attributes[:'tier'] end if attributes.key?(:'profanity_filter') self.profanity_filter = attributes[:'profanity_filter'] end if attributes.key?(:'punctuate') self.punctuate = attributes[:'punctuate'] end if attributes.key?(:'endpointing') self.endpointing = attributes[:'endpointing'] end if attributes.key?(:'redact') self.redact = attributes[:'redact'] end if attributes.key?(:'extra') self.extra = attributes[:'extra'] end end |
Instance Attribute Details
#endpointing ⇒ Object
Returns the value of attribute endpointing.
33 34 35 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 33 def endpointing @endpointing end |
#extra ⇒ Object
Specify any Deepgram parameters. See Deepgram’s documentation for [available streaming options](developers.deepgram.com/docs/features-overview).
38 39 40 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 38 def extra @extra end |
#language ⇒ Object
See Deepgram’s documentation for [‘language`](developers.deepgram.com/docs/language)
19 20 21 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 19 def language @language end |
#model ⇒ Object
See Deepgram’s documentation for [‘model`](developers.deepgram.com/docs/model)
22 23 24 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 22 def model @model end |
#profanity_filter ⇒ Object
See Deepgram’s documentation for [‘profanity filter`](developers.deepgram.com/docs/profanity-filter)
28 29 30 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 28 def profanity_filter @profanity_filter end |
#punctuate ⇒ Object
See Deepgram’s documentation for [‘punctuate`](developers.deepgram.com/docs/punctuation)
31 32 33 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 31 def punctuate @punctuate end |
#redact ⇒ Object
Returns the value of attribute redact.
35 36 37 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 35 def redact @redact end |
#tier ⇒ Object
See Deepgram’s documentation for [‘tier`](developers.deepgram.com/docs/tier)
25 26 27 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 25 def tier @tier end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 196 def self._deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Daily.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
55 56 57 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 55 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 41 def self.attribute_map { :'language' => :'language', :'model' => :'model', :'tier' => :'tier', :'profanity_filter' => :'profanity_filter', :'punctuate' => :'punctuate', :'endpointing' => :'endpointing', :'redact' => :'redact', :'extra' => :'extra' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 172 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
74 75 76 77 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 74 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 60 def self.openapi_types { :'language' => :'String', :'model' => :'String', :'tier' => :'String', :'profanity_filter' => :'Boolean', :'punctuate' => :'Boolean', :'endpointing' => :'TranscriptionPropertiesEndpointing', :'redact' => :'TranscriptionPropertiesRedact', :'extra' => :'Object' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 144 def ==(o) return true if self.equal?(o) self.class == o.class && language == o.language && model == o.model && tier == o.tier && profanity_filter == o.profanity_filter && punctuate == o.punctuate && endpointing == o.endpointing && redact == o.redact && extra == o.extra end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
267 268 269 270 271 272 273 274 275 276 277 278 279 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 267 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#eql?(o) ⇒ Boolean
159 160 161 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 159 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
165 166 167 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 165 def hash [language, model, tier, profanity_filter, punctuate, endpointing, redact, extra].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
129 130 131 132 133 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 129 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
243 244 245 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 243 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 249 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
237 238 239 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 237 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
137 138 139 140 |
# File 'lib/daily-ruby/models/transcription_properties.rb', line 137 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end |