openapi_openai 1.0.0 → 1.1.0

data/lib/openapi_openai/models/{fine_tune.rb → fine_tuning_job_checkpoint.rb}

@@ -1,7 +1,7 @@
 =begin
 #OpenAI API
 
-#APIs for sampling from and fine-tuning language models
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
 
 The version of the OpenAPI document: 2.0.0
 Contact: blah+oapicf@cliffano.com
@@ -14,49 +14,60 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
-  class FineTune
+  # The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine-tuning job that is ready to use. 
+  class FineTuningJobCheckpoint
+    # The checkpoint identifier, which can be referenced in the API endpoints.
     attr_accessor :id
 
-    attr_accessor :object
-
+    # The Unix timestamp (in seconds) for when the checkpoint was created.
     attr_accessor :created_at
 
-    attr_accessor :updated_at
-
-    attr_accessor :model
-
-    attr_accessor :fine_tuned_model
+    # The name of the fine-tuned checkpoint model that is created.
+    attr_accessor :fine_tuned_model_checkpoint
 
-    attr_accessor :organization_id
+    # The step number that the checkpoint was created at.
+    attr_accessor :step_number
 
-    attr_accessor :status
+    attr_accessor :metrics
 
-    attr_accessor :hyperparams
+    # The name of the fine-tuning job that this checkpoint was created from.
+    attr_accessor :fine_tuning_job_id
 
-    attr_accessor :training_files
-
-    attr_accessor :validation_files
+    # The object type, which is always \"fine_tuning.job.checkpoint\".
+    attr_accessor :object
 
-    attr_accessor :result_files
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
 
-    attr_accessor :events
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'object' => :'object',
         :'created_at' => :'created_at',
-        :'updated_at' => :'updated_at',
-        :'model' => :'model',
-        :'fine_tuned_model' => :'fine_tuned_model',
-        :'organization_id' => :'organization_id',
-        :'status' => :'status',
-        :'hyperparams' => :'hyperparams',
-        :'training_files' => :'training_files',
-        :'validation_files' => :'validation_files',
-        :'result_files' => :'result_files',
-        :'events' => :'events'
+        :'fine_tuned_model_checkpoint' => :'fine_tuned_model_checkpoint',
+        :'step_number' => :'step_number',
+        :'metrics' => :'metrics',
+        :'fine_tuning_job_id' => :'fine_tuning_job_id',
+        :'object' => :'object'
       }
     end
 
@@ -69,25 +80,18 @@ module OpenApiOpenAIClient
     def self.openapi_types
       {
         :'id' => :'String',
-        :'object' => :'String',
         :'created_at' => :'Integer',
-        :'updated_at' => :'Integer',
-        :'model' => :'String',
-        :'fine_tuned_model' => :'String',
-        :'organization_id' => :'String',
-        :'status' => :'String',
-        :'hyperparams' => :'Object',
-        :'training_files' => :'Array<OpenAIFile>',
-        :'validation_files' => :'Array<OpenAIFile>',
-        :'result_files' => :'Array<OpenAIFile>',
-        :'events' => :'Array<FineTuneEvent>'
+        :'fine_tuned_model_checkpoint' => :'String',
+        :'step_number' => :'Integer',
+        :'metrics' => :'FineTuningJobCheckpointMetrics',
+        :'fine_tuning_job_id' => :'String',
+        :'object' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'fine_tuned_model',
       ])
     end
 
@@ -95,13 +99,13 @@ module OpenApiOpenAIClient
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::FineTune` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::FineTuningJobCheckpoint` 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::FineTune`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::FineTuningJobCheckpoint`. 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
       }
@@ -112,82 +116,40 @@ module OpenApiOpenAIClient
         self.id = nil
       end
 
-      if attributes.key?(:'object')
-        self.object = attributes[:'object']
-      else
-        self.object = nil
-      end
-
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       else
         self.created_at = nil
       end
 
-      if attributes.key?(:'updated_at')
-        self.updated_at = attributes[:'updated_at']
-      else
-        self.updated_at = nil
-      end
-
-      if attributes.key?(:'model')
-        self.model = attributes[:'model']
-      else
-        self.model = nil
-      end
-
-      if attributes.key?(:'fine_tuned_model')
-        self.fine_tuned_model = attributes[:'fine_tuned_model']
+      if attributes.key?(:'fine_tuned_model_checkpoint')
+        self.fine_tuned_model_checkpoint = attributes[:'fine_tuned_model_checkpoint']
       else
