chromadb-experimental 0.1.0

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

@@ -0,0 +1,330 @@
+=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
+  class HnswConfiguration
+    attr_accessor :ef_construction
+
+    attr_accessor :ef_search
+
+    attr_accessor :max_neighbors
+
+    attr_accessor :resize_factor
+
+    attr_accessor :space
+
+    attr_accessor :sync_threshold
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ef_construction' => :'ef_construction',
+        :'ef_search' => :'ef_search',
+        :'max_neighbors' => :'max_neighbors',
+        :'resize_factor' => :'resize_factor',
+        :'space' => :'space',
+        :'sync_threshold' => :'sync_threshold'
+      }
+    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',
+        :'max_neighbors' => :'Object',
+        :'resize_factor' => :'Object',
+        :'space' => :'Object',
+        :'sync_threshold' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'ef_construction',
+        :'ef_search',
+        :'max_neighbors',
+        :'resize_factor',
+        :'space',
+        :'sync_threshold'
+      ])
+    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::HnswConfiguration` 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::HnswConfiguration`. 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?(:'max_neighbors')
+        self.max_neighbors = attributes[:'max_neighbors']
+      end
+
+      if attributes.key?(:'resize_factor')
+        self.resize_factor = attributes[:'resize_factor']
+      end
+
+      if attributes.key?(:'space')
+        self.space = attributes[:'space']
+      end
+
+      if attributes.key?(:'sync_threshold')
+        self.sync_threshold = attributes[:'sync_threshold']
+      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 !@sync_threshold.nil? && @sync_threshold < 0
+        invalid_properties.push('invalid value for "sync_threshold", 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 !@sync_threshold.nil? && @sync_threshold < 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] sync_threshold Value to be assigned
+    def sync_threshold=(sync_threshold)
+      if !sync_threshold.nil? && sync_threshold < 0
+        fail ArgumentError, 'invalid value for "sync_threshold", must be greater than or equal to 0.'
+      end
+
+      @sync_threshold = sync_threshold
+    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 &&
+          max_neighbors == o.max_neighbors &&
+          resize_factor == o.resize_factor &&
+          space == o.space &&
+          sync_threshold == o.sync_threshold
+    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, max_neighbors, resize_factor, space, sync_threshold].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

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

@@ -0,0 +1,371 @@
+=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 HNSW vector index algorithm parameters
+  class HnswIndexConfig
+    attr_accessor :batch_size
+
+    attr_accessor :ef_construction
+
+    attr_accessor :ef_search
+
+    attr_accessor :max_neighbors
+
+    attr_accessor :num_threads
+
+    attr_accessor :resize_factor
+
+    attr_accessor :sync_threshold
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'batch_size' => :'batch_size',
+        :'ef_construction' => :'ef_construction',
+        :'ef_search' => :'ef_search',
+        :'max_neighbors' => :'max_neighbors',
+        :'num_threads' => :'num_threads',
+        :'resize_factor' => :'resize_factor',
+        :'sync_threshold' => :'sync_threshold'
+      }
+    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
+      {
+        :'batch_size' => :'Object',
+        :'ef_construction' => :'Object',
+        :'ef_search' => :'Object',
+        :'max_neighbors' => :'Object',
+        :'num_threads' => :'Object',
+        :'resize_factor' => :'Object',
+        :'sync_threshold' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'batch_size',
+        :'ef_construction',
+        :'ef_search',
+        :'max_neighbors',
+        :'num_threads',
+        :'resize_factor',
+        :'sync_threshold'
+      ])
+    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::HnswIndexConfig` 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::HnswIndexConfig`. 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?(:'batch_size')
+        self.batch_size = attributes[:'batch_size']
+      end
+
+      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?(:'max_neighbors')
+        self.max_neighbors = attributes[:'max_neighbors']
+      end
+
+      if attributes.key?(:'num_threads')
+        self.num_threads = attributes[:'num_threads']
+      end
+
+      if attributes.key?(:'resize_factor')
+        self.resize_factor = attributes[:'resize_factor']
+      end
+
+      if attributes.key?(:'sync_threshold')
+        self.sync_threshold = attributes[:'sync_threshold']
+      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 !@batch_size.nil? && @batch_size < 0
+        invalid_properties.push('invalid value for "batch_size", must be greater than or equal to 0.')
+      end
+
+      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 !@num_threads.nil? && @num_threads < 0
+        invalid_properties.push('invalid value for "num_threads", must be greater than or equal to 0.')
+      end
+
+      if !@sync_threshold.nil? && @sync_threshold < 0
+        invalid_properties.push('invalid value for "sync_threshold", 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 !@batch_size.nil? && @batch_size < 0
+      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 !@num_threads.nil? && @num_threads < 0
+      return false if !@sync_threshold.nil? && @sync_threshold < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] batch_size Value to be assigned
+    def batch_size=(batch_size)
+      if !batch_size.nil? && batch_size < 0
+        fail ArgumentError, 'invalid value for "batch_size", must be greater than or equal to 0.'
+      end
+
+      @batch_size = batch_size
+    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] num_threads Value to be assigned
+    def num_threads=(num_threads)
+      if !num_threads.nil? && num_threads < 0
+        fail ArgumentError, 'invalid value for "num_threads", must be greater than or equal to 0.'
+      end
+
+      @num_threads = num_threads
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sync_threshold Value to be assigned
+    def sync_threshold=(sync_threshold)
+      if !sync_threshold.nil? && sync_threshold < 0
+        fail ArgumentError, 'invalid value for "sync_threshold", must be greater than or equal to 0.'
+      end
+
+      @sync_threshold = sync_threshold
+    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 &&
+          batch_size == o.batch_size &&
+          ef_construction == o.ef_construction &&
+          ef_search == o.ef_search &&
+          max_neighbors == o.max_neighbors &&
+          num_threads == o.num_threads &&
+          resize_factor == o.resize_factor &&
+          sync_threshold == o.sync_threshold
+    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
+      [batch_size, ef_construction, ef_search, max_neighbors, num_threads, resize_factor, sync_threshold].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