Class: VeniceClient::SimpleGenerateImageRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SimpleGenerateImageRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
168
169
170
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
216
217
218
219
220
221
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 138

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

  if attributes.key?(:'model')
    self.model = attributes[:'model']
  else
    self.model = 'default'
  end

  if attributes.key?(:'moderation')
    self.moderation = attributes[:'moderation']
  else
    self.moderation = 'auto'
  end

  if attributes.key?(:'n')
    self.n = attributes[:'n']
  else
    self.n = 1
  end

  if attributes.key?(:'output_compression')
    self.output_compression = attributes[:'output_compression']
  else
    self.output_compression = 100
  end

  if attributes.key?(:'output_format')
    self.output_format = attributes[:'output_format']
  else
    self.output_format = 'png'
  end

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

  if attributes.key?(:'quality')
    self.quality = attributes[:'quality']
  else
    self.quality = 'auto'
  end

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

  if attributes.key?(:'size')
    self.size = attributes[:'size']
  else
    self.size = 'auto'
  end

  if attributes.key?(:'style')
    self.style = attributes[:'style']
  else
    self.style = 'natural'
  end

  if attributes.key?(:'user')
    self.user = attributes[:'user']
  end
end

Instance Attribute Details

#background ⇒ Object

This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API



19
20
21
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 19

def background
  @background
end

#model ⇒ Object

The model to use for image generation. Defaults to Venice’s default image model. If a non-existent model is specified (ie an OpenAI model name), it will default to Venice’s default image model.



22
23
24
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 22

def model
  @model
end

#moderation ⇒ Object

auto enables safe venice mode which will blur out adult content. low disables safe venice mode.



25
26
27
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 25

def moderation
  @moderation
end

#n ⇒ Object

Number of images to generate. Venice presently only supports 1 image per request.



28
29
30
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 28

def n
  @n
end

#output_compression ⇒ Object

This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API



31
32
33
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 31

def output_compression
  @output_compression
end

#output_format ⇒ Object

Output format for generated images



34
35
36
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 34

def output_format
  @output_format
end

#prompt ⇒ Object

A text description of the desired image.



37
38
39
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 37

def prompt
  @prompt
end

#quality ⇒ Object

This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API



40
41
42
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 40

def quality
  @quality
end

#response_format ⇒ Object

Response format. URL will be a data URL.



43
44
45
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 43

def response_format
  @response_format
end

#size ⇒ Object

Size of generated images. Default is 1024x1024



46
47
48
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 46

def size
  @size
end

#style ⇒ Object

This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API



49
50
51
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 49

def style
  @style
end

#user ⇒ Object

This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API



52
53
54
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 52

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



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 461

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 = VeniceClient.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



95
96
97
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 95

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



100
101
102
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 100

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 77

def self.attribute_map
  {
    :'background' => :'background',
    :'model' => :'model',
    :'moderation' => :'moderation',
    :'n' => :'n',
    :'output_compression' => :'output_compression',
    :'output_format' => :'output_format',
    :'prompt' => :'prompt',
    :'quality' => :'quality',
    :'response_format' => :'response_format',
    :'size' => :'size',
    :'style' => :'style',
    :'user' => :'user'
  }
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



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 437

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



123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 123

def self.openapi_nullable
  Set.new([
    :'background',
    :'moderation',
    :'n',
    :'output_compression',
    :'quality',
    :'response_format',
    :'size',
    :'style',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 105

def self.openapi_types
  {
    :'background' => :'String',
    :'model' => :'String',
    :'moderation' => :'String',
    :'n' => :'Integer',
    :'output_compression' => :'Integer',
    :'output_format' => :'String',
    :'prompt' => :'String',
    :'quality' => :'String',
    :'response_format' => :'String',
    :'size' => :'String',
    :'style' => :'String',
    :'user' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 405

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      background == o.background &&
      model == o.model &&
      moderation == o.moderation &&
      n == o.n &&
      output_compression == o.output_compression &&
      output_format == o.output_format &&
      prompt == o.prompt &&
      quality == o.quality &&
      response_format == o.response_format &&
      size == o.size &&
      style == o.style &&
      user == o.user
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



532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 532

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


424
425
426
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 424

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



430
431
432
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 430

def hash
  [background, model, moderation, n, output_compression, output_format, prompt, quality, response_format, size, style, user].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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 225

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@n.nil? && @n > 1
    invalid_properties.push('invalid value for "n", must be smaller than or equal to 1.')
  end

  if !@n.nil? && @n < 1
    invalid_properties.push('invalid value for "n", must be greater than or equal to 1.')
  end

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

  if !@output_compression.nil? && @output_compression < 0
    invalid_properties.push('invalid value for "output_compression", must be greater than or equal to 0.')
  end

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

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

  if @prompt.to_s.length < 1
    invalid_properties.push('invalid value for "prompt", the character length must be greater than or equal to 1.')
  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



508
509
510
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 508

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



514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 514

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



502
503
504
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 502

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/venice_client/models/simple_generate_image_request.rb', line 261

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  background_validator = EnumAttributeValidator.new('String', ["transparent", "opaque", "auto"])
  return false unless background_validator.valid?(@background)
  moderation_validator = EnumAttributeValidator.new('String', ["low", "auto"])
  return false unless moderation_validator.valid?(@moderation)
  return false if !@n.nil? && @n > 1
  return false if !@n.nil? && @n < 1
  return false if !@output_compression.nil? && @output_compression > 100
  return false if !@output_compression.nil? && @output_compression < 0
  output_format_validator = EnumAttributeValidator.new('String', ["jpeg", "png", "webp"])
  return false unless output_format_validator.valid?(@output_format)
  return false if @prompt.nil?
  return false if @prompt.to_s.length > 1500
  return false if @prompt.to_s.length < 1
  quality_validator = EnumAttributeValidator.new('String', ["auto", "high", "medium", "low", "hd", "standard"])
  return false unless quality_validator.valid?(@quality)
  response_format_validator = EnumAttributeValidator.new('String', ["b64_json", "url"])
  return false unless response_format_validator.valid?(@response_format)
  size_validator = EnumAttributeValidator.new('String', ["auto", "256x256", "512x512", "1024x1024", "1536x1024", "1024x1536", "1792x1024", "1024x1792"])
  return false unless size_validator.valid?(@size)
  style_validator = EnumAttributeValidator.new('String', ["vivid", "natural"])
  return false unless style_validator.valid?(@style)
  true
end