venice_client 1.0.0 → 1.0.2

data/lib/venice_client/models/chat_completion_request.rb

@@ -3,13 +3,15 @@
 
 #The Venice.ai API.
 
-OpenAPI spec version: 20250521.233203
+The version of the OpenAPI document: 20250709.013306
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 3.0.68
 =end
 
 require 'date'
+require 'time'
 
 module VeniceClient
   class ChatCompletionRequest
@@ -19,6 +21,9 @@ module VeniceClient
     # Whether to include log probabilities in the response. This is not supported by all models.
     attr_accessor :logprobs
 
+    # The number of highest probability tokens to return for each token position.
+    attr_accessor :top_logprobs
+
     # An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
     attr_accessor :max_completion_tokens
 
@@ -37,7 +42,7 @@ module VeniceClient
     # Minimum temperature value for dynamic temperature scaling.
     attr_accessor :min_temp
 
-    # The ID of the model you wish to prompt. May also be a model trait, or a compatibility mapping. See the models endpoint for a list of models available to you.  You can use feature suffixes to enable features from the venice_parameters object. Please see \"Model Feature Suffix\" documentation for more details.
+    # The ID of the model you wish to prompt. May also be a model trait, or a model compatibility mapping. See the models endpoint for a list of models available to you. You can use feature suffixes to enable features from the venice_parameters object. Please see \"Model Feature Suffix\" documentation for more details.
     attr_accessor :model
 
     # How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.
@@ -52,7 +57,6 @@ module VeniceClient
     # The random seed used to generate the response. This is useful for reproducibility.
     attr_accessor :seed
 
-    # Up to 4 sequences where the API will stop generating further tokens. Defaults to null.
     attr_accessor :stop
 
     # Array of token IDs where the API will stop generating further tokens.
@@ -72,7 +76,7 @@ module VeniceClient
     # 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.
     attr_accessor :top_p
 
-    # This field is discarded on the request but is supported in the Venice API for compatibility with OpenAPI clients.
+    # This field is discarded on the request but is supported in the Venice API for compatibility with OpenAI clients.
     attr_accessor :user
 
     attr_accessor :venice_parameters
@@ -80,7 +84,6 @@ module VeniceClient
     # Whether to enable parallel function calling during tool use.
     attr_accessor :parallel_tool_calls
 
-    # Format in which the response should be returned.
     attr_accessor :response_format
 
     attr_accessor :tool_choice
@@ -93,6 +96,7 @@ module VeniceClient
       {
         :'frequency_penalty' => :'frequency_penalty',
         :'logprobs' => :'logprobs',
+        :'top_logprobs' => :'top_logprobs',
         :'max_completion_tokens' => :'max_completion_tokens',
         :'max_temp' => :'max_temp',
         :'max_tokens' => :'max_tokens',
@@ -120,45 +124,57 @@ module VeniceClient
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'frequency_penalty' => :'Object',
-        :'logprobs' => :'Object',
-        :'max_completion_tokens' => :'Object',
-        :'max_temp' => :'Object',
-        :'max_tokens' => :'Object',
-        :'messages' => :'Object',
-        :'min_p' => :'Object',
-        :'min_temp' => :'Object',
-        :'model' => :'Object',
-        :'n' => :'Object',
-        :'presence_penalty' => :'Object',
-        :'repetition_penalty' => :'Object',
-        :'seed' => :'Object',
-        :'stop' => :'Object',
-        :'stop_token_ids' => :'Object',
-        :'stream' => :'Object',
-        :'stream_options' => :'Object',
-        :'temperature' => :'Object',
-        :'top_k' => :'Object',
-        :'top_p' => :'Object',
-        :'user' => :'Object',
-        :'venice_parameters' => :'Object',
-        :'parallel_tool_calls' => :'Object',
-        :'response_format' => :'Object',
-        :'tool_choice' => :'Object',
-        :'tools' => :'Object'
+        :'frequency_penalty' => :'Float',
+        :'logprobs' => :'Boolean',
+        :'top_logprobs' => :'Integer',
+        :'max_completion_tokens' => :'Integer',
+        :'max_temp' => :'Float',
+        :'max_tokens' => :'Integer',
+        :'messages' => :'Array<ChatCompletionRequestMessagesInner>',
+        :'min_p' => :'Float',
+        :'min_temp' => :'Float',
+        :'model' => :'String',
+        :'n' => :'Integer',
+        :'presence_penalty' => :'Float',
+        :'repetition_penalty' => :'Float',
+        :'seed' => :'Integer',
+        :'stop' => :'ChatCompletionRequestStop',
+        :'stop_token_ids' => :'Array<Float>',
+        :'stream' => :'Boolean',
+        :'stream_options' => :'ChatCompletionRequestStreamOptions',
+        :'temperature' => :'Float',
+        :'top_k' => :'Integer',
+        :'top_p' => :'Float',
+        :'user' => :'String',
+        :'venice_parameters' => :'ChatCompletionRequestVeniceParameters',
+        :'parallel_tool_calls' => :'Boolean',
+        :'response_format' => :'ChatCompletionRequestResponseFormat',
+        :'tool_choice' => :'ChatCompletionRequestToolChoice',
+        :'tools' => :'Array<ToolCall>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'stop',
         :'tools'
       ])
     end
