openapi_openai 1.0.0 → 1.1.0

data/lib/openapi_openai/models/{create_edit_request.rb → create_speech_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
@@ -14,33 +14,51 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
-  class CreateEditRequest
+  class CreateSpeechRequest
     attr_accessor :model
 
-    # The input text to use as a starting point for the edit.
+    # The text to generate audio for. The maximum length is 4096 characters.
     attr_accessor :input
 
-    # The instruction that tells the model how to edit the prompt.
-    attr_accessor :instruction
+    # The voice to use when generating the audio. Supported voices are `alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer`. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech/voice-options).
+    attr_accessor :voice
 
-    # How many edits to generate for the input and instruction.
-    attr_accessor :n
+    # The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`.
+    attr_accessor :response_format
 
-    # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.  We generally recommend altering this or `top_p` but not both. 
-    attr_accessor :temperature
+    # The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the default.
+    attr_accessor :speed
 
-    # An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.  We generally recommend altering this or `temperature` but not both. 
-    attr_accessor :top_p
+    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
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'model' => :'model',
         :'input' => :'input',
-        :'instruction' => :'instruction',
-        :'n' => :'n',
-        :'temperature' => :'temperature',
-        :'top_p' => :'top_p'
+        :'voice' => :'voice',
+        :'response_format' => :'response_format',
+        :'speed' => :'speed'
       }
     end
 
@@ -52,22 +70,17 @@ module OpenApiOpenAIClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'model' => :'CreateEditRequestModel',
+        :'model' => :'CreateSpeechRequestModel',
         :'input' => :'String',
-        :'instruction' => :'String',
-        :'n' => :'Integer',
-        :'temperature' => :'Float',
-        :'top_p' => :'Float'
+        :'voice' => :'String',
+        :'response_format' => :'String',
+        :'speed' => :'Float'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'input',
-        :'n',
-        :'temperature',
-        :'top_p'
       ])
     end
 
