Class: OpenApiOpenAIClient::FineTuningJob

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

Overview

The ‘fine_tuning.job` object represents a fine-tuning job that has been created through the API.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FineTuningJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
222
223
224
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
258
259
260
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 150

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

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

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

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

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

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

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

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

  if attributes.key?(:'result_files')
    if (value = attributes[:'result_files']).is_a?(Array)
      self.result_files = value
    end
  else
    self.result_files = nil
  end

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

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

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

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

  if attributes.key?(:'integrations')
    if (value = attributes[:'integrations']).is_a?(Array)
      self.integrations = value
    end
  end

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

Instance Attribute Details

#created_at ⇒ Object

The Unix timestamp (in seconds) for when the fine-tuning job was created.



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

def created_at
  @created_at
end

#error ⇒ Object

Returns the value of attribute error.



25
26
27
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 25

def error
  @error
end

#fine_tuned_model ⇒ Object

The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.



28
29
30
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 28

def fine_tuned_model
  @fine_tuned_model
end

#finished_at ⇒ Object

The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running.



31
32
33
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 31

def finished_at
  @finished_at
end

#hyperparameters ⇒ Object

Returns the value of attribute hyperparameters.



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

def hyperparameters
  @hyperparameters
end

#id ⇒ Object

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



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

def id
  @id
end

#integrations ⇒ Object

A list of integrations to enable for this fine-tuning job.



60
61
62
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 60

def integrations
  @integrations
end

#model ⇒ Object

The base model that is being fine-tuned.



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

def model
  @model
end

#object ⇒ Object

The object type, which is always "fine_tuning.job".



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

def object
  @object
end

#organization_id ⇒ Object

The organization that owns the fine-tuning job.



42
43
44
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 42

def organization_id
  @organization_id
end

#result_files ⇒ Object

The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the [Files API](/docs/api-reference/files/retrieve-contents).



45
46
47
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 45

def result_files
  @result_files
end

#seed ⇒ Object

The seed used for the fine-tuning job.



63
64
65
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 63

def seed
  @seed
end

#status ⇒ Object

The current status of the fine-tuning job, which can be either ‘validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`.



48
49
50
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 48

def status
  @status
end

#trained_tokens ⇒ Object

The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running.



51
52
53
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 51

def trained_tokens
  @trained_tokens
end

#training_file ⇒ Object

The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents).



54
55
56
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 54

def training_file
  @training_file
end

#validation_file ⇒ Object

The file ID used for validation. You can retrieve the validation results with the [Files API](/docs/api-reference/files/retrieve-contents).



57
58
59
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 57

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



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 428

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



110
111
112
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 110

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 88

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'error' => :'error',
    :'fine_tuned_model' => :'fine_tuned_model',
    :'finished_at' => :'finished_at',
    :'hyperparameters' => :'hyperparameters',
    :'model' => :'model',
    :'object' => :'object',
    :'organization_id' => :'organization_id',
    :'result_files' => :'result_files',
    :'status' => :'status',
    :'trained_tokens' => :'trained_tokens',
    :'training_file' => :'training_file',
    :'validation_file' => :'validation_file',
    :'integrations' => :'integrations',
    :'seed' => :'seed'
  }
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



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 404

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



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 137

def self.openapi_nullable
  Set.new([
    :'error',
    :'fine_tuned_model',
    :'finished_at',
    :'trained_tokens',
    :'validation_file',
    :'integrations',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 115

def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'Integer',
    :'error' => :'FineTuningJobError',
    :'fine_tuned_model' => :'String',
    :'finished_at' => :'Integer',
    :'hyperparameters' => :'FineTuningJobHyperparameters',
    :'model' => :'String',
    :'object' => :'String',
    :'organization_id' => :'String',
    :'result_files' => :'Array<String>',
    :'status' => :'String',
    :'trained_tokens' => :'Integer',
    :'training_file' => :'String',
    :'validation_file' => :'String',
    :'integrations' => :'Array<FineTuningJobIntegrationsInner>',
    :'seed' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 368

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      error == o.error &&
      fine_tuned_model == o.fine_tuned_model &&
      finished_at == o.finished_at &&
      hyperparameters == o.hyperparameters &&
      model == o.model &&
      object == o.object &&
      organization_id == o.organization_id &&
      result_files == o.result_files &&
      status == o.status &&
      trained_tokens == o.trained_tokens &&
      training_file == o.training_file &&
      validation_file == o.validation_file &&
      integrations == o.integrations &&
      seed == o.seed
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



499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 499

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


391
392
393
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 391

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



397
398
399
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 397

def hash
  [id, created_at, error, fine_tuned_model, finished_at, hyperparameters, model, object, organization_id, result_files, status, trained_tokens, training_file, validation_file, integrations, seed].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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 264

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

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

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

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

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

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

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

  if !@integrations.nil? && @integrations.length > 5
    invalid_properties.push('invalid value for "integrations", number of items must be less than or equal to 5.')
  end

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



475
476
477
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 475

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



481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 481

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



469
470
471
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 469

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/openapi_openai/models/fine_tuning_job.rb', line 316

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @hyperparameters.nil?
  return false if @model.nil?
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["fine_tuning.job"])
  return false unless object_validator.valid?(@object)
  return false if @organization_id.nil?
  return false if @result_files.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["validating_files", "queued", "running", "succeeded", "failed", "cancelled"])
  return false unless status_validator.valid?(@status)
  return false if @training_file.nil?
  return false if !@integrations.nil? && @integrations.length > 5
  return false if @seed.nil?
  true
end