neighbor 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48a9bcfda91ac7ed0af8c593216b9a84a2b488d15e9375d897f063e44bd0f5c8
-  data.tar.gz: c4cf3ca35811336d7574eff4733078cc08e4b1cb7140cf5c5a12ad06a34506e7
+  metadata.gz: 5818fdfa27cc4b0678fb125e82d2fa0a3066ea173674ca541987b9084a94ac14
+  data.tar.gz: e874541532172dce9932a98506bd5ce7866a0f5c3e600ffd9d6473f226829368
 SHA512:
-  metadata.gz: 83d90c764613158ca0a753796c9d1ccbe19127792ac8a73c32eddcc2c6537ad919c21e32c43be5b88833eae92fc5d723e3275e07307e17c0951e8436faed27b5
-  data.tar.gz: 990ad6a45d982e7ababbb57112a65d1fcf8a37f3a37a6459cf4b0483aee407cfc3eda2575e6ae3ecd8389daaca8925b045d8df50c8787f0d1102e9e913b4269f
+  metadata.gz: 96211da20caf70383018ca626cbd83bbda5e4ffaf95e5a9b5405686b192643916325f89a652b4ba9e34e17daa1b84e8045cc644b606bab8aa6ea339ed4d7ea0d
+  data.tar.gz: bf855dc34617d489618417b9c807969f828358de19462458b7c09e1743102a8b9967b32b09660fab35f35543b77d588297c69971edb7442af0995cdca3b6ff8e

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.3.1 (2023-09-25)
+
+- Added support for passing multiple attributes to `has_neighbors`
+- Fixed error with `nearest_neighbors` scope with Ruby 3.2 and Active Record 6.1
+
+## 0.3.0 (2023-07-24)
+
+- Dropped support for Ruby < 3 and Active Record < 6.1
+
 ## 0.2.3 (2023-04-02)
 
 - Added support for dimensions to model generator

data/README.md

@@ -117,18 +117,26 @@ For vector, add an approximate index to speed up queries. Create a migration wit
 class AddIndexToItemsNeighborVector < ActiveRecord::Migration[7.0]
   def change
     add_index :items, :embedding, using: :ivfflat, opclass: :vector_l2_ops
+    # or with pgvector 0.5.0+
+    add_index :items, :embedding, using: :hnsw, opclass: :vector_l2_ops
   end
 end
 ```
 
 Use `:vector_cosine_ops` for cosine distance and `:vector_ip_ops` for inner product.
 
-Set the number of probes
+Set the number of probes with IVFFlat
 
 ```ruby
 Item.connection.execute("SET ivfflat.probes = 3")
 ```
 
+Or the size of the dynamic candidate list with HNSW
+
+```ruby
+Item.connection.execute("SET hnsw.ef_search = 100")
+```
+
 ## Examples
 
 - [OpenAI Embeddings](#openai-embeddings)
@@ -139,14 +147,14 @@ Item.connection.execute("SET ivfflat.probes = 3")
 Generate a model
 
 ```sh
-rails generate model Article content:text embedding:vector{1536}
+rails generate model Document content:text embedding:vector{1536}
 rails db:migrate
 ```
 
 And add `has_neighbors`
 
 ```ruby
-class Article < ApplicationRecord
+class Document < ApplicationRecord
   has_neighbors :embedding
 end
 ```
@@ -184,18 +192,18 @@ embeddings = fetch_embeddings(input)
 Store the embeddings
 
 ```ruby
-articles = []
+documents = []
 input.zip(embeddings) do |content, embedding|
-  articles << {content: content, embedding: embedding}
+  documents << {content: content, embedding: embedding}
 end
-Article.insert_all!(articles) # use create! for Active Record < 6
+Document.insert_all!(documents)
 ```
 
 And get similar articles
 
 ```ruby
