azure_openai_client 0.0.1

data/lib/azure_openai_client/models/chat_completions_body.rb

@@ -0,0 +1,334 @@
+# frozen_string_literal: true
+
+=begin
+#Azure OpenAI Service API
+
+#Azure OpenAI APIs for completions and search
+
+OpenAPI spec version: 2023-05-15
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.42
+=end
+
+require 'date'
+
+module AzureOpenaiClient
+  class ChatCompletionsBody
+    # The messages to generate chat completions for, in the chat format.
+    attr_accessor :messages
+
+    # 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 as they become available, with the stream terminated by a `data: [DONE]` message.
+    attr_accessor :stream
+
+    # Up to 4 sequences where the API will stop generating further tokens.
+    attr_accessor :stop
+
+    # The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt 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.
+    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.
+    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 Azure OpenAI to monitor and detect abuse.
+    attr_accessor :user
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        'messages': :'messages',
+        '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
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        'messages': :'Object',
+        'temperature': :'Object',
+        'top_p': :'Object',
+        'n': :'Object',
+        'stream': :'Object',
+        'stop': :'Object',
+        'max_tokens': :'Object',
+        'presence_penalty': :'Object',
+        'frequency_penalty': :'Object',
+        'logit_bias': :'Object',
+        'user': :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'temperature',
+        :'top_p',
+        :'n',
+        :'stream',
+        :'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 `AzureOpenaiClient::ChatCompletionsBody` 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 `AzureOpenaiClient::ChatCompletionsBody`. 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?(:'messages')
+        if (value = attributes[:'messages']).is_a?(Array)
+          self.messages = value
+        end
+      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
+      invalid_properties = Array.new
+      if @messages.nil?
+        invalid_properties.push('invalid value for "messages", messages 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?
+      return false if @messages.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 &&
+          messages == o.messages &&
+          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
+      [messages, 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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        AzureOpenaiClient.const_get(type).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