Class: OpenApiOpenAIClient::CreateSpeechRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSpeechRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 89

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

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

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

  if attributes.key?(:'response_format')
    self.response_format = attributes[:'response_format']
  else
    self.response_format = 'mp3'
  end

  if attributes.key?(:'speed')
    self.speed = attributes[:'speed']
  else
    self.speed = 1.0
  end
end

Instance Attribute Details

#input ⇒ Object

The text to generate audio for. The maximum length is 4096 characters.



21
22
23
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 21

def input
  @input
end

#model ⇒ Object

Returns the value of attribute model.



18
19
20
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 18

def model
  @model
end

#response_format ⇒ Object

The format to audio in. Supported formats are ‘mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`.



27
28
29
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 27

def response_format
  @response_format
end

#speed ⇒ Object

The speed of the generated audio. Select a value from ‘0.25` to `4.0`. `1.0` is the default.



30
31
32
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 30

def speed
  @speed
end

#voice ⇒ Object

The voice to use when generating the audio. Supported voices are ‘alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer`. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech/voice-options).



24
25
26
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 24

def voice
  @voice
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



285
286
287
288
289
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
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 285

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



66
67
68
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 55

def self.attribute_map
  {
    :'model' => :'model',
    :'input' => :'input',
    :'voice' => :'voice',
    :'response_format' => :'response_format',
    :'speed' => :'speed'
  }
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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 261

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



82
83
84
85
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 71

def self.openapi_types
  {
    :'model' => :'CreateSpeechRequestModel',
    :'input' => :'String',
    :'voice' => :'String',
    :'response_format' => :'String',
    :'speed' => :'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
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      model == o.model &&
      input == o.input &&
      voice == o.voice &&
      response_format == o.response_format &&
      speed == o.speed
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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 356

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


248
249
250
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



254
255
256
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 254

def hash
  [model, input, voice, response_format, speed].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



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
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 135

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

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

  if @input.to_s.length > 4096
    invalid_properties.push('invalid value for "input", the character length must be smaller than or equal to 4096.')
  end

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

  if !@speed.nil? && @speed > 4.0
    invalid_properties.push('invalid value for "speed", must be smaller than or equal to 4.0.')
  end

  if !@speed.nil? && @speed < 0.25
    invalid_properties.push('invalid value for "speed", must be greater than or equal to 0.25.')
  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



332
333
334
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 332

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 338

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



326
327
328
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 326

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 167

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @model.nil?
  return false if @input.nil?
  return false if @input.to_s.length > 4096
  return false if @voice.nil?
  voice_validator = EnumAttributeValidator.new('String', ["alloy", "echo", "fable", "onyx", "nova", "shimmer"])
  return false unless voice_validator.valid?(@voice)
  response_format_validator = EnumAttributeValidator.new('String', ["mp3", "opus", "aac", "flac", "wav", "pcm"])
  return false unless response_format_validator.valid?(@response_format)
  return false if !@speed.nil? && @speed > 4.0
  return false if !@speed.nil? && @speed < 0.25
  true
end