-article = Article.first
-article.nearest_neighbors(:embedding, distance: "inner_product").first(5).map(&:content)
+document = Document.first
+document.nearest_neighbors(:embedding, distance: "cosine").first(5).map(&:content)
 ```
 
 See the [complete code](examples/openai_embeddings.rb)

data/lib/neighbor/model.rb

@@ -1,7 +1,11 @@
 module Neighbor
   module Model
-    def has_neighbors(attribute_name = :neighbor_vector, dimensions: nil, normalize: nil)
-      attribute_name = attribute_name.to_sym
+    def has_neighbors(*attribute_names, dimensions: nil, normalize: nil)
+      if attribute_names.empty?
+        attribute_names << :neighbor_vector
+      else
+        attribute_names.map!(&:to_sym)
+      end
 
       class_eval do
         @neighbor_attributes ||= {}
@@ -19,14 +23,26 @@ module Neighbor
           end
         end
 
-        raise Error, "has_neighbors already called for #{attribute_name.inspect}" if neighbor_attributes[attribute_name]
-        @neighbor_attributes[attribute_name] = {dimensions: dimensions, normalize: normalize}
+        attribute_names.each do |attribute_name|
+          raise Error, "has_neighbors already called for #{attribute_name.inspect}" if neighbor_attributes[attribute_name]
+          @neighbor_attributes[attribute_name] = {dimensions: dimensions, normalize: normalize}
+
+          attribute attribute_name, Neighbor::Vector.new(dimensions: dimensions, normalize: normalize, model: self, attribute_name: attribute_name)
+        end
 
-        attribute attribute_name, Neighbor::Vector.new(dimensions: dimensions, normalize: normalize, model: self, attribute_name: attribute_name)
+        return if @neighbor_attributes.size != attribute_names.size
 
-        return if @neighbor_attributes.size != 1
+        scope :nearest_neighbors, ->(attribute_name, vector = nil, options = nil) {
+          # cannot use keyword arguments with scope with Ruby 3.2 and Active Record 6.1
+          # https://github.com/rails/rails/issues/46934
+          if options.nil? && vector.is_a?(Hash)
+            options = vector
+            vector = nil
+          end
+          raise ArgumentError, "missing keyword: :distance" unless options.is_a?(Hash) && options.key?(:distance)
+          distance = options.delete(:distance)
+          raise ArgumentError, "unknown keywords: #{options.keys.map(&:inspect).join(", ")}" if options.any?
 
-        scope :nearest_neighbors, ->(attribute_name, vector = nil, distance:) {
           if vector.nil? && !attribute_name.nil? && attribute_name.respond_to?(:to_a)
             vector = attribute_name
             attribute_name = :neighbor_vector
@@ -113,8 +129,8 @@ module Neighbor
           raise ArgumentError, "Invalid attribute" unless self.class.neighbor_attributes[attribute_name]
 
           self.class
-            .where.not(self.class.primary_key => send(self.class.primary_key))
-            .nearest_neighbors(attribute_name, send(attribute_name), **options)
+            .where.not(self.class.primary_key => self[self.class.primary_key])
+            .nearest_neighbors(attribute_name, self[attribute_name], **options)
         end
       end
     end

data/lib/neighbor/version.rb

@@ -1,3 +1,3 @@
 module Neighbor
-  VERSION = "0.2.3"
+  VERSION = "0.3.1"
 end

data/lib/neighbor.rb

@@ -2,7 +2,7 @@
 require "active_support"
 
 # modules
-require "neighbor/version"
+require_relative "neighbor/version"
 
 module Neighbor
   class Error < StandardError; end
@@ -20,8 +20,8 @@ module Neighbor
 end
 
 ActiveSupport.on_load(:active_record) do
-  require "neighbor/model"
-  require "neighbor/vector"
+  require_relative "neighbor/model"
+  require_relative "neighbor/vector"
 
   extend Neighbor::Model
 
@@ -32,16 +32,7 @@ ActiveSupport.on_load(:active_record) do
   ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:vector] = {name: "vector"}
 
   # ensure schema can be loaded
-  if ActiveRecord::VERSION::MAJOR >= 6
-    ActiveRecord::ConnectionAdapters::TableDefinition.send(:define_column_methods, :cube, :vector)
-  else
-    ActiveRecord::ConnectionAdapters::TableDefinition.define_method :cube do |*args, **options|
-      args.each { |name| column(name, :cube, options) }
-    end
-    ActiveRecord::ConnectionAdapters::TableDefinition.define_method :vector do |*args, **options|
-      args.each { |name| column(name, :vector, options) }
-    end
-  end
+  ActiveRecord::ConnectionAdapters::TableDefinition.send(:define_column_methods, :cube, :vector)
 
   # prevent unknown OID warning
   if ActiveRecord::VERSION::MAJOR >= 7
@@ -51,4 +42,4 @@ ActiveSupport.on_load(:active_record) do
   end
 end
 
-require "neighbor/railtie" if defined?(Rails::Railtie)
+require_relative "neighbor/railtie" if defined?(Rails::Railtie)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neighbor
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-03 00:00:00.000000000 Z
+date: 2023-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 description:
 email: andrew@ankane.org
 executables: []
@@ -54,7 +54,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="