rag-ruby 0.1.0

data/lib/rag_ruby/stores/memory.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RagRuby
+  module Stores
+    class Memory < Base
+      Entry = Struct.new(:id, :embedding, :metadata, :chunk, keyword_init: true)
+
+      def initialize(dimension: nil)
+        @dimension = dimension
+        @entries = {}
+      end
+
+      def add(id, embedding:, metadata: {}, chunk: nil)
+        @entries[id] = Entry.new(id: id, embedding: embedding, metadata: metadata, chunk: chunk)
+      end
+
+      def search(embedding, top_k: 5, filter: nil)
+        results = @entries.values
+
+        if filter
+          results = results.select do |entry|
+            filter.all? { |k, v| entry.metadata[k] == v }
+          end
+        end
+
+        results
+          .map { |entry| [entry, cosine_similarity(embedding, entry.embedding)] }
+          .sort_by { |_, score| -score }
+          .first(top_k)
+          .map { |entry, score| { id: entry.id, score: score, metadata: entry.metadata, chunk: entry.chunk } }
+      end
+
+      def delete(id)
+        @entries.delete(id)
+      end
+
+      def count
+        @entries.size
+      end
+
+      def clear
+        @entries.clear
+      end
+
+      private
+
+      def cosine_similarity(a, b)
+        dot = a.zip(b).sum { |x, y| x * y }
+        mag_a = Math.sqrt(a.sum { |x| x * x })
+        mag_b = Math.sqrt(b.sum { |x| x * x })
+        return 0.0 if mag_a == 0 || mag_b == 0
+
+        dot / (mag_a * mag_b)
+      end
+    end
+  end
+end

data/lib/rag_ruby/stores/zvec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RagRuby
+  module Stores
+    class Zvec < Base
+      def initialize(path:, dimension:)
+        @path = path
+        @dimension = dimension
+
+        begin
+          require "zvec"
+        rescue LoadError
+          raise LoadError, "zvec-ruby gem is required for Zvec store. Add `gem 'zvec-ruby'` to your Gemfile."
+        end
+
+        @index = ::Zvec::Index.new(path: path, dimension: dimension)
+      end
+
+      def add(id, embedding:, metadata: {}, chunk: nil)
+        @index.add(id, embedding: embedding, metadata: metadata)
+      end
+
+      def search(embedding, top_k: 5, filter: nil)
+        results = @index.search(embedding, top_k: top_k)
+
+        if filter
+          results = results.select do |r|
+            filter.all? { |k, v| r[:metadata][k] == v }
+          end
+        end
+
+        results
+      end
+
+      def delete(id)
+        @index.delete(id)
+      end
+
+      def count
+        @index.count
+      end
+    end
+  end
+end

data/lib/rag_ruby/version.rb

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

data/lib/rag_ruby.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative "rag_ruby/version"
+require_relative "rag_ruby/document"
+require_relative "rag_ruby/chunk"
+require_relative "rag_ruby/source"
+require_relative "rag_ruby/answer"
+require_relative "rag_ruby/prompt_template"
+
+require_relative "rag_ruby/loaders/base"
+require_relative "rag_ruby/loaders/file"
+require_relative "rag_ruby/loaders/directory"
+require_relative "rag_ruby/loaders/url"
+require_relative "rag_ruby/loaders/active_record"
+
+require_relative "rag_ruby/embedders/base"
+require_relative "rag_ruby/embedders/openai"
+
+require_relative "rag_ruby/stores/base"
+require_relative "rag_ruby/stores/memory"
+
+require_relative "rag_ruby/generators/base"
+require_relative "rag_ruby/generators/openai"
+
+require_relative "rag_ruby/configuration"
+require_relative "rag_ruby/pipeline"
+
+module RagRuby
+  class Error < StandardError; end
+
+  class << self
+    def pipeline
+      @pipeline ||= Pipeline.new
+    end
+
+    def configure(&block)
+      @pipeline = Pipeline.new(&block)
+    end
+
+    def configure_from_hash(hash)
+      @pipeline = Pipeline.new do |config|
+        if (chunker_config = hash["chunker"])
+          config.chunker(
+            (chunker_config["strategy"] || "recursive_character").to_sym,
+            chunk_size: chunker_config["chunk_size"] || 1000,
+            chunk_overlap: chunker_config["chunk_overlap"] || 200
+          )
+        end
+
+        if (embedder_config = hash["embedder"])
+          provider = (embedder_config["provider"] || "openai").to_sym
+          opts = embedder_config.reject { |k, _| k == "provider" }
+            .transform_keys(&:to_sym)
+          config.embedder(provider, **opts)
+        end
+
+        if (store_config = hash["store"])
+          provider = (store_config["provider"] || "memory").to_sym
+          opts = store_config.reject { |k, _| k == "provider" }
+            .transform_keys(&:to_sym)
+          config.store(provider, **opts)
+        end
+
+        if (gen_config = hash["generator"])
+          provider = (gen_config["provider"] || "openai").to_sym
+          opts = gen_config.reject { |k, _| k == "provider" }
+            .transform_keys(&:to_sym)
+          config.generator(provider, **opts)
+        end
+      end
+    end
+
+    def search(query, top_k: 5, filter: nil)
+      embedding = pipeline.config.embedder_instance.embed(query)
+      pipeline.config.store_instance.search(embedding, top_k: top_k, filter: filter)
+    end
+
+    def ask(question, **opts)
+      pipeline.query(question, **opts)
+    end
+
+    def reset!
+      @pipeline = nil
+    end
+  end
+end
+
+# Auto-load Rails integration when Rails is present
+if defined?(Rails)
+  require_relative "rag_ruby/rails/railtie"
+  require_relative "rag_ruby/rails/indexable"
+end

data/rag-ruby.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/rag_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rag-ruby"
+  spec.version = RagRuby::VERSION
+  spec.authors = ["Johannes Dwi Cahyo"]
+  spec.email = ["johannes@example.com"]
+
+  spec.summary = "RAG (Retrieval-Augmented Generation) pipeline framework for Ruby and Rails"
+  spec.description = "A batteries-included RAG framework that orchestrates document loading, " \
+                     "chunking, embedding, vector storage, retrieval, and generation. " \
+                     "Think LangChain for Ruby — simpler, more opinionated, and Rails-native."
+  spec.homepage = "https://github.com/johannesdwicahyo/rag-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?("test/", "spec/", "examples/", ".git")
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "chunker-ruby", "~> 0.1"
+
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: rag-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Johannes Dwi Cahyo
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chunker-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A batteries-included RAG framework that orchestrates document loading,
+  chunking, embedding, vector storage, retrieval, and generation. Think LangChain
+  for Ruby — simpler, more opinionated, and Rails-native.
+email:
+- johannes@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rag_ruby.rb
+- lib/rag_ruby/answer.rb
+- lib/rag_ruby/chunk.rb
+- lib/rag_ruby/configuration.rb
+- lib/rag_ruby/document.rb
+- lib/rag_ruby/embedders/base.rb
+- lib/rag_ruby/embedders/cohere.rb
+- lib/rag_ruby/embedders/onnx.rb
+- lib/rag_ruby/embedders/openai.rb
+- lib/rag_ruby/generators/base.rb
+- lib/rag_ruby/generators/openai.rb
+- lib/rag_ruby/generators/ruby_llm.rb
+- lib/rag_ruby/loaders/active_record.rb
+- lib/rag_ruby/loaders/base.rb
+- lib/rag_ruby/loaders/directory.rb
+- lib/rag_ruby/loaders/file.rb
+- lib/rag_ruby/loaders/url.rb
+- lib/rag_ruby/pipeline.rb
+- lib/rag_ruby/prompt_template.rb
+- lib/rag_ruby/rails/generators/install_generator.rb
+- lib/rag_ruby/rails/generators/templates/initializer.rb
+- lib/rag_ruby/rails/generators/templates/rag.yml
+- lib/rag_ruby/rails/indexable.rb
+- lib/rag_ruby/rails/railtie.rb
+- lib/rag_ruby/source.rb
+- lib/rag_ruby/stores/base.rb
+- lib/rag_ruby/stores/memory.rb
+- lib/rag_ruby/stores/zvec.rb
+- lib/rag_ruby/version.rb
+- rag-ruby.gemspec
+homepage: https://github.com/johannesdwicahyo/rag-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/johannesdwicahyo/rag-ruby
+  source_code_uri: https://github.com/johannesdwicahyo/rag-ruby
+  changelog_uri: https://github.com/johannesdwicahyo/rag-ruby/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: RAG (Retrieval-Augmented Generation) pipeline framework for Ruby and Rails
+test_files: []