Class: VeniceClient::CreateSpeechRequestSchema

Inherits:
Object
  • Object
show all
Defined in:
lib/venice_client/models/create_speech_request_schema.rb

Overview

Request to generate audio from text.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSpeechRequestSchema

Initializes the object



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
132
133
134
135
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 89

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

  if attributes.key?(:'model')
    self.model = attributes[:'model']
  else
    self.model = 'tts-kokoro'
  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

  if attributes.key?(:'streaming')
    self.streaming = attributes[:'streaming']
  else
    self.streaming = false
  end

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

Instance Attribute Details

#input ⇒ Object

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



18
19
20
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 18

def input
  @input
end

#model ⇒ Object

The model ID of a Venice TTS model.



21
22
23
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 21

def model
  @model
end

#response_format ⇒ Object

The format to audio in.



24
25
26
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 24

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.



27
28
29
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 27

def speed
  @speed
end

#streaming ⇒ Object

Should the content stream back sentence by sentence or be processed and returned as a complete audio file.



30
31
32
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 30

def streaming
  @streaming
end

#voice ⇒ Object

The voice to use when generating the audio.



33
34
35
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 33

def voice
  @voice
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 58

def self.attribute_map
  {
    :'input' => :'input',
    :'model' => :'model',
    :'response_format' => :'response_format',
    :'speed' => :'speed',
    :'streaming' => :'streaming',
    :'voice' => :'voice'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



219
220
221
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 219

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 70

def self.openapi_types
  {
    :'input' => :'Object',
    :'model' => :'Object',
    :'response_format' => :'Object',
    :'speed' => :'Object',
    :'streaming' => :'Object',
    :'voice' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      input == o.input &&
      model == o.model &&
      response_format == o.response_format &&
      speed == o.speed &&
      streaming == o.streaming &&
      voice == o.voice
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 249

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    VeniceClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 318

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 226

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


206
207
208
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



212
213
214
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 212

def hash
  [input, model, response_format, speed, streaming, voice].hash
end

#list_invalid_properties ⇒ Object

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



139
140
141
142
143
144
145
146
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 139

def list_invalid_properties
  invalid_properties = Array.new
  if @input.nil?
    invalid_properties.push('invalid value for "input", input cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



294
295
296
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 294

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 300

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



288
289
290
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 288

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/venice_client/models/create_speech_request_schema.rb', line 150

def valid?
  return false if @input.nil?
  model_validator = EnumAttributeValidator.new('Object', ['tts-kokoro'])
  return false unless model_validator.valid?(@model)
  response_format_validator = EnumAttributeValidator.new('Object', ['mp3', 'opus', 'aac', 'flac', 'wav', 'pcm'])
  return false unless response_format_validator.valid?(@response_format)
  voice_validator = EnumAttributeValidator.new('Object', ['af_alloy', 'af_aoede', 'af_bella', 'af_heart', 'af_jadzia', 'af_jessica', 'af_kore', 'af_nicole', 'af_nova', 'af_river', 'af_sarah', 'af_sky', 'am_adam', 'am_echo', 'am_eric', 'am_fenrir', 'am_liam', 'am_michael', 'am_onyx', 'am_puck', 'am_santa', 'bf_alice', 'bf_emma', 'bf_lily', 'bm_daniel', 'bm_fable', 'bm_george', 'bm_lewis', 'zf_xiaobei', 'zf_xiaoni', 'zf_xiaoxiao', 'zf_xiaoyi', 'zm_yunjian', 'zm_yunxi', 'zm_yunxia', 'zm_yunyang', 'ff_siwis', 'hf_alpha', 'hf_beta', 'hm_omega', 'hm_psi', 'if_sara', 'im_nicola', 'jf_alpha', 'jf_gongitsune', 'jf_nezumi', 'jf_tebukuro', 'jm_kumo', 'pf_dora', 'pm_alex', 'pm_santa', 'ef_dora', 'em_alex', 'em_santa'])
  return false unless voice_validator.valid?(@voice)
  true
end