Class: VeniceClient::UpscaleImageRequest

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

Overview

Upscale or enhance an image based on the supplied parameters. Using a scale of 1 with enhance enabled will only run the enhancer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpscaleImageRequest

Initializes the object



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 68

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

  if attributes.key?(:'enhance_creativity')
    self.enhance_creativity = attributes[:'enhance_creativity']
  else
    self.enhance_creativity = 0.5
  end

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

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

  if attributes.key?(:'replication')
    self.replication = attributes[:'replication']
  else
    self.replication = 0.35
  end

  if attributes.key?(:'scale')
    self.scale = attributes[:'scale']
  else
    self.scale = 2
  end
end

Instance Attribute Details

#enhance ⇒ Object

Whether to enhance the image using Venice’s image engine during upscaling. Must be true if scale is 1.



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

def enhance
  @enhance
end

#enhance_creativity ⇒ Object

Higher values let the enhancement AI change the image more. Setting this to 1 effectively creates an entirely new image.



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

def enhance_creativity
  @enhance_creativity
end

#enhance_prompt ⇒ Object

The text to image style to apply during prompt enhancement. Does best with short descriptive prompts, like gold, marble or angry, menacing.



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

def enhance_prompt
  @enhance_prompt
end

#image ⇒ Object

The image to upscale. Can be either a file upload or a base64-encoded string. Image dimensions must be at least 65536 pixels and final dimensions after scaling must not exceed 16777216 pixels



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

def image
  @image
end

#replication ⇒ Object

How strongly lines and noise in the base image are preserved. Higher values are noisier but less plastic/AI "generated"/hallucinated. Must be between 0.1 and 1.



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

def replication
  @replication
end

#scale ⇒ Object

The scale factor for upscaling the image. Must be a number between 1 and 4. Scale of 1 requires enhance to be set true and will only run the enhancer. Scale must be > 1 if enhance is false. A scale of 4 with large images will result in the scale being dynamically set to ensure the final image stays within the maximum size limits.



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

def scale
  @scale
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 36

def self.attribute_map
  {
    :'enhance' => :'enhance',
    :'enhance_creativity' => :'enhanceCreativity',
    :'enhance_prompt' => :'enhancePrompt',
    :'image' => :'image',
    :'replication' => :'replication',
    :'scale' => :'scale'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



158
159
160
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 158

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



60
61
62
63
64
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 60

def self.openapi_nullable
  Set.new([
    :'enhance_creativity',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 48

def self.openapi_types
  {
    :'enhance' => :'Object',
    :'enhance_creativity' => :'Object',
    :'enhance_prompt' => :'Object',
    :'image' => :'Object',
    :'replication' => :'Object',
    :'scale' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 132

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enhance == o.enhance &&
      enhance_creativity == o.enhance_creativity &&
      enhance_prompt == o.enhance_prompt &&
      image == o.image &&
      replication == o.replication &&
      scale == o.scale
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
222
223
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 188

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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 257

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 165

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


145
146
147
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 145

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



151
152
153
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 151

def hash
  [enhance, enhance_creativity, enhance_prompt, image, replication, scale].hash
end

#list_invalid_properties ⇒ Object

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



114
115
116
117
118
119
120
121
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 114

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



233
234
235
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 233

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 239

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



227
228
229
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 227

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



125
126
127
128
 
# File 'lib/venice_client/models/upscale_image_request.rb', line 125

def valid?
  return false if @image.nil?
  true
end