rrf 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e291263a6f09f559b804dbcab1332b9b110d0a5ecb6c707d2156ad4583d9873
-  data.tar.gz: 28524ae014e0c0ca2fa8a20f553008b3cf8b6c5e7df6101abeef514e325ab8f3
+  metadata.gz: 4d23d3c84e7e2137eec0c67f900d1f6467ed2d0d69d2b33ab4b941a41dae41bd
+  data.tar.gz: 055da373ae7eb8a1e2f5c4cb00c0d37015911a97964d17187fc8a5a434d370c3
 SHA512:
-  metadata.gz: 3ba1b4d3d5c593c864ab81824b1236d99e3d2f9ad805c92f15b895504dbad84142de698363664f7ce83a2457ea04c1fc4655ddb7d8dda535b5564f089c9981a9
-  data.tar.gz: d7bf0020c66eb425853e4135cb2c452000c388f190fdf094e41d556b6f4ead73e316d4c5f43893568d3a11b6a1cef47577dec921ba13e78d87b0718a9dcc8e60
+  metadata.gz: ec77c2eb56856d7289a6fa4d78f62fa2cfa91ba2f0993d69dbe3e88b293f097f42e88322c9c89841636ae494dc94656ace123dfba4220da8b71ae84bf8813775
+  data.tar.gz: 8e76be5b62fb140410f974338528ab2e5b81ce0a81064a7d7e310abe1e06ced2c1acd6d53360fc5a768374d56a7b4e40936dd899074f8ba66aeee5f41868c930

data/README.md

@@ -44,7 +44,7 @@ end
 
 ### Performing Searches and Fusing Results
 
-You can perform searches using ActiveRecord and Searchkick, and then fuse the results using the fuse method:
+You can perform searches using ActiveRecord and Searchkick, and then fuse the results using the fuse method (the following relies on the [neighbor gem](https://github.com/ankane/neighbor) and the [red-candle gem](https://github.com/assaydepot/red-candle)):
 
 ```ruby
 # Configure the constant value if needed
@@ -53,11 +53,11 @@ RRF.configure do |config|
 end
 
 # Perform Searchkick search
-es_result = Chunk.search("hi", load: false, limit: 50)
+es_result = Chunk.search("alpaca", load: false, limit: 50)
 
 # Perform ActiveRecord nearest neighbor search
-query_embedding = [0.1, 0.2, 0.3, ...] # Example embedding
-ar_result = Chunk.where("body ilike ?", "%hi%").limit(50)
+query_embedding = Candle::Model.new.embedding("alpaca") # You'd want to cache the model in memory
+ar_result = Chunk.all.nearest_neighbors(:embedding768, query_embedding, distance: :cosine).limit(50)
 
 # Fuse the results and limit to 10
 result = Chunk.fuse(ar_result, es_result, limit: 10)
@@ -77,9 +77,40 @@ end
 
 ## Development
 
-After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
+After checking out the repo, run 
 
-To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
+```sh
+bundle install
+```
+
+Then, run 
+
+```sh
+rake spec
+```
+to run the tests.
+
+To install this gem onto your local machine, run 
+
+```sh
+bundle exec rake install
+```
+
+To release a new version, update the version number in version.rb, and then run
+
+```sh
+bundle exec rake release
+```
+
+which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
+
+To use this locally during development, I like to include it whatever project I'm working by adding the following to the `Gemfile` of the other project
+
+```ruby
+gem "rrf", path: '/what/ever/path/you/choose/rrf'
+```
+
+Then bundle and it will use your development copy.
 
 ## Contributing
 

data/lib/rrf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RRF
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/rrf.rb

@@ -48,7 +48,7 @@ module RRF
 
         # Sort by score and limit results
         top_record_ids = record_scores.sort_by { |_id, result| -result[:score] }.to_h.keys.first(limit)
-  
+
         # Load actual records from ActiveRecord
         self.where(id: top_record_ids).index_by(&:id).values_at(*top_record_ids).each do |record|
           record.define_singleton_method(:_rrf_score) { record_scores[record.id][:score] }

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: rrf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chris Petersen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
-dependencies: []
+date: 2024-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem provides an implementation of Reciprocal Rank Fusion (RRF) to
   merge results from different search engines. Initially supporting Active Record
   and Elasticsearch.