Class: OpenApiOpenAIClient::CreateImageRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/create_image_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 = {}) ⇒ CreateImageRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
164
165
166
167
168
169
170
171
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 114

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

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

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

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

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

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

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

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

Instance Attribute Details

#model ⇒ Object

Returns the value of attribute model.



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

def model
  @model
end

#n ⇒ Object

The number of images to generate. Must be between 1 and 10. For dall-e-3, only ‘n=1` is supported.



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

def n
  @n
end

#prompt ⇒ Object

A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.



19
20
21
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 19

def prompt
  @prompt
end

#quality ⇒ Object

The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.



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

def quality
  @quality
end

#response_format ⇒ Object

The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated.



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

def response_format
  @response_format
end

#size ⇒ Object

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.



33
34
35
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 33

def size
  @size
end

#style ⇒ Object

The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.



36
37
38
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 36

def style
  @style
end

#user ⇒ Object

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).



39
40
41
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 39

def user
  @user
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



78
79
80
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 78

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 64

def self.attribute_map
  {
    :'prompt' => :'prompt',
    :'model' => :'model',
    :'n' => :'n',
    :'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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 305

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



102
103
104
105
106
107
108
109
110
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 102

def self.openapi_nullable
  Set.new([
    :'model',
    :'n',
    :'response_format',
    :'size',
    :'style',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 88

def self.openapi_types
  {
    :'prompt' => :'String',
    :'model' => :'CreateImageRequestModel',
    :'n' => :'Integer',
    :'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



277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 277

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      prompt == o.prompt &&
      model == o.model &&
      n == o.n &&
      quality == o.quality &&
      response_format == o.response_format &&
      size == o.size &&
      style == o.style &&
      user == o.user
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


292
293
294
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 292

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



298
299
300
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 298

def hash
  [prompt, model, n, 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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 175

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

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

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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 327

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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/openapi_openai/models/create_image_request.rb', line 195

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @prompt.nil?
  return false if !@n.nil? && @n > 10
  return false if !@n.nil? && @n < 1
  quality_validator = EnumAttributeValidator.new('String', ["standard", "hd"])
  return false unless quality_validator.valid?(@quality)
  response_format_validator = EnumAttributeValidator.new('String', ["url", "b64_json"])
  return false unless response_format_validator.valid?(@response_format)
  size_validator = EnumAttributeValidator.new('String', ["256x256", "512x512", "1024x1024", "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