openapi_openai 1.0.0 → 1.1.0

data/lib/openapi_openai/models/create_fine_tuning_job_request_integrations_inner_wandb.rb

@@ -0,0 +1,257 @@
+=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
+  # The settings for your integration with Weights and Biases. This payload specifies the project that metrics will be sent to. Optionally, you can set an explicit display name for your run, add tags to your run, and set a default entity (team, username, etc) to be associated with your run. 
+  class CreateFineTuningJobRequestIntegrationsInnerWandb
+    # The name of the project that the new run will be created under. 
+    attr_accessor :project
+
+    # A display name to set for the run. If not set, we will use the Job ID as the name. 
+    attr_accessor :name
+
+    # The entity to use for the run. This allows you to set the team or username of the WandB user that you would like associated with the run. If not set, the default entity for the registered WandB API key is used. 
+    attr_accessor :entity
+
+    # A list of tags to be attached to the newly created run. These tags are passed through directly to WandB. Some default tags are generated by OpenAI: \"openai/finetune\", \"openai/{base-model}\", \"openai/{ftjob-abcdef}\". 
+    attr_accessor :tags
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'project' => :'project',
+        :'name' => :'name',
+        :'entity' => :'entity',
+        :'tags' => :'tags'
+      }
+    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
+      {
+        :'project' => :'String',
+        :'name' => :'String',
+        :'entity' => :'String',
+        :'tags' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'entity',
+      ])
+    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::CreateFineTuningJobRequestIntegrationsInnerWandb` 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::CreateFineTuningJobRequestIntegrationsInnerWandb`. 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?(:'project')
+        self.project = attributes[:'project']
+      else
+        self.project = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'entity')
+        self.entity = attributes[:'entity']
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      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
+      if @project.nil?
+        invalid_properties.push('invalid value for "project", project cannot be nil.')
+      end
+
+      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'
+      return false if @project.nil?
+      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 &&
+          project == o.project &&
+          name == o.name &&
+          entity == o.entity &&
+          tags == o.tags
+    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
+      [project, name, entity, tags].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

data/lib/openapi_openai/models/create_fine_tuning_job_request_model.rb

@@ -0,0 +1,104 @@
+=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
+  # The name of the model to fine-tune. You can select one of the [supported models](/docs/guides/fine-tuning/what-models-can-be-fine-tuned). 
+  module CreateFineTuningJobRequestModel
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = OpenApiOpenAIClient.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/openapi_openai/models/create_image_edit_request_model.rb

@@ -0,0 +1,104 @@
+=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
+  # The model to use for image generation. Only `dall-e-2` is supported at this time.
+  module CreateImageEditRequestModel
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = OpenApiOpenAIClient.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/openapi_openai/models/create_image_request.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
@@ -15,18 +15,26 @@ require 'time'
 
 module OpenApiOpenAIClient
   class CreateImageRequest
-    # A text description of the desired image(s). The maximum length is 1000 characters.
+    # A text description of the desired image(s). The maximum length is 1000 characters for `dall-e-2` and 4000 characters for `dall-e-3`.
     attr_accessor :prompt
 
-    # The number of images to generate. Must be between 1 and 10.
+    attr_accessor :model
+
+    # The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.
     attr_accessor :n
 
-    # The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.
-    attr_accessor :size
+    # The quality of the image that will be generated. `hd` creates images with finer details and greater consistency across the image. This param is only supported for `dall-e-3`.
+    attr_accessor :quality
 
-    # The format in which the generated images are returned. Must be one of `url` or `b64_json`.
+    # The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated.
     attr_accessor :response_format
 
+    # The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`. Must be one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3` models.
+    attr_accessor :size
+
+    # The style of the generated images. Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for `dall-e-3`.
+    attr_accessor :style
+
     # A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids). 
     attr_accessor :user
 
@@ -56,9 +64,12 @@ module OpenApiOpenAIClient
     def self.attribute_map
       {
         :'prompt' => :'prompt',
+        :'model' => :'model',
         :'n' => :'n',
-        :'size' => :'size',
+        :'quality' => :'quality',
         :'response_format' => :'response_format',
+        :'size' => :'size',
+        :'style' => :'style',
         :'user' => :'user'
       }
     end
