venice_client 1.0.0

data/lib/venice_client/models/chat_completion_request_venice_parameters.rb

@@ -0,0 +1,302 @@
+=begin
+#Venice.ai API
+
+#The Venice.ai API.
+
+OpenAPI spec version: 20250521.233203
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.68
+=end
+
+require 'date'
+
+module VeniceClient
+  # Unique parameters to Venice's API implementation.
+  class ChatCompletionRequestVeniceParameters
+    # The character slug of a public Venice character.
+    attr_accessor :character_slug
+
+    # Strip <think></think> blocks from the response. Applicable only to reasoning / thinking models. Also available to use as a model feature suffix. Defaults to false.
+    attr_accessor :strip_thinking_response
+
+    # On supported reasoning models, will disable thinking and strip the <think></think> blocks from the response. Defaults to false.
+    attr_accessor :disable_thinking
+
+    # Enable web search for this request. Defaults to off. On will force web search on the request. Auto will enable it based on the model's discretion. Citations will be returned either in the first chunk of a streaming result, or in the non streaming response.
+    attr_accessor :enable_web_search
+
+    # When web search is enabled, this will request that the LLM cite its sources using a [REF]0[/REF] format. Defaults to false.
+    attr_accessor :enable_web_citations
+
+    # Whether to include the Venice supplied system prompts along side specified system prompts. Defaults to true.
+    attr_accessor :include_venice_system_prompt
+
+    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
+      {
+        :'character_slug' => :'character_slug',
+        :'strip_thinking_response' => :'strip_thinking_response',
+        :'disable_thinking' => :'disable_thinking',
+        :'enable_web_search' => :'enable_web_search',
+        :'enable_web_citations' => :'enable_web_citations',
+        :'include_venice_system_prompt' => :'include_venice_system_prompt'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'character_slug' => :'Object',
+        :'strip_thinking_response' => :'Object',
+        :'disable_thinking' => :'Object',
+        :'enable_web_search' => :'Object',
+        :'enable_web_citations' => :'Object',
+        :'include_venice_system_prompt' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `VeniceClient::ChatCompletionRequestVeniceParameters` 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 `VeniceClient::ChatCompletionRequestVeniceParameters`. 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?(:'character_slug')
+        self.character_slug = attributes[:'character_slug']
+      end
+
+      if attributes.key?(:'strip_thinking_response')
+        self.strip_thinking_response = attributes[:'strip_thinking_response']
+      else
+        self.strip_thinking_response = false
+      end
+
+      if attributes.key?(:'disable_thinking')
+        self.disable_thinking = attributes[:'disable_thinking']
+      else
+        self.disable_thinking = false
+      end
+
+      if attributes.key?(:'enable_web_search')
+        self.enable_web_search = attributes[:'enable_web_search']
+      else
+        self.enable_web_search = 'false'
+      end
+
+      if attributes.key?(:'enable_web_citations')
+        self.enable_web_citations = attributes[:'enable_web_citations']
+      else
+        self.enable_web_citations = false
+      end
+
+      if attributes.key?(:'include_venice_system_prompt')
+        self.include_venice_system_prompt = attributes[:'include_venice_system_prompt']
+      else
+        self.include_venice_system_prompt = true
+      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
+      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?
+      enable_web_search_validator = EnumAttributeValidator.new('Object', ['auto', 'false', 'true'])
+      return false unless enable_web_search_validator.valid?(@enable_web_search)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] enable_web_search Object to be assigned
+    def enable_web_search=(enable_web_search)
+      validator = EnumAttributeValidator.new('Object', ['auto', 'false', 'true'])
+      unless validator.valid?(enable_web_search)
+        fail ArgumentError, "invalid value for \"enable_web_search\", must be one of #{validator.allowable_values}."
+      end
+      @enable_web_search = enable_web_search
+    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 &&
+          character_slug == o.character_slug &&
+          strip_thinking_response == o.strip_thinking_response &&
+          disable_thinking == o.disable_thinking &&
+          enable_web_search == o.enable_web_search &&
+          enable_web_citations == o.enable_web_citations &&
+          include_venice_system_prompt == o.include_venice_system_prompt
+    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
+      [character_slug, strip_thinking_response, disable_thinking, enable_web_search, enable_web_citations, include_venice_system_prompt].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
+        VeniceClient.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

data/lib/venice_client/models/create_embedding_request_schema.rb

@@ -0,0 +1,294 @@
+=begin
+#Venice.ai API
+
+#The Venice.ai API.
+
+OpenAPI spec version: 20250521.233203
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.68
+=end
+
+require 'date'
+
+module VeniceClient
+  # Create embeddings for the supplied input.
+  class CreateEmbeddingRequestSchema
+    # The number of dimensions the resulting output embeddings should have.
+    attr_accessor :dimensions
+
+    # The format to return the embeddings in. Can be either `float` or `base64`.
+    attr_accessor :encoding_format
+
+    # Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens), cannot be an empty string, and any array must be 2048 dimensions or less.
+    attr_accessor :input
+
+    # ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.
+    attr_accessor :model
+
+    # This is an unused parameter and is discarded by Venice. It is supported solely for API compatibility with OpenAI.
+    attr_accessor :user
+
+    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
+      {
+        :'dimensions' => :'dimensions',
+        :'encoding_format' => :'encoding_format',
+        :'input' => :'input',
+        :'model' => :'model',
+        :'user' => :'user'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'dimensions' => :'Object',
+        :'encoding_format' => :'Object',
+        :'input' => :'Object',
+        :'model' => :'Object',
+        :'user' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `VeniceClient::CreateEmbeddingRequestSchema` 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 `VeniceClient::CreateEmbeddingRequestSchema`. 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?(:'dimensions')
+        self.dimensions = attributes[:'dimensions']
+      end
+
+      if attributes.key?(:'encoding_format')
+        self.encoding_format = attributes[:'encoding_format']
+      else
+        self.encoding_format = 'float'
+      end
+
+      if attributes.key?(:'input')
+        self.input = attributes[:'input']
+      end
+
+      if attributes.key?(:'model')
+        self.model = attributes[:'model']
+      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 @input.nil?
+        invalid_properties.push('invalid value for "input", input cannot be nil.')
+      end
+
+      if @model.nil?
+        invalid_properties.push('invalid value for "model", model 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?
+      encoding_format_validator = EnumAttributeValidator.new('Object', ['float', 'base64'])
+      return false unless encoding_format_validator.valid?(@encoding_format)
+      return false if @input.nil?
+      return false if @model.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] encoding_format Object to be assigned
+    def encoding_format=(encoding_format)
+      validator = EnumAttributeValidator.new('Object', ['float', 'base64'])
+      unless validator.valid?(encoding_format)
+        fail ArgumentError, "invalid value for \"encoding_format\", must be one of #{validator.allowable_values}."
+      end
+      @encoding_format = encoding_format
+    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 &&
+          dimensions == o.dimensions &&
+          encoding_format == o.encoding_format &&
+          input == o.input &&
+          model == o.model &&
+          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
+      [dimensions, encoding_format, input, model, 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
+        VeniceClient.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