neighbor-redis 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca86068ccb3e4538661582c5cf25f58b522569ff2abc6fb69cb6c69f3171141e
-  data.tar.gz: 455e7ce9a5c112b3ffb2e6f5004f4cc0598033b1b1ca409fdec7fdecdd936c86
+  metadata.gz: 15f6a05f33831afcb282262440f8a4ccd73264c109ada3d5de1383af76cab304
+  data.tar.gz: 977b93e67d4b62db75837bf72dff4959a5b6aae8c940828273bee22563f172ad
 SHA512:
-  metadata.gz: 4ff369d81326391017aa7c8c98966d44200856f7fb7be32caa8dd773f55ab01a15674ed5bb2a58aa8bf8163604d26895516fcd4c29332caf5354dc101d5d7f54
-  data.tar.gz: 5d00a85e5265d01617299daa1b0ce5a3e67f4d570c6a512eee5bc6b4023d5dedfc93a8e8583689a54fbb1cafae8401cb76acc35242b6d215cd1883aa34add26f
+  metadata.gz: f6148b2717ddbb7cef8e9d762866b3c0d981be8e57e6a9e7c8a28f3a37b8402b5add0383e2676bc21b1c93dd687e10ae2fdaf9bfb31969adc80d7fb43def01a4
+  data.tar.gz: e7bc98f4436a8e48c84215e837461312bf0d610e9f5103a8d6f0ce39aa800970f5adb4c341ff691e21a059d30e4540eda4ef1df3d17f7d313923e6799860beb3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0 (2024-10-23)
+
+- Dropped support for Ruby < 3.1
+
+## 0.1.1 (2023-10-02)
+
+- Added support for RediSearch 2.8
+
 ## 0.1.0 (2023-02-21)
 
 - First release

data/README.md

@@ -2,14 +2,14 @@
 
 Nearest neighbor search for Ruby and Redis
 
-[![Build Status](https://github.com/ankane/neighbor-redis/workflows/build/badge.svg?branch=master)](https://github.com/ankane/neighbor-redis/actions)
+[![Build Status](https://github.com/ankane/neighbor-redis/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/neighbor-redis/actions)
 
 ## Installation
 
 First, [install RediSearch](https://redis.io/docs/stack/search/quick_start/). With Docker, use:
 
 ```sh
-docker run -p 6379:6379 redis/redis-stack-server:latest
+docker run -p 6379:6379 redis/redis-stack-server
 ```
 
 Add this line to your application’s Gemfile:
@@ -41,7 +41,7 @@ index.add(2, [2, 2, 2])
 index.add(3, [1, 1, 2])
 ```
 
-Note: IDs are stored and returned as strings (uses less total storage)
+Note: IDs are stored and returned as strings (uses less total memory)
 
 Get the nearest neighbors to an item
 
@@ -118,6 +118,12 @@ Add multiple items
 index.add_all(ids, embeddings)
 ```
 
+Get an item
+
+```ruby
+index.find(id)
+```
+
 Remove an item
 
 ```ruby

data/lib/neighbor/redis/index.rb

@@ -52,7 +52,7 @@ module Neighbor
         params = {
           "TYPE" => @float64 ? "FLOAT64" : "FLOAT32",
           "DIM" => @dimensions,
-          "DISTANCE_METRIC" => @distance_metric,
+          "DISTANCE_METRIC" => @distance_metric
         }.merge(create_params)
 
         command = ["FT.CREATE", @index_name]
@@ -70,7 +70,7 @@ module Neighbor
         # fix for invalid value for Float(): "-nan"
         true
       rescue => e
-        raise unless e.message.include?("Unknown Index name")
+        raise unless e.message.downcase.include?("unknown index name")
         false
       end
 
@@ -167,31 +167,51 @@ module Neighbor
 
       def search_by_blob(blob, count)
         resp = redis.call("FT.SEARCH", @index_name, "*=>[KNN #{count.to_i} @v $BLOB]", "PARAMS", "2", "BLOB", blob, "SORTBY", "__v_score", "DIALECT", "2")
-        len = resp.shift
+        resp.is_a?(Hash) ? parse_results_hash(resp) : parse_results_array(resp)
+      end
+
+      def parse_results_hash(resp)
+        prefix_length = nil
+        resp["results"].map do |result|
+          key = result["id"]
+          info = result["extra_attributes"]
+          prefix_length ||= find_prefix_length(key)
+          search_result(key, info, prefix_length)
+        end
+      end
+
+      def parse_results_array(resp)
         prefix_length = nil
-        len.times.map do |i|
+        resp.shift.times.map do |i|
           key, info = resp.shift(2)
           info = info.each_slice(2).to_h
-          score = info["__v_score"].to_f
-          distance =
-            case @distance_metric
-            when "L2"
-              Math.sqrt(score)
-            when "IP"
-              (score * -1) + 1
-            else
-              score
-            end
-
           prefix_length ||= find_prefix_length(key)
+          search_result(key, info, prefix_length)
+        end
+      end
 
-          {
-            id: key[prefix_length..-1],
-            distance: distance
-          }
+      def search_result(key, info, prefix_length)
+        score = info["__v_score"].to_f
+        distance = calculate_distance(score)
+
+        {
+          id: key[prefix_length..-1],
+          distance: distance
+        }
+      end
+
+      def calculate_distance(score)
+        case @distance_metric
+        when "L2"
+          Math.sqrt(score)
+        when "IP"
+          (score * -1) + 1
+        else
+          score
         end
       end
 
+      # can't just remove @prefix since may be an alias
       def find_prefix_length(key)
         key[@global_prefix.length..-1].index(":") + @global_prefix.length + 1
       end

data/lib/neighbor/redis/version.rb

@@ -1,5 +1,5 @@
 module Neighbor
   module Redis
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neighbor-redis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -51,14 +51,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Nearest neighbor search for Ruby and Redis