@@ -72,9 +83,12 @@ module OpenApiOpenAIClient
     def self.openapi_types
       {
         :'prompt' => :'String',
+        :'model' => :'CreateImageRequestModel',
         :'n' => :'Integer',
-        :'size' => :'String',
+        :'quality' => :'String',
         :'response_format' => :'String',
+        :'size' => :'String',
+        :'style' => :'String',
         :'user' => :'String'
       }
     end
@@ -82,9 +96,11 @@ module OpenApiOpenAIClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'model',
         :'n',
-        :'size',
         :'response_format',
+        :'size',
+        :'style',
       ])
     end
 
@@ -109,16 +125,20 @@ module OpenApiOpenAIClient
         self.prompt = nil
       end
 
+      if attributes.key?(:'model')
+        self.model = attributes[:'model']
+      end
+
       if attributes.key?(:'n')
         self.n = attributes[:'n']
       else
         self.n = 1
       end
 
-      if attributes.key?(:'size')
-        self.size = attributes[:'size']
+      if attributes.key?(:'quality')
+        self.quality = attributes[:'quality']
       else
-        self.size = '1024x1024'
+        self.quality = 'standard'
       end
 
       if attributes.key?(:'response_format')
@@ -127,6 +147,18 @@ module OpenApiOpenAIClient
         self.response_format = 'url'
       end
 
+      if attributes.key?(:'size')
+        self.size = attributes[:'size']
+      else
+        self.size = '1024x1024'
+      end
+
+      if attributes.key?(:'style')
+        self.style = attributes[:'style']
+      else
+        self.style = 'vivid'
+      end
+
       if attributes.key?(:'user')
         self.user = attributes[:'user']
       end
@@ -159,10 +191,14 @@ module OpenApiOpenAIClient
       return false if @prompt.nil?
       return false if !@n.nil? && @n > 10
       return false if !@n.nil? && @n < 1
-      size_validator = EnumAttributeValidator.new('String', ["256x256", "512x512", "1024x1024"])
-      return false unless size_validator.valid?(@size)
+      quality_validator = EnumAttributeValidator.new('String', ["standard", "hd"])
+      return false unless quality_validator.valid?(@quality)
       response_format_validator = EnumAttributeValidator.new('String', ["url", "b64_json"])
       return false unless response_format_validator.valid?(@response_format)
+      size_validator = EnumAttributeValidator.new('String', ["256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"])
+      return false unless size_validator.valid?(@size)
+      style_validator = EnumAttributeValidator.new('String', ["vivid", "natural"])
+      return false unless style_validator.valid?(@style)
       true
     end
 
@@ -181,13 +217,13 @@ module OpenApiOpenAIClient
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] size Object to be assigned
-    def size=(size)
-      validator = EnumAttributeValidator.new('String', ["256x256", "512x512", "1024x1024"])
-      unless validator.valid?(size)
-        fail ArgumentError, "invalid value for \"size\", must be one of #{validator.allowable_values}."
+    # @param [Object] quality Object to be assigned
+    def quality=(quality)
+      validator = EnumAttributeValidator.new('String', ["standard", "hd"])
+      unless validator.valid?(quality)
+        fail ArgumentError, "invalid value for \"quality\", must be one of #{validator.allowable_values}."
       end
-      @size = size
+      @quality = quality
     end
 
     # Custom attribute writer method checking allowed values (enum).
@@ -200,15 +236,38 @@ module OpenApiOpenAIClient
       @response_format = response_format
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] size Object to be assigned
+    def size=(size)
+      validator = EnumAttributeValidator.new('String', ["256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"])
+      unless validator.valid?(size)
+        fail ArgumentError, "invalid value for \"size\", must be one of #{validator.allowable_values}."
+      end
+      @size = size
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] style Object to be assigned
+    def style=(style)
+      validator = EnumAttributeValidator.new('String', ["vivid", "natural"])
+      unless validator.valid?(style)
+        fail ArgumentError, "invalid value for \"style\", must be one of #{validator.allowable_values}."
+      end
+      @style = style
+    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 &&
           prompt == o.prompt &&
+          model == o.model &&
           n == o.n &&
-          size == o.size &&
+          quality == o.quality &&
           response_format == o.response_format &&
+          size == o.size &&
+          style == o.style &&
           user == o.user
     end
 
@@ -221,7 +280,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [prompt, n, size, response_format, user].hash
+      [prompt, model, n, quality, response_format, size, style, user].hash
     end
 
     # Builds the object from hash