Class: OpenApiOpenAIClient::CreateSpeechRequest

Inherits:
ApiModelBase
  • 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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CreateSpeechRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_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: " + acceptable_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
  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

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 71

def self.acceptable_attributes
  acceptable_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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 277

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



87
88
89
90
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 87

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 76

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



252
253
254
255
256
257
258
259
260
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 252

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


264
265
266
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



270
271
272
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 270

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



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

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
    invalid_properties.push('invalid value for "speed", must be smaller than or equal to 4.')
  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_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 299

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/openapi_openai/models/create_speech_request.rb', line 173

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
  return false if !@speed.nil? && @speed < 0.25
  true
end