-        self.fine_tuned_model = nil
+        self.fine_tuned_model_checkpoint = nil
       end
 
-      if attributes.key?(:'organization_id')
-        self.organization_id = attributes[:'organization_id']
+      if attributes.key?(:'step_number')
+        self.step_number = attributes[:'step_number']
       else
-        self.organization_id = nil
+        self.step_number = nil
       end
 
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
+      if attributes.key?(:'metrics')
+        self.metrics = attributes[:'metrics']
       else
-        self.status = nil
+        self.metrics = nil
       end
 
-      if attributes.key?(:'hyperparams')
-        self.hyperparams = attributes[:'hyperparams']
+      if attributes.key?(:'fine_tuning_job_id')
+        self.fine_tuning_job_id = attributes[:'fine_tuning_job_id']
       else
-        self.hyperparams = nil
+        self.fine_tuning_job_id = nil
       end
 
-      if attributes.key?(:'training_files')
-        if (value = attributes[:'training_files']).is_a?(Array)
-          self.training_files = value
-        end
-      else
-        self.training_files = nil
-      end
-
-      if attributes.key?(:'validation_files')
-        if (value = attributes[:'validation_files']).is_a?(Array)
-          self.validation_files = value
-        end
-      else
-        self.validation_files = nil
-      end
-
-      if attributes.key?(:'result_files')
-        if (value = attributes[:'result_files']).is_a?(Array)
-          self.result_files = value
-        end
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
       else
-        self.result_files = nil
-      end
-
-      if attributes.key?(:'events')
-        if (value = attributes[:'events']).is_a?(Array)
-          self.events = value
-        end
+        self.object = nil
       end
     end
 
@@ -200,44 +162,28 @@ module OpenApiOpenAIClient
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @object.nil?
-        invalid_properties.push('invalid value for "object", object cannot be nil.')
-      end
-
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
-      if @updated_at.nil?
-        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      if @fine_tuned_model_checkpoint.nil?
+        invalid_properties.push('invalid value for "fine_tuned_model_checkpoint", fine_tuned_model_checkpoint cannot be nil.')
       end
 
-      if @model.nil?
-        invalid_properties.push('invalid value for "model", model cannot be nil.')
+      if @step_number.nil?
+        invalid_properties.push('invalid value for "step_number", step_number cannot be nil.')
       end
 
-      if @organization_id.nil?
-        invalid_properties.push('invalid value for "organization_id", organization_id cannot be nil.')
+      if @metrics.nil?
+        invalid_properties.push('invalid value for "metrics", metrics cannot be nil.')
       end
 
-      if @status.nil?
-        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      if @fine_tuning_job_id.nil?
+        invalid_properties.push('invalid value for "fine_tuning_job_id", fine_tuning_job_id cannot be nil.')
       end
 
-      if @hyperparams.nil?
-        invalid_properties.push('invalid value for "hyperparams", hyperparams cannot be nil.')
-      end
-
-      if @training_files.nil?
-        invalid_properties.push('invalid value for "training_files", training_files cannot be nil.')
-      end
-
-      if @validation_files.nil?
-        invalid_properties.push('invalid value for "validation_files", validation_files cannot be nil.')
-      end
-
-      if @result_files.nil?
-        invalid_properties.push('invalid value for "result_files", result_files cannot be nil.')
+      if @object.nil?
+        invalid_properties.push('invalid value for "object", object cannot be nil.')
       end
 
       invalid_properties
@@ -248,37 +194,39 @@ module OpenApiOpenAIClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
-      return false if @object.nil?
       return false if @created_at.nil?
-      return false if @updated_at.nil?
-      return false if @model.nil?
-      return false if @organization_id.nil?
-      return false if @status.nil?
-      return false if @hyperparams.nil?
-      return false if @training_files.nil?
-      return false if @validation_files.nil?
-      return false if @result_files.nil?
+      return false if @fine_tuned_model_checkpoint.nil?
+      return false if @step_number.nil?
+      return false if @metrics.nil?
+      return false if @fine_tuning_job_id.nil?
+      return false if @object.nil?
+      object_validator = EnumAttributeValidator.new('String', ["fine_tuning.job.checkpoint"])
+      return false unless object_validator.valid?(@object)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] object Object to be assigned
+    def object=(object)
+      validator = EnumAttributeValidator.new('String', ["fine_tuning.job.checkpoint"])
+      unless validator.valid?(object)
+        fail ArgumentError, "invalid value for \"object\", must be one of #{validator.allowable_values}."
+      end
+      @object = object
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          object == o.object &&
           created_at == o.created_at &&