-  
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -167,9 +183,10 @@ module VeniceClient
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       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 `VeniceClient::ChatCompletionRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `VeniceClient::ChatCompletionRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -184,6 +201,10 @@ module VeniceClient
         self.logprobs = attributes[:'logprobs']
       end
 
+      if attributes.key?(:'top_logprobs')
+        self.top_logprobs = attributes[:'top_logprobs']
+      end
+
       if attributes.key?(:'max_completion_tokens')
         self.max_completion_tokens = attributes[:'max_completion_tokens']
       end
@@ -200,6 +221,8 @@ module VeniceClient
         if (value = attributes[:'messages']).is_a?(Array)
           self.messages = value
         end
+      else
+        self.messages = nil
       end
 
       if attributes.key?(:'min_p')
@@ -212,6 +235,8 @@ module VeniceClient
 
       if attributes.key?(:'model')
         self.model = attributes[:'model']
+      else
+        self.model = nil
       end
 
       if attributes.key?(:'n')
@@ -255,7 +280,7 @@ module VeniceClient
       if attributes.key?(:'temperature')
         self.temperature = attributes[:'temperature']
       else
-        self.temperature = 0.3
+        self.temperature = 0.7
       end
 
       if attributes.key?(:'top_k')
@@ -265,7 +290,7 @@ module VeniceClient
       if attributes.key?(:'top_p')
         self.top_p = attributes[:'top_p']
       else
-        self.top_p = 1
+        self.top_p = 0.9
       end
 
       if attributes.key?(:'user')
@@ -300,26 +325,329 @@ module VeniceClient
     # 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 !@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
+
+      if !@top_logprobs.nil? && @top_logprobs < 0
+        invalid_properties.push('invalid value for "top_logprobs", must be greater than or equal to 0.')
+      end
+
+      if !@max_temp.nil? && @max_temp > 2
+        invalid_properties.push('invalid value for "max_temp", must be smaller than or equal to 2.')
+      end
+
+      if !@max_temp.nil? && @max_temp < 0
+        invalid_properties.push('invalid value for "max_temp", must be greater than or equal to 0.')
+      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 !@min_p.nil? && @min_p > 1
+        invalid_properties.push('invalid value for "min_p", must be smaller than or equal to 1.')
+      end
+
+      if !@min_p.nil? && @min_p < 0
+        invalid_properties.push('invalid value for "min_p", must be greater than or equal to 0.')
+      end
+
+      if !@min_temp.nil? && @min_temp > 2
+        invalid_properties.push('invalid value for "min_temp", must be smaller than or equal to 2.')
+      end
+
+      if !@min_temp.nil? && @min_temp < 0
+        invalid_properties.push('invalid value for "min_temp", must be greater than or equal to 0.')
+      end
+
       if @model.nil?
         invalid_properties.push('invalid value for "model", model cannot be nil.')
       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 !@repetition_penalty.nil? && @repetition_penalty < 0
