Class: OpenApiOpenAIClient::FineTuningJobEvent

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

Overview

Fine-tuning job event object

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

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

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

  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?(:'level')
    self.level = attributes[:'level']
  else
    self.level = nil
  end

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

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

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

Instance Attribute Details

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#data ⇒ Object

The data associated with the event.



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

def data
  @data
end

#id ⇒ Object

The object identifier.



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

def id
  @id
end

#level ⇒ Object

The log level of the event.



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

def level
  @level
end

#message ⇒ Object

The message of the event.



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

def message
  @message
end

#object ⇒ Object

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



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

def object
  @object
end

#type ⇒ Object

The type of event.



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

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



76
77
78
 
# File 'lib/openapi_openai/models/fine_tuning_job_event.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/openapi_openai/models/fine_tuning_job_event.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'object' => :'object',
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'level' => :'level',
    :'message' => :'message',
    :'type' => :'type',
    :'data' => :'data'
  }
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



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_event.rb', line 294

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/fine_tuning_job_event.rb', line 99

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'object' => :'String',
    :'id' => :'String',
    :'created_at' => :'Integer',
    :'level' => :'String',
    :'message' => :'String',
    :'type' => :'String',
    :'data' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/openapi_openai/models/fine_tuning_job_event.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      id == o.id &&
      created_at == o.created_at &&
      level == o.level &&
      message == o.message &&
      type == o.type &&
      data == o.data
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


281
282
283
 
# File 'lib/openapi_openai/models/fine_tuning_job_event.rb', line 281

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



287
288
289
 
# File 'lib/openapi_openai/models/fine_tuning_job_event.rb', line 287

def hash
  [object, id, created_at, level, message, type, data].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



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

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

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

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



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

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/openapi_openai/models/fine_tuning_job_event.rb', line 189

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["fine_tuning.job.event"])
  return false unless object_validator.valid?(@object)
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @level.nil?
  level_validator = EnumAttributeValidator.new('String', ["info", "warn", "error"])
  return false unless level_validator.valid?(@level)
  return false if @message.nil?
  type_validator = EnumAttributeValidator.new('String', ["message", "metrics"])
  return false unless type_validator.valid?(@type)
  true
end