-          updated_at == o.updated_at &&
-          model == o.model &&
-          fine_tuned_model == o.fine_tuned_model &&
-          organization_id == o.organization_id &&
-          status == o.status &&
-          hyperparams == o.hyperparams &&
-          training_files == o.training_files &&
-          validation_files == o.validation_files &&
-          result_files == o.result_files &&
-          events == o.events
+          fine_tuned_model_checkpoint == o.fine_tuned_model_checkpoint &&
+          step_number == o.step_number &&
+          metrics == o.metrics &&
+          fine_tuning_job_id == o.fine_tuning_job_id &&
+          object == o.object
     end
 
     # @see the `==` method
@@ -290,7 +238,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, object, created_at, updated_at, model, fine_tuned_model, organization_id, status, hyperparams, training_files, validation_files, result_files, events].hash
+      [id, created_at, fine_tuned_model_checkpoint, step_number, metrics, fine_tuning_job_id, object].hash
     end
 
     # Builds the object from hash

data/lib/openapi_openai/models/fine_tuning_job_checkpoint_metrics.rb

@@ -0,0 +1,269 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module OpenApiOpenAIClient
+  # Metrics at the step number during the fine-tuning job.
+  class FineTuningJobCheckpointMetrics
+    attr_accessor :step
+
+    attr_accessor :train_loss
+
+    attr_accessor :train_mean_token_accuracy
+
+    attr_accessor :valid_loss
+
+    attr_accessor :valid_mean_token_accuracy
+
+    attr_accessor :full_valid_loss
+
+    attr_accessor :full_valid_mean_token_accuracy
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'step' => :'step',
+        :'train_loss' => :'train_loss',
+        :'train_mean_token_accuracy' => :'train_mean_token_accuracy',
+        :'valid_loss' => :'valid_loss',
+        :'valid_mean_token_accuracy' => :'valid_mean_token_accuracy',
+        :'full_valid_loss' => :'full_valid_loss',
+        :'full_valid_mean_token_accuracy' => :'full_valid_mean_token_accuracy'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'step' => :'Float',
+        :'train_loss' => :'Float',
+        :'train_mean_token_accuracy' => :'Float',
+        :'valid_loss' => :'Float',
+        :'valid_mean_token_accuracy' => :'Float',
+        :'full_valid_loss' => :'Float',
+        :'full_valid_mean_token_accuracy' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::FineTuningJobCheckpointMetrics` 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::FineTuningJobCheckpointMetrics`. 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?(:'step')
+        self.step = attributes[:'step']
+      end
+
+      if attributes.key?(:'train_loss')
+        self.train_loss = attributes[:'train_loss']
+      end
+
+      if attributes.key?(:'train_mean_token_accuracy')
+        self.train_mean_token_accuracy = attributes[:'train_mean_token_accuracy']
+      end
+
+      if attributes.key?(:'valid_loss')
+        self.valid_loss = attributes[:'valid_loss']
+      end
+
+      if attributes.key?(:'valid_mean_token_accuracy')
+        self.valid_mean_token_accuracy = attributes[:'valid_mean_token_accuracy']
+      end
+
+      if attributes.key?(:'full_valid_loss')
+        self.full_valid_loss = attributes[:'full_valid_loss']
+      end
+
+      if attributes.key?(:'full_valid_mean_token_accuracy')
+        self.full_valid_mean_token_accuracy = attributes[:'full_valid_mean_token_accuracy']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          step == o.step &&
+          train_loss == o.train_loss &&
+          train_mean_token_accuracy == o.train_mean_token_accuracy &&
+          valid_loss == o.valid_loss &&
+          valid_mean_token_accuracy == o.valid_mean_token_accuracy &&
+          full_valid_loss == o.full_valid_loss &&
+          full_valid_mean_token_accuracy == o.full_valid_mean_token_accuracy
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [step, train_loss, train_mean_token_accuracy, valid_loss, valid_mean_token_accuracy, full_valid_loss, full_valid_mean_token_accuracy].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+
+  end
+
+end