+        invalid_properties.push('invalid value for "repetition_penalty", must be greater than or equal to 0.')
+      end
+
+      if !@seed.nil? && @seed <= 0
+        invalid_properties.push('invalid value for "seed", must be greater than 0.')
+      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_k.nil? && @top_k < 0
+        invalid_properties.push('invalid value for "top_k", 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
+
       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 !@frequency_penalty.nil? && @frequency_penalty > 2
+      return false if !@frequency_penalty.nil? && @frequency_penalty < -2
+      return false if !@top_logprobs.nil? && @top_logprobs < 0
+      return false if !@max_temp.nil? && @max_temp > 2
+      return false if !@max_temp.nil? && @max_temp < 0
       return false if @messages.nil?
+      return false if @messages.length < 1
+      return false if !@min_p.nil? && @min_p > 1
+      return false if !@min_p.nil? && @min_p < 0
+      return false if !@min_temp.nil? && @min_temp > 2
+      return false if !@min_temp.nil? && @min_temp < 0
       return false if @model.nil?
+      return false if !@presence_penalty.nil? && @presence_penalty > 2
+      return false if !@presence_penalty.nil? && @presence_penalty < -2
+      return false if !@repetition_penalty.nil? && @repetition_penalty < 0
+      return false if !@seed.nil? && @seed <= 0
+      return false if !@temperature.nil? && @temperature > 2
+      return false if !@temperature.nil? && @temperature < 0
+      return false if !@top_k.nil? && @top_k < 0
+      return false if !@top_p.nil? && @top_p > 1
+      return false if !@top_p.nil? && @top_p < 0
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] frequency_penalty Value to be assigned
+    def frequency_penalty=(frequency_penalty)
+      if frequency_penalty.nil?
+        fail ArgumentError, 'frequency_penalty cannot be nil'
+      end
+
+      if frequency_penalty > 2
+        fail ArgumentError, 'invalid value for "frequency_penalty", must be smaller than or equal to 2.'
+      end
+
+      if frequency_penalty < -2
+        fail ArgumentError, 'invalid value for "frequency_penalty", must be greater than or equal to -2.'
+      end
+
+      @frequency_penalty = frequency_penalty
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] top_logprobs Value to be assigned
+    def top_logprobs=(top_logprobs)
+      if top_logprobs.nil?
+        fail ArgumentError, 'top_logprobs cannot be nil'
+      end
+
+      if top_logprobs < 0
+        fail ArgumentError, 'invalid value for "top_logprobs", must be greater than or equal to 0.'
+      end
+
+      @top_logprobs = top_logprobs
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_temp Value to be assigned
+    def max_temp=(max_temp)
+      if max_temp.nil?
+        fail ArgumentError, 'max_temp cannot be nil'
+      end
+
+      if max_temp > 2
+        fail ArgumentError, 'invalid value for "max_temp", must be smaller than or equal to 2.'
+      end
+
+      if max_temp < 0
+        fail ArgumentError, 'invalid value for "max_temp", must be greater than or equal to 0.'
+      end
+
+      @max_temp = max_temp
+    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] min_p Value to be assigned
+    def min_p=(min_p)
+      if min_p.nil?
+        fail ArgumentError, 'min_p cannot be nil'
+      end
+
+      if min_p > 1
+        fail ArgumentError, 'invalid value for "min_p", must be smaller than or equal to 1.'
+      end
+
+      if min_p < 0
+        fail ArgumentError, 'invalid value for "min_p", must be greater than or equal to 0.'
+      end
+
+      @min_p = min_p
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_temp Value to be assigned
+    def min_temp=(min_temp)
+      if min_temp.nil?
+        fail ArgumentError, 'min_temp cannot be nil'
+      end
+
+      if min_temp > 2
+        fail ArgumentError, 'invalid value for "min_temp", must be smaller than or equal to 2.'
+      end
+
+      if min_temp < 0
+        fail ArgumentError, 'invalid value for "min_temp", must be greater than or equal to 0.'
+      end
+
+      @min_temp = min_temp
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] model Value to be assigned
+    def model=(model)
+      if model.nil?
+        fail ArgumentError, 'model cannot be nil'
+      end
+
+      @model = model
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] presence_penalty Value to be assigned
+    def presence_penalty=(presence_penalty)
+      if presence_penalty.nil?
+        fail ArgumentError, 'presence_penalty cannot be nil'
+      end
+
+      if presence_penalty > 2
+        fail ArgumentError, 'invalid value for "presence_penalty", must be smaller than or equal to 2.'
+      end
+
+      if 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] repetition_penalty Value to be assigned
+    def repetition_penalty=(repetition_penalty)
+      if repetition_penalty.nil?
+        fail ArgumentError, 'repetition_penalty cannot be nil'
+      end
+
+      if repetition_penalty < 0
+        fail ArgumentError, 'invalid value for "repetition_penalty", must be greater than or equal to 0.'
+      end
+
+      @repetition_penalty = repetition_penalty
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] seed Value to be assigned
+    def seed=(seed)
+      if seed.nil?
+        fail ArgumentError, 'seed cannot be nil'
+      end
+
+      if seed <= 0
+        fail ArgumentError, 'invalid value for "seed", must be greater than 0.'
+      end
+
+      @seed = seed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] temperature Value to be assigned
+    def temperature=(temperature)
+      if temperature.nil?
+        fail ArgumentError, 'temperature cannot be nil'
+      end
+
+      if temperature > 2
+        fail ArgumentError, 'invalid value for "temperature", must be smaller than or equal to 2.'
+      end
+
+      if 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_k Value to be assigned
+    def top_k=(top_k)
+      if top_k.nil?
+        fail ArgumentError, 'top_k cannot be nil'
+      end
+
+      if top_k < 0
+        fail ArgumentError, 'invalid value for "top_k", must be greater than or equal to 0.'
+      end
+
+      @top_k = top_k
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] top_p Value to be assigned
+    def top_p=(top_p)
+      if top_p.nil?
+        fail ArgumentError, 'top_p cannot be nil'
+      end
+
+      if top_p > 1
+        fail ArgumentError, 'invalid value for "top_p", must be smaller than or equal to 1.'
+      end
+
+      if top_p < 0
+        fail ArgumentError, 'invalid value for "top_p", must be greater than or equal to 0.'
+      end
+
+      @top_p = top_p
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -327,6 +655,7 @@ module VeniceClient
       self.class == o.class &&
           frequency_penalty == o.frequency_penalty &&
           logprobs == o.logprobs &&
+          top_logprobs == o.top_logprobs &&
           max_completion_tokens == o.max_completion_tokens &&
           max_temp == o.max_temp &&
           max_tokens == o.max_tokens &&
@@ -362,46 +691,40 @@ module VeniceClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [frequency_penalty, logprobs, max_completion_tokens, max_temp, max_tokens, messages, min_p, min_temp, model, n, presence_penalty, repetition_penalty, seed, stop, stop_token_ids, stream, stream_options, temperature, top_k, top_p, user, venice_parameters, parallel_tool_calls, response_format, tool_choice, tools].hash
+      [frequency_penalty, logprobs, top_logprobs, max_completion_tokens, max_temp, max_tokens, messages, min_p, min_temp, model, n, presence_penalty, repetition_penalty, seed, stop, stop_token_ids, stream, stream_options, temperature, top_k, top_p, user, venice_parameters, parallel_tool_calls, response_format, tool_choice, tools].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
+      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[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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)
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      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 _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -431,7 +754,9 @@ module VeniceClient
           end
         end
       else # model
-        VeniceClient.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = VeniceClient.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
 
@@ -479,5 +804,8 @@ module VeniceClient
       else
         value
       end
-    end  end
+    end
+
+  end
+
 end