rrf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e291263a6f09f559b804dbcab1332b9b110d0a5ecb6c707d2156ad4583d9873
+  data.tar.gz: 28524ae014e0c0ca2fa8a20f553008b3cf8b6c5e7df6101abeef514e325ab8f3
+SHA512:
+  metadata.gz: 3ba1b4d3d5c593c864ab81824b1236d99e3d2f9ad805c92f15b895504dbad84142de698363664f7ce83a2457ea04c1fc4655ddb7d8dda535b5564f089c9981a9
+  data.tar.gz: d7bf0020c66eb425853e4135cb2c452000c388f190fdf094e41d556b6f4ead73e316d4c5f43893568d3a11b6a1cef47577dec921ba13e78d87b0718a9dcc8e60

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 2.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at chris@petersen.io. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Chris Petersen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# RRF
+
+RRF (Reciprocal Rank Fusion) is a Ruby gem that provides an implementation of the Reciprocal Rank Fusion (RRF) algorithm to merge and rank results from different search engines, specifically supporting ActiveRecord and Searchkick.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rrf'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install rrf
+```
+
+## Usage
+
+To use RRF, include the module in your ActiveRecord model and configure it as needed.
+
+### Example
+
+Let’s assume you have a model named Chunk that uses both ActiveRecord (with pgvector) and Searchkick:
+
+```ruby
+class Chunk < ApplicationRecord
+  include Searchkick
+  include RRF::Model
+
+  # ActiveRecord vector search using pgvector
+  # Assuming `embedding768` is a column of type `vector` (pgvector)
+
+  # Define any additional logic or methods as needed
+end
+```
+
+### Performing Searches and Fusing Results
+
+You can perform searches using ActiveRecord and Searchkick, and then fuse the results using the fuse method:
+
+```ruby
+# Configure the constant value if needed
+RRF.configure do |config|
+  config.rank_bias = 70 # User-defined value
+end
+
+# Perform Searchkick search
+es_result = Chunk.search("hi", 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)
+
+# Fuse the results and limit to 10
+result = Chunk.fuse(ar_result, es_result, limit: 10)
+
+# `result` now contains the top 10 fused search results
+```
+
+### Configuration
+
+You can configure the rank_bias value used in the RRF algorithm:
+
+```ruby
+RRF.configure do |config|
+  config.rank_bias = 70 # Default is 60
+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.
+
+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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/assaydepot/rrf.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/configuration.rb

@@ -0,0 +1,9 @@
+module RRF
+  class Configuration
+    attr_accessor :rank_bias
+
+    def initialize
+      @rank_bias = 60 # Default value
+    end
+  end
+end

data/lib/rrf/version.rb

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

data/lib/rrf.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "rrf/version"
+require "configuration"
+
+module RRF
+  class Error < StandardError; end
+
+  # Default configuration
+  @configuration = Configuration.new
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  module Model
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def fuse(*result_sets, limit: 10)
+        rank_bias = RRF.configuration.rank_bias
+        record_scores = Hash.new { |hash, key| hash[key] = { score: 0, id: key, sources: [] } }
+  
+        result_sets.each do |result_set|
+          if result_set.is_a?(ActiveRecord::Relation)
+            result_set.select(:id).each_with_index do |record, index|
+              score = 1.0 / (rank_bias + index)
+              record_scores[record.id][:score] += score
+              record_scores[record.id][:sources] << :active_record
+            end
+          elsif result_set.is_a?(Searchkick::Relation)
+            result_set.hits.each_with_index do |hit, index|
+              id = hit["_id"]
+              score = 1.0 / (rank_bias + index)
+              record_scores[id][:score] += score
+              record_scores[id][:sources] << :searchkick
+            end
+          else
+            raise RRF::Error, "Unsupported result set type: #{result_set.class}"
+          end
+        end
+
+        # 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] }
+        end
+      end
+    end
+  end
+end

data/sig/rrf.rbs

@@ -0,0 +1,4 @@
+module RRF
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: rrf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Petersen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-16 00:00:00.000000000 Z
+dependencies: []
+description: This gem provides an implementation of Reciprocal Rank Fusion (RRF) to
+  merge results from different search engines. Initially supporting Active Record
+  and Elasticsearch.
+email:
+- chris@scientist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/configuration.rb
+- lib/rrf.rb
+- lib/rrf/version.rb
+- sig/rrf.rbs
+homepage: https://github.com/assaydepot/rrf
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/assaydepot/rrf
+  source_code_uri: https://github.com/assaydepot/rrf
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: A Ruby gem for Reciprocal Rank Fusion across different search engines
+test_files: []