openapi_openai 1.0.0

data/lib/openapi_openai/models/create_chat_completion_request.rb

@@ -0,0 +1,537 @@
+=begin
+#OpenAI API
+
+#APIs for sampling from and fine-tuning language models
+
+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
+  class CreateChatCompletionRequest
+    attr_accessor :model
+
+    # A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb).
+    attr_accessor :messages
+
+    # A list of functions the model may generate JSON inputs for.
+    attr_accessor :functions
+
+    attr_accessor :function_call
+
+    # 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
+
+    # 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
+
+    # How many chat completion choices to generate for each input message.
+    attr_accessor :n
+
+    # If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb). 
+    attr_accessor :stream
+
+    attr_accessor :stop
+
+    # The maximum number of [tokens](/tokenizer) to generate in the chat completion.  The total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb) for counting tokens. 
+    attr_accessor :max_tokens
+
+    # Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.  [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details) 
+    attr_accessor :presence_penalty
+
+    # Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.  [See more information about frequency and presence penalties.](/docs/api-reference/parameter-details) 
+    attr_accessor :frequency_penalty
+
+    # Modify the likelihood of specified tokens appearing in the completion.  Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. 
+    attr_accessor :logit_bias
+
+    # 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
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'model' => :'model',
+        :'messages' => :'messages',
+        :'functions' => :'functions',
+        :'function_call' => :'function_call',
+        :'temperature' => :'temperature',
+        :'top_p' => :'top_p',
+        :'n' => :'n',
+        :'stream' => :'stream',
+        :'stop' => :'stop',
+        :'max_tokens' => :'max_tokens',
+        :'presence_penalty' => :'presence_penalty',
+        :'frequency_penalty' => :'frequency_penalty',
+        :'logit_bias' => :'logit_bias',
+        :'user' => :'user'
+      }
+    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
+      {
+        :'model' => :'CreateChatCompletionRequestModel',
+        :'messages' => :'Array<ChatCompletionRequestMessage>',
+        :'functions' => :'Array<ChatCompletionFunctions>',
+        :'function_call' => :'CreateChatCompletionRequestFunctionCall',
+        :'temperature' => :'Float',
+        :'top_p' => :'Float',
+        :'n' => :'Integer',
+        :'stream' => :'Boolean',
+        :'stop' => :'CreateChatCompletionRequestStop',
+        :'max_tokens' => :'Integer',
+        :'presence_penalty' => :'Float',
+        :'frequency_penalty' => :'Float',
+        :'logit_bias' => :'Object',
+        :'user' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'temperature',
+        :'top_p',
+        :'n',
+        :'stream',
+        :'presence_penalty',
+        :'frequency_penalty',
+        :'logit_bias',
+      ])
+    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::CreateChatCompletionRequest` 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::CreateChatCompletionRequest`. 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?(:'model')
+        self.model = attributes[:'model']
+      else
+        self.model = nil
+      end
+
+      if attributes.key?(:'messages')
+        if (value = attributes[:'messages']).is_a?(Array)
+          self.messages = value
+        end
+      else
+        self.messages = nil
+      end
+
+      if attributes.key?(:'functions')
+        if (value = attributes[:'functions']).is_a?(Array)
+          self.functions = value
+        end
+      end
+
+      if attributes.key?(:'function_call')
+        self.function_call = attributes[:'function_call']
+      end
+
+      if attributes.key?(:'temperature')
+        self.temperature = attributes[:'temperature']
+      else
+        self.temperature = 1
+      end
+
+      if attributes.key?(:'top_p')
+        self.top_p = attributes[:'top_p']
+      else
+        self.top_p = 1
+      end
+
+      if attributes.key?(:'n')
+        self.n = attributes[:'n']
+      else
+        self.n = 1
+      end
+
+      if attributes.key?(:'stream')
+        self.stream = attributes[:'stream']
+      else
+        self.stream = false
+      end
+
+      if attributes.key?(:'stop')
+        self.stop = attributes[:'stop']
+      end
+
+      if attributes.key?(:'max_tokens')
+        self.max_tokens = attributes[:'max_tokens']
+      end
+
+      if attributes.key?(:'presence_penalty')
+        self.presence_penalty = attributes[:'presence_penalty']
+      else
+        self.presence_penalty = 0
+      end
+
+      if attributes.key?(:'frequency_penalty')
+        self.frequency_penalty = attributes[:'frequency_penalty']
+      else
+        self.frequency_penalty = 0
+      end
+
+      if attributes.key?(:'logit_bias')
+        self.logit_bias = attributes[:'logit_bias']
+      end
+
+      if attributes.key?(:'user')
+        self.user = attributes[:'user']
+      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 @model.nil?
+        invalid_properties.push('invalid value for "model", model cannot be nil.')
+      end
+
+      if @messages.nil?
+        invalid_properties.push('invalid value for "messages", messages cannot be nil.')
+      end
+
+      if @messages.length < 1
+        invalid_properties.push('invalid value for "messages", number of items must be greater than or equal to 1.')
+      end
+
+      if !@functions.nil? && @functions.length < 1
+        invalid_properties.push('invalid value for "functions", number of items must be greater than or equal to 1.')
+      end
+
+      if !@temperature.nil? && @temperature > 2
+        invalid_properties.push('invalid value for "temperature", must be smaller than or equal to 2.')
+      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.')
+      end
+
+      if !@n.nil? && @n > 128
+        invalid_properties.push('invalid value for "n", must be smaller than or equal to 128.')
+      end
+
+      if !@n.nil? && @n < 1
+        invalid_properties.push('invalid value for "n", must be greater than or equal to 1.')
+      end
+
+      if !@presence_penalty.nil? && @presence_penalty > 2
+        invalid_properties.push('invalid value for "presence_penalty", must be smaller than or equal to 2.')
+      end
+
+      if !@presence_penalty.nil? && @presence_penalty < -2
+        invalid_properties.push('invalid value for "presence_penalty", must be greater than or equal to -2.')
+      end
+
+      if !@frequency_penalty.nil? && @frequency_penalty > 2
+        invalid_properties.push('invalid value for "frequency_penalty", must be smaller than or equal to 2.')
+      end
+
+      if !@frequency_penalty.nil? && @frequency_penalty < -2
+        invalid_properties.push('invalid value for "frequency_penalty", must be greater than or equal to -2.')
+      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 @model.nil?
+      return false if @messages.nil?
+      return false if @messages.length < 1
+      return false if !@functions.nil? && @functions.length < 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 !@n.nil? && @n > 128
+      return false if !@n.nil? && @n < 1
+      return false if !@presence_penalty.nil? && @presence_penalty > 2
+      return false if !@presence_penalty.nil? && @presence_penalty < -2
+      return false if !@frequency_penalty.nil? && @frequency_penalty > 2
+      return false if !@frequency_penalty.nil? && @frequency_penalty < -2
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] messages Value to be assigned
+    def messages=(messages)
+      if messages.nil?
+        fail ArgumentError, 'messages cannot be nil'
+      end
+
+      if messages.length < 1
+        fail ArgumentError, 'invalid value for "messages", number of items must be greater than or equal to 1.'
+      end
+
+      @messages = messages
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] functions Value to be assigned
+    def functions=(functions)
+      if functions.nil?
+        fail ArgumentError, 'functions cannot be nil'
+      end
+
+      if functions.length < 1
+        fail ArgumentError, 'invalid value for "functions", number of items must be greater than or equal to 1.'
+      end
+
+      @functions = functions
+    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.'
+      end
+
+      if !temperature.nil? && temperature < 0
+        fail ArgumentError, 'invalid value for "temperature", must be greater than or equal to 0.'
+      end
+
+      @temperature = temperature
+    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.'
+      end
+
+      if !top_p.nil? && top_p < 0
+        fail ArgumentError, 'invalid value for "top_p", must be greater than or equal to 0.'
+      end
+
+      @top_p = top_p
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] n Value to be assigned
+    def n=(n)
+      if !n.nil? && n > 128
+        fail ArgumentError, 'invalid value for "n", must be smaller than or equal to 128.'
+      end
+
+      if !n.nil? && n < 1
+        fail ArgumentError, 'invalid value for "n", must be greater than or equal to 1.'
+      end
+
+      @n = n
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] presence_penalty Value to be assigned
+    def presence_penalty=(presence_penalty)
+      if !presence_penalty.nil? && presence_penalty > 2
+        fail ArgumentError, 'invalid value for "presence_penalty", must be smaller than or equal to 2.'
+      end
+
+      if !presence_penalty.nil? && presence_penalty < -2
+        fail ArgumentError, 'invalid value for "presence_penalty", must be greater than or equal to -2.'
+      end
+
+      @presence_penalty = presence_penalty
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] frequency_penalty Value to be assigned
+    def frequency_penalty=(frequency_penalty)
+      if !frequency_penalty.nil? && frequency_penalty > 2
+        fail ArgumentError, 'invalid value for "frequency_penalty", must be smaller than or equal to 2.'
+      end
+
+      if !frequency_penalty.nil? && frequency_penalty < -2
+        fail ArgumentError, 'invalid value for "frequency_penalty", must be greater than or equal to -2.'
+      end
+
+      @frequency_penalty = frequency_penalty
+    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 &&
+          model == o.model &&
+          messages == o.messages &&
+          functions == o.functions &&
+          function_call == o.function_call &&
+          temperature == o.temperature &&
+          top_p == o.top_p &&
+          n == o.n &&
+          stream == o.stream &&
+          stop == o.stop &&
+          max_tokens == o.max_tokens &&
+          presence_penalty == o.presence_penalty &&
+          frequency_penalty == o.frequency_penalty &&
+          logit_bias == o.logit_bias &&
+          user == o.user
+    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
+      [model, messages, functions, function_call, temperature, top_p, n, stream, stop, max_tokens, presence_penalty, frequency_penalty, logit_bias, user].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_chat_completion_request_function_call.rb

@@ -0,0 +1,106 @@
+=begin
+#OpenAI API
+
+#APIs for sampling from and fine-tuning language models
+
+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
+  # Controls how the model responds to function calls. \"none\" means the model does not call a function, and responds to the end-user. \"auto\" means the model can pick between an end-user or calling a function.  Specifying a particular function via `{\"name\":\\ \"my_function\"}` forces the model to call that function. \"none\" is the default when no functions are present. \"auto\" is the default if functions are present.
+  module CreateChatCompletionRequestFunctionCall
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'CreateChatCompletionRequestFunctionCallOneOf',
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - 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_one_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_one_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_one_of) # nested oneOf 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