Class: OpenApiOpenAIClient::Upload

Inherits:
ApiModelBase show all
Defined in:
lib/openapi_openai/models/upload.rb

Overview

The Upload object can accept byte chunks in the form of Parts.

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 = {}) ⇒ Upload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
172
173
174
175
176
177
178
 
# File 'lib/openapi_openai/models/upload.rb', line 115

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bytes ⇒ Object

The intended number of bytes to be uploaded.



29
30
31
 
# File 'lib/openapi_openai/models/upload.rb', line 29

def bytes
  @bytes
end

#created_at ⇒ Object

The Unix timestamp (in seconds) for when the Upload was created.



23
24
25
 
# File 'lib/openapi_openai/models/upload.rb', line 23

def created_at
  @created_at
end

#expires_at ⇒ Object

The Unix timestamp (in seconds) for when the Upload was created.



38
39
40
 
# File 'lib/openapi_openai/models/upload.rb', line 38

def expires_at
  @expires_at
end

#file ⇒ Object

Returns the value of attribute file.



43
44
45
 
# File 'lib/openapi_openai/models/upload.rb', line 43

def file
  @file
end

#filename ⇒ Object

The name of the file to be uploaded.



26
27
28
 
# File 'lib/openapi_openai/models/upload.rb', line 26

def filename
  @filename
end

#id ⇒ Object

The Upload unique identifier, which can be referenced in API endpoints.



20
21
22
 
# File 'lib/openapi_openai/models/upload.rb', line 20

def id
  @id
end

#object ⇒ Object

The object type, which is always "upload".



41
42
43
 
# File 'lib/openapi_openai/models/upload.rb', line 41

def object
  @object
end

#purpose ⇒ Object

The intended purpose of the file. [Please refer here](/docs/api-reference/files/object#files/object-purpose) for acceptable values.



32
33
34
 
# File 'lib/openapi_openai/models/upload.rb', line 32

def purpose
  @purpose
end

#status ⇒ Object

The status of the Upload.



35
36
37
 
# File 'lib/openapi_openai/models/upload.rb', line 35

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/openapi_openai/models/upload.rb', line 68

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'filename' => :'filename',
    :'bytes' => :'bytes',
    :'purpose' => :'purpose',
    :'status' => :'status',
    :'expires_at' => :'expires_at',
    :'object' => :'object',
    :'file' => :'file'
  }
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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/openapi_openai/models/upload.rb', line 345

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



108
109
110
111
 
# File 'lib/openapi_openai/models/upload.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/openapi_openai/models/upload.rb', line 93

def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'Integer',
    :'filename' => :'String',
    :'bytes' => :'Integer',
    :'purpose' => :'String',
    :'status' => :'String',
    :'expires_at' => :'Integer',
    :'object' => :'String',
    :'file' => :'OpenAIFile'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/openapi_openai/models/upload.rb', line 316

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      filename == o.filename &&
      bytes == o.bytes &&
      purpose == o.purpose &&
      status == o.status &&
      expires_at == o.expires_at &&
      object == o.object &&
      file == o.file
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


332
333
334
 
# File 'lib/openapi_openai/models/upload.rb', line 332

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



338
339
340
 
# File 'lib/openapi_openai/models/upload.rb', line 338

def hash
  [id, created_at, filename, bytes, purpose, status, expires_at, object, file].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



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

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

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

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

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

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

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

  if @expires_at.nil?
    invalid_properties.push('invalid value for "expires_at", expires_at cannot be nil.')
  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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/openapi_openai/models/upload.rb', line 367

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/openapi_openai/models/upload.rb', line 218

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @filename.nil?
  return false if @bytes.nil?
  return false if @purpose.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["pending", "completed", "cancelled", "expired"])
  return false unless status_validator.valid?(@status)
  return false if @expires_at.nil?
  object_validator = EnumAttributeValidator.new('String', ["upload"])
  return false unless object_validator.valid?(@object)
  true
end