Class: OpenApiOpenAIClient::OpenAIFile

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_openai/models/open_ai_file.rb

Overview

The ‘File` object represents a document that has been uploaded to OpenAI.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpenAIFile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'bytes')
    self.bytes = attributes[:'bytes']
  else
    self.bytes = 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?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 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?(:'status_details')
    self.status_details = attributes[:'status_details']
  end
end

Instance Attribute Details

#bytes ⇒ Object

The size of the file, in bytes.



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

def bytes
  @bytes
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#filename ⇒ Object

The name of the file.



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

def filename
  @filename
end

#id ⇒ Object

The file identifier, which can be referenced in the API endpoints.



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

def id
  @id
end

#object ⇒ Object

The object type, which is always ‘file`.



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

def object
  @object
end

#purpose ⇒ Object

The intended purpose of the file. Supported values are ‘fine-tune`, `fine-tune-results`, `assistants`, and `assistants_output`.



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

def purpose
  @purpose
end

#status ⇒ Object

Deprecated. The current status of the file, which can be either ‘uploaded`, `processed`, or `error`.



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

def status
  @status
end

#status_details ⇒ Object

Deprecated. For details on why a fine-tuning training file failed validation, see the ‘error` field on `fine_tuning.job`.



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

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 306

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 = OpenApiOpenAIClient.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_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 66

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 282

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



99
100
101
102
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 99

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 85

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      bytes == o.bytes &&
      created_at == o.created_at &&
      filename == o.filename &&
      object == o.object &&
      purpose == o.purpose &&
      status == o.status &&
      status_details == o.status_details
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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 377

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


269
270
271
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



275
276
277
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 275

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



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

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 @bytes.nil?
    invalid_properties.push('invalid value for "bytes", bytes 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 @object.nil?
    invalid_properties.push('invalid value for "object", object 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

  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



353
354
355
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 353

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 359

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



347
348
349
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 347

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/openapi_openai/models/open_ai_file.rb', line 204

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @bytes.nil?
  return false if @created_at.nil?
  return false if @filename.nil?
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["file"])
  return false unless object_validator.valid?(@object)
  return false if @purpose.nil?
  purpose_validator = EnumAttributeValidator.new('String', ["fine-tune", "fine-tune-results", "assistants", "assistants_output"])
  return false unless purpose_validator.valid?(@purpose)
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["uploaded", "processed", "error"])
  return false unless status_validator.valid?(@status)
  true
end