chromadb-experimental 0.1.0

data/lib/chromadb/openapi/lib/chromadb/models/spann_index_config.rb

@@ -0,0 +1,536 @@
+=begin
+#chroma-frontend
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Chromadb
+  # Configuration for SPANN vector index algorithm parameters
+  class SpannIndexConfig
+    attr_accessor :ef_construction
+
+    attr_accessor :ef_search
+
+    attr_accessor :initial_lambda
+
+    attr_accessor :max_neighbors
+
+    attr_accessor :merge_threshold
+
+    attr_accessor :nreplica_count
+
+    attr_accessor :num_centers_to_merge_to
+
+    attr_accessor :num_samples_kmeans
+
+    attr_accessor :reassign_neighbor_count
+
+    attr_accessor :search_nprobe
+
+    attr_accessor :search_rng_epsilon
+
+    attr_accessor :search_rng_factor
+
+    attr_accessor :split_threshold
+
+    attr_accessor :write_nprobe
+
+    attr_accessor :write_rng_epsilon
+
+    attr_accessor :write_rng_factor
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ef_construction' => :'ef_construction',
+        :'ef_search' => :'ef_search',
+        :'initial_lambda' => :'initial_lambda',
+        :'max_neighbors' => :'max_neighbors',
+        :'merge_threshold' => :'merge_threshold',
+        :'nreplica_count' => :'nreplica_count',
+        :'num_centers_to_merge_to' => :'num_centers_to_merge_to',
+        :'num_samples_kmeans' => :'num_samples_kmeans',
+        :'reassign_neighbor_count' => :'reassign_neighbor_count',
+        :'search_nprobe' => :'search_nprobe',
+        :'search_rng_epsilon' => :'search_rng_epsilon',
+        :'search_rng_factor' => :'search_rng_factor',
+        :'split_threshold' => :'split_threshold',
+        :'write_nprobe' => :'write_nprobe',
+        :'write_rng_epsilon' => :'write_rng_epsilon',
+        :'write_rng_factor' => :'write_rng_factor'
+      }
+    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
+      {
+        :'ef_construction' => :'Object',
+        :'ef_search' => :'Object',
+        :'initial_lambda' => :'Object',
+        :'max_neighbors' => :'Object',
+        :'merge_threshold' => :'Object',
+        :'nreplica_count' => :'Object',
+        :'num_centers_to_merge_to' => :'Object',
+        :'num_samples_kmeans' => :'Object',
+        :'reassign_neighbor_count' => :'Object',
+        :'search_nprobe' => :'Object',
+        :'search_rng_epsilon' => :'Object',
+        :'search_rng_factor' => :'Object',
+        :'split_threshold' => :'Object',
+        :'write_nprobe' => :'Object',
+        :'write_rng_epsilon' => :'Object',
+        :'write_rng_factor' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'ef_construction',
+        :'ef_search',
+        :'initial_lambda',
+        :'max_neighbors',
+        :'merge_threshold',
+        :'nreplica_count',
+        :'num_centers_to_merge_to',
+        :'num_samples_kmeans',
+        :'reassign_neighbor_count',
+        :'search_nprobe',
+        :'search_rng_epsilon',
+        :'search_rng_factor',
+        :'split_threshold',
+        :'write_nprobe',
+        :'write_rng_epsilon',
+        :'write_rng_factor'
+      ])
+    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 `Chromadb::SpannIndexConfig` 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 `Chromadb::SpannIndexConfig`. 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?(:'ef_construction')
+        self.ef_construction = attributes[:'ef_construction']
+      end
+
+      if attributes.key?(:'ef_search')
+        self.ef_search = attributes[:'ef_search']
+      end
+
+      if attributes.key?(:'initial_lambda')
+        self.initial_lambda = attributes[:'initial_lambda']
+      end
+
+      if attributes.key?(:'max_neighbors')
+        self.max_neighbors = attributes[:'max_neighbors']
+      end
+
+      if attributes.key?(:'merge_threshold')
+        self.merge_threshold = attributes[:'merge_threshold']
+      end
+
+      if attributes.key?(:'nreplica_count')
+        self.nreplica_count = attributes[:'nreplica_count']
+      end
+
+      if attributes.key?(:'num_centers_to_merge_to')
+        self.num_centers_to_merge_to = attributes[:'num_centers_to_merge_to']
+      end
+
+      if attributes.key?(:'num_samples_kmeans')
+        self.num_samples_kmeans = attributes[:'num_samples_kmeans']
+      end
+
+      if attributes.key?(:'reassign_neighbor_count')
+        self.reassign_neighbor_count = attributes[:'reassign_neighbor_count']
+      end
+
+      if attributes.key?(:'search_nprobe')
+        self.search_nprobe = attributes[:'search_nprobe']
+      end
+
+      if attributes.key?(:'search_rng_epsilon')
+        self.search_rng_epsilon = attributes[:'search_rng_epsilon']
+      end
+
+      if attributes.key?(:'search_rng_factor')
+        self.search_rng_factor = attributes[:'search_rng_factor']
+      end
+
+      if attributes.key?(:'split_threshold')
+        self.split_threshold = attributes[:'split_threshold']
+      end
+
+      if attributes.key?(:'write_nprobe')
+        self.write_nprobe = attributes[:'write_nprobe']
+      end
+
+      if attributes.key?(:'write_rng_epsilon')
+        self.write_rng_epsilon = attributes[:'write_rng_epsilon']
+      end
+
+      if attributes.key?(:'write_rng_factor')
+        self.write_rng_factor = attributes[:'write_rng_factor']
+      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 !@ef_construction.nil? && @ef_construction < 0
+        invalid_properties.push('invalid value for "ef_construction", must be greater than or equal to 0.')
+      end
+
+      if !@ef_search.nil? && @ef_search < 0
+        invalid_properties.push('invalid value for "ef_search", must be greater than or equal to 0.')
+      end
+
+      if !@max_neighbors.nil? && @max_neighbors < 0
+        invalid_properties.push('invalid value for "max_neighbors", must be greater than or equal to 0.')
+      end
+
+      if !@merge_threshold.nil? && @merge_threshold < 0
+        invalid_properties.push('invalid value for "merge_threshold", must be greater than or equal to 0.')
+      end
+
+      if !@nreplica_count.nil? && @nreplica_count < 0
+        invalid_properties.push('invalid value for "nreplica_count", must be greater than or equal to 0.')
+      end
+
+      if !@num_centers_to_merge_to.nil? && @num_centers_to_merge_to < 0
+        invalid_properties.push('invalid value for "num_centers_to_merge_to", must be greater than or equal to 0.')
+      end
+
+      if !@num_samples_kmeans.nil? && @num_samples_kmeans < 0
+        invalid_properties.push('invalid value for "num_samples_kmeans", must be greater than or equal to 0.')
+      end
+
+      if !@reassign_neighbor_count.nil? && @reassign_neighbor_count < 0
+        invalid_properties.push('invalid value for "reassign_neighbor_count", must be greater than or equal to 0.')
+      end
+
+      if !@search_nprobe.nil? && @search_nprobe < 0
+        invalid_properties.push('invalid value for "search_nprobe", must be greater than or equal to 0.')
+      end
+
+      if !@split_threshold.nil? && @split_threshold < 0
+        invalid_properties.push('invalid value for "split_threshold", must be greater than or equal to 0.')
+      end
+
+      if !@write_nprobe.nil? && @write_nprobe < 0
+        invalid_properties.push('invalid value for "write_nprobe", 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?
+      return false if !@ef_construction.nil? && @ef_construction < 0
+      return false if !@ef_search.nil? && @ef_search < 0
+      return false if !@max_neighbors.nil? && @max_neighbors < 0
+      return false if !@merge_threshold.nil? && @merge_threshold < 0
+      return false if !@nreplica_count.nil? && @nreplica_count < 0
+      return false if !@num_centers_to_merge_to.nil? && @num_centers_to_merge_to < 0
+      return false if !@num_samples_kmeans.nil? && @num_samples_kmeans < 0
+      return false if !@reassign_neighbor_count.nil? && @reassign_neighbor_count < 0
+      return false if !@search_nprobe.nil? && @search_nprobe < 0
+      return false if !@split_threshold.nil? && @split_threshold < 0
+      return false if !@write_nprobe.nil? && @write_nprobe < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ef_construction Value to be assigned
+    def ef_construction=(ef_construction)
+      if !ef_construction.nil? && ef_construction < 0
+        fail ArgumentError, 'invalid value for "ef_construction", must be greater than or equal to 0.'
+      end
+
+      @ef_construction = ef_construction
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ef_search Value to be assigned
+    def ef_search=(ef_search)
+      if !ef_search.nil? && ef_search < 0
+        fail ArgumentError, 'invalid value for "ef_search", must be greater than or equal to 0.'
+      end
+
+      @ef_search = ef_search
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_neighbors Value to be assigned
+    def max_neighbors=(max_neighbors)
+      if !max_neighbors.nil? && max_neighbors < 0
+        fail ArgumentError, 'invalid value for "max_neighbors", must be greater than or equal to 0.'
+      end
+
+      @max_neighbors = max_neighbors
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] merge_threshold Value to be assigned
+    def merge_threshold=(merge_threshold)
+      if !merge_threshold.nil? && merge_threshold < 0
+        fail ArgumentError, 'invalid value for "merge_threshold", must be greater than or equal to 0.'
+      end
+
+      @merge_threshold = merge_threshold
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] nreplica_count Value to be assigned
+    def nreplica_count=(nreplica_count)
+      if !nreplica_count.nil? && nreplica_count < 0
+        fail ArgumentError, 'invalid value for "nreplica_count", must be greater than or equal to 0.'
+      end
+
+      @nreplica_count = nreplica_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] num_centers_to_merge_to Value to be assigned
+    def num_centers_to_merge_to=(num_centers_to_merge_to)
+      if !num_centers_to_merge_to.nil? && num_centers_to_merge_to < 0
+        fail ArgumentError, 'invalid value for "num_centers_to_merge_to", must be greater than or equal to 0.'
+      end
+
+      @num_centers_to_merge_to = num_centers_to_merge_to
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] num_samples_kmeans Value to be assigned
+    def num_samples_kmeans=(num_samples_kmeans)
+      if !num_samples_kmeans.nil? && num_samples_kmeans < 0
+        fail ArgumentError, 'invalid value for "num_samples_kmeans", must be greater than or equal to 0.'
+      end
+
+      @num_samples_kmeans = num_samples_kmeans
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reassign_neighbor_count Value to be assigned
+    def reassign_neighbor_count=(reassign_neighbor_count)
+      if !reassign_neighbor_count.nil? && reassign_neighbor_count < 0
+        fail ArgumentError, 'invalid value for "reassign_neighbor_count", must be greater than or equal to 0.'
+      end
+
+      @reassign_neighbor_count = reassign_neighbor_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] search_nprobe Value to be assigned
+    def search_nprobe=(search_nprobe)
+      if !search_nprobe.nil? && search_nprobe < 0
+        fail ArgumentError, 'invalid value for "search_nprobe", must be greater than or equal to 0.'
+      end
+
+      @search_nprobe = search_nprobe
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] split_threshold Value to be assigned
+    def split_threshold=(split_threshold)
+      if !split_threshold.nil? && split_threshold < 0
+        fail ArgumentError, 'invalid value for "split_threshold", must be greater than or equal to 0.'
+      end
+
+      @split_threshold = split_threshold
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] write_nprobe Value to be assigned
+    def write_nprobe=(write_nprobe)
+      if !write_nprobe.nil? && write_nprobe < 0
+        fail ArgumentError, 'invalid value for "write_nprobe", must be greater than or equal to 0.'
+      end
+
+      @write_nprobe = write_nprobe
+    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 &&
+          ef_construction == o.ef_construction &&
+          ef_search == o.ef_search &&
+          initial_lambda == o.initial_lambda &&
+          max_neighbors == o.max_neighbors &&
+          merge_threshold == o.merge_threshold &&
+          nreplica_count == o.nreplica_count &&
+          num_centers_to_merge_to == o.num_centers_to_merge_to &&
+          num_samples_kmeans == o.num_samples_kmeans &&
+          reassign_neighbor_count == o.reassign_neighbor_count &&
+          search_nprobe == o.search_nprobe &&
+          search_rng_epsilon == o.search_rng_epsilon &&
+          search_rng_factor == o.search_rng_factor &&
+          split_threshold == o.split_threshold &&
+          write_nprobe == o.write_nprobe &&
+          write_rng_epsilon == o.write_rng_epsilon &&
+          write_rng_factor == o.write_rng_factor
+    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
+      [ef_construction, ef_search, initial_lambda, max_neighbors, merge_threshold, nreplica_count, num_centers_to_merge_to, num_samples_kmeans, reassign_neighbor_count, search_nprobe, search_rng_epsilon, search_rng_factor, split_threshold, write_nprobe, write_rng_epsilon, write_rng_factor].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        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 :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 = Chromadb.const_get(type)
+        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