Class: OpenApiOpenAIClient::TranscriptionSegment

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_openai/models/transcription_segment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TranscriptionSegment

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 93

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::TranscriptionSegment` 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 `OpenApiOpenAIClient::TranscriptionSegment`. 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?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'seek')
    self.seek = attributes[:'seek']
  else
    self.seek = nil
  end

  if attributes.key?(:'start')
    self.start = attributes[:'start']
  else
    self.start = nil
  end

  if attributes.key?(:'_end')
    self._end = attributes[:'_end']
  else
    self._end = nil
  end

  if attributes.key?(:'text')
    self.text = attributes[:'text']
  else
    self.text = nil
  end

  if attributes.key?(:'tokens')
    if (value = attributes[:'tokens']).is_a?(Array)
      self.tokens = value
    end
  else
    self.tokens = nil
  end

  if attributes.key?(:'temperature')
    self.temperature = attributes[:'temperature']
  else
    self.temperature = nil
  end

  if attributes.key?(:'avg_logprob')
    self.avg_logprob = attributes[:'avg_logprob']
  else
    self.avg_logprob = nil
  end

  if attributes.key?(:'compression_ratio')
    self.compression_ratio = attributes[:'compression_ratio']
  else
    self.compression_ratio = nil
  end

  if attributes.key?(:'no_speech_prob')
    self.no_speech_prob = attributes[:'no_speech_prob']
  else
    self.no_speech_prob = nil
  end
end

Instance Attribute Details

#_end ⇒ Object

End time of the segment in seconds.



28
29
30
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 28

def _end
  @_end
end

#avg_logprob ⇒ Object

Average logprob of the segment. If the value is lower than -1, consider the logprobs failed.



40
41
42
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 40

def avg_logprob
  @avg_logprob
end

#compression_ratio ⇒ Object

Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed.



43
44
45
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 43

def compression_ratio
  @compression_ratio
end

#id ⇒ Object

Unique identifier of the segment.



19
20
21
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 19

def id
  @id
end

#no_speech_prob ⇒ Object

Probability of no speech in the segment. If the value is higher than 1.0 and the ‘avg_logprob` is below -1, consider this segment silent.



46
47
48
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 46

def no_speech_prob
  @no_speech_prob
end

#seek ⇒ Object

Seek offset of the segment.



22
23
24
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 22

def seek
  @seek
end

#start ⇒ Object

Start time of the segment in seconds.



25
26
27
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 25

def start
  @start
end

#temperature ⇒ Object

Temperature parameter used for generating the segment.



37
38
39
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 37

def temperature
  @temperature
end

#text ⇒ Object

Text content of the segment.



31
32
33
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 31

def text
  @text
end

#tokens ⇒ Object

Array of token IDs for the text content.



34
35
36
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 34

def tokens
  @tokens
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 290

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 = OpenApiOpenAIClient.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



65
66
67
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 49

def self.attribute_map
  {
    :'id' => :'id',
    :'seek' => :'seek',
    :'start' => :'start',
    :'_end' => :'end',
    :'text' => :'text',
    :'tokens' => :'tokens',
    :'temperature' => :'temperature',
    :'avg_logprob' => :'avg_logprob',
    :'compression_ratio' => :'compression_ratio',
    :'no_speech_prob' => :'no_speech_prob'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 266

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



86
87
88
89
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 86

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 70

def self.openapi_types
  {
    :'id' => :'Integer',
    :'seek' => :'Integer',
    :'start' => :'Float',
    :'_end' => :'Float',
    :'text' => :'String',
    :'tokens' => :'Array<Integer>',
    :'temperature' => :'Float',
    :'avg_logprob' => :'Float',
    :'compression_ratio' => :'Float',
    :'no_speech_prob' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      seek == o.seek &&
      start == o.start &&
      _end == o._end &&
      text == o.text &&
      tokens == o.tokens &&
      temperature == o.temperature &&
      avg_logprob == o.avg_logprob &&
      compression_ratio == o.compression_ratio &&
      no_speech_prob == o.no_speech_prob
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 361

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


253
254
255
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



259
260
261
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 259

def hash
  [id, seek, start, _end, text, tokens, temperature, avg_logprob, compression_ratio, no_speech_prob].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 171

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @seek.nil?
    invalid_properties.push('invalid value for "seek", seek cannot be nil.')
  end

  if @start.nil?
    invalid_properties.push('invalid value for "start", start cannot be nil.')
  end

  if @_end.nil?
    invalid_properties.push('invalid value for "_end", _end cannot be nil.')
  end

  if @text.nil?
    invalid_properties.push('invalid value for "text", text cannot be nil.')
  end

  if @tokens.nil?
    invalid_properties.push('invalid value for "tokens", tokens cannot be nil.')
  end

  if @temperature.nil?
    invalid_properties.push('invalid value for "temperature", temperature cannot be nil.')
  end

  if @avg_logprob.nil?
    invalid_properties.push('invalid value for "avg_logprob", avg_logprob cannot be nil.')
  end

  if @compression_ratio.nil?
    invalid_properties.push('invalid value for "compression_ratio", compression_ratio cannot be nil.')
  end

  if @no_speech_prob.nil?
    invalid_properties.push('invalid value for "no_speech_prob", no_speech_prob cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



337
338
339
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 337

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 343

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

Returns:

  • (String) —

    String presentation of the object



331
332
333
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 331

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/openapi_openai/models/transcription_segment.rb', line 219

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @seek.nil?
  return false if @start.nil?
  return false if @_end.nil?
  return false if @text.nil?
  return false if @tokens.nil?
  return false if @temperature.nil?
  return false if @avg_logprob.nil?
  return false if @compression_ratio.nil?
  return false if @no_speech_prob.nil?
  true
end