@@ -75,13 +88,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::CreateEditRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::CreateSpeechRequest` 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::CreateEditRequest`. 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::CreateSpeechRequest`. 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
       }
@@ -95,31 +108,25 @@ module OpenApiOpenAIClient
       if attributes.key?(:'input')
         self.input = attributes[:'input']
       else
-        self.input = ''
-      end
-
-      if attributes.key?(:'instruction')
-        self.instruction = attributes[:'instruction']
-      else
-        self.instruction = nil
+        self.input = nil
       end
 
-      if attributes.key?(:'n')
-        self.n = attributes[:'n']
+      if attributes.key?(:'voice')
+        self.voice = attributes[:'voice']
       else
-        self.n = 1
+        self.voice = nil
       end
 
-      if attributes.key?(:'temperature')
-        self.temperature = attributes[:'temperature']
+      if attributes.key?(:'response_format')
+        self.response_format = attributes[:'response_format']
       else
-        self.temperature = 1
+        self.response_format = 'mp3'
       end
 
-      if attributes.key?(:'top_p')
-        self.top_p = attributes[:'top_p']
+      if attributes.key?(:'speed')
+        self.speed = attributes[:'speed']
       else
-        self.top_p = 1
+        self.speed = 1.0
       end
     end
 
@@ -132,32 +139,24 @@ module OpenApiOpenAIClient
         invalid_properties.push('invalid value for "model", model cannot be nil.')
       end
 
-      if @instruction.nil?
-        invalid_properties.push('invalid value for "instruction", instruction cannot be nil.')
+      if @input.nil?
+        invalid_properties.push('invalid value for "input", input cannot be nil.')
       end
 
-      if !@n.nil? && @n > 20
-        invalid_properties.push('invalid value for "n", must be smaller than or equal to 20.')
+      if @input.to_s.length > 4096
+        invalid_properties.push('invalid value for "input", the character length must be smaller than or equal to 4096.')
       end
 
-      if !@n.nil? && @n < 1
-        invalid_properties.push('invalid value for "n", must be greater than or equal to 1.')
+      if @voice.nil?
+        invalid_properties.push('invalid value for "voice", voice cannot be nil.')
       end
 
-      if !@temperature.nil? && @temperature > 2
-        invalid_properties.push('invalid value for "temperature", must be smaller than or equal to 2.')
+      if !@speed.nil? && @speed > 4.0
+        invalid_properties.push('invalid value for "speed", must be smaller than or equal to 4.0.')
       end
 
-      if !@temperature.nil? && @temperature < 0
-        invalid_properties.push('invalid value for "temperature", must be greater than or equal to 0.')
-      end
-
-      if !@top_p.nil? && @top_p > 1
-        invalid_properties.push('invalid value for "top_p", must be smaller than or equal to 1.')
-      end
-
-      if !@top_p.nil? && @top_p < 0
-        invalid_properties.push('invalid value for "top_p", must be greater than or equal to 0.')
+      if !@speed.nil? && @speed < 0.25
+        invalid_properties.push('invalid value for "speed", must be greater than or equal to 0.25.')
       end
 
       invalid_properties
@@ -168,56 +167,68 @@ module OpenApiOpenAIClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @model.nil?
-      return false if @instruction.nil?
-      return false if !@n.nil? && @n > 20
-      return false if !@n.nil? && @n < 1
-      return false if !@temperature.nil? && @temperature > 2
-      return false if !@temperature.nil? && @temperature < 0
-      return false if !@top_p.nil? && @top_p > 1
-      return false if !@top_p.nil? && @top_p < 0
+      return false if @input.nil?
+      return false if @input.to_s.length > 4096
+      return false if @voice.nil?
+      voice_validator = EnumAttributeValidator.new('String', ["alloy", "echo", "fable", "onyx", "nova", "shimmer"])
+      return false unless voice_validator.valid?(@voice)
+      response_format_validator = EnumAttributeValidator.new('String', ["mp3", "opus", "aac", "flac", "wav", "pcm"])
+      return false unless response_format_validator.valid?(@response_format)
+      return false if !@speed.nil? && @speed > 4.0
+      return false if !@speed.nil? && @speed < 0.25
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] n Value to be assigned
-    def n=(n)
-      if !n.nil? && n > 20
-        fail ArgumentError, 'invalid value for "n", must be smaller than or equal to 20.'
+    # @param [Object] input Value to be assigned
+    def input=(input)
+      if input.nil?
+        fail ArgumentError, 'input cannot be nil'
       end
 
-      if !n.nil? && n < 1
-        fail ArgumentError, 'invalid value for "n", must be greater than or equal to 1.'
+      if input.to_s.length > 4096
+        fail ArgumentError, 'invalid value for "input", the character length must be smaller than or equal to 4096.'
       end
 
-      @n = n
+      @input = input
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] temperature Value to be assigned
-    def temperature=(temperature)
-      if !temperature.nil? && temperature > 2
-        fail ArgumentError, 'invalid value for "temperature", must be smaller than or equal to 2.'
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] voice Object to be assigned
+    def voice=(voice)
+      validator = EnumAttributeValidator.new('String', ["alloy", "echo", "fable", "onyx", "nova", "shimmer"])
+      unless validator.valid?(voice)
+        fail ArgumentError, "invalid value for \"voice\", must be one of #{validator.allowable_values}."
       end
+      @voice = voice
+    end
 
-      if !temperature.nil? && temperature < 0
-        fail ArgumentError, 'invalid value for "temperature", must be greater than or equal to 0.'
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] response_format Object to be assigned
+    def response_format=(response_format)
+      validator = EnumAttributeValidator.new('String', ["mp3", "opus", "aac", "flac", "wav", "pcm"])
+      unless validator.valid?(response_format)
+        fail ArgumentError, "invalid value for \"response_format\", must be one of #{validator.allowable_values}."
       end
-
-      @temperature = temperature
+      @response_format = response_format
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] top_p Value to be assigned
-    def top_p=(top_p)
-      if !top_p.nil? && top_p > 1
-        fail ArgumentError, 'invalid value for "top_p", must be smaller than or equal to 1.'
+    # @param [Object] speed Value to be assigned
+    def speed=(speed)
+      if speed.nil?
+        fail ArgumentError, 'speed cannot be nil'
+      end
+
+      if speed > 4.0
+        fail ArgumentError, 'invalid value for "speed", must be smaller than or equal to 4.0.'
       end
 
-      if !top_p.nil? && top_p < 0
-        fail ArgumentError, 'invalid value for "top_p", must be greater than or equal to 0.'
+      if speed < 0.25
+        fail ArgumentError, 'invalid value for "speed", must be greater than or equal to 0.25.'
       end
 
-      @top_p = top_p
+      @speed = speed
     end
 
     # Checks equality by comparing each attribute.
@@ -227,10 +238,9 @@ module OpenApiOpenAIClient
       self.class == o.class &&
           model == o.model &&
           input == o.input &&
-          instruction == o.instruction &&
-          n == o.n &&
-          temperature == o.temperature &&
-          top_p == o.top_p
+          voice == o.voice &&
+          response_format == o.response_format &&
+          speed == o.speed
     end
 
     # @see the `==` method
@@ -242,7 +252,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [model, input, instruction, n, temperature, top_p].hash
+      [model, input, voice, response_format, speed].hash
     end
 
     # Builds the object from hash

data/lib/openapi_openai/models/create_speech_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
+  # One of the available [TTS models](/docs/models/tts): `tts-1` or `tts-1-hd` 
+  module CreateSpeechRequestModel
+    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