Merge pull request #3 from andreibondarev/pinecone-generator

Pinecone generator

Author: andreibondarev

README.md

@@ -25,8 +25,19 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     gem install langchainrb_rails
 
-## Usage
+## Rails Generators
 
-```ruby
-require "langchainrb_rails"
+### Pinecone Generator - adds vectorsearch to your ActiveRecord model
+
+```
+rails generate langchainrb_rails:pinecone --model=Product --llm=openai
 ```
+
+Available `--llm` options: `cohere`, `google_palm`, `hugging_face`, `llama_cpp`, `ollama`, `openai`, and `replicate`. The selected LLM will be used to generate embeddings and completions.
+
+The `--model` option is used to specify which ActiveRecord model vectorsearch capabilities will be added to.
+
+Pinecone Generator does the following:
+1. Creates the `config/initializers/langchainrb_rails.rb` initializer file
+2. Adds necessary code to the ActiveRecord model to enable vectorsearch
+3. Adds `pinecone` gem to the Gemfile

lib/langchainrb_rails.rb

@@ -3,11 +3,31 @@
 require "langchain"
 require_relative "langchainrb_rails/version"
 require "langchainrb_rails/railtie"
+require "langchainrb_rails/config"
 
 module LangchainrbRails
   class Error < StandardError; end
 
   module ActiveRecord
     autoload :Hooks, "langchainrb_rails/active_record/hooks"
   end
+
+  module Generators
+    autoload :PgvectorGenerator, "langchainrb_rails/generators/langchainrb_rails/pgvector_generator"
+  end
+
+  class << self
+    # Configures global settings for LangchainrbRails
+    #     LangchainrbRails.configure do |config|
+    #       config.vectorsearch = ...
+    #     end
+    def configure
+      yield(config)
+    end
+
+    # @return [Config] The global configuration object
+    def config
+      @_config ||= Config.new
+    end
+  end
 end

lib/langchainrb_rails/active_record/hooks.rb

@@ -9,12 +9,7 @@ module ActiveRecord
     #
     # Usage:
     #     class Recipe < ActiveRecord::Base
-    #       vectorsearch provider: Langchain::Vectorsearch::Weaviate.new(
-    #                    api_key: ENV["WEAVIATE_API_KEY"],
-    #                    url: ENV["WEAVIATE_URL"],
-    #                    index_name: "Recipes",
-    #                    llm: Langchain::LLM::OpenAI.new(api_key: ENV["OPENAI_API_KEY"])
-    #                 )
+    #       vectorsearch
     #
     #       after_save :upsert_to_vectorsearch
     #
@@ -73,8 +68,8 @@ module ClassMethods
         # Set the vector search provider
         #
         # @param provider [Object] The `Langchain::Vectorsearch::*` instance
-        def vectorsearch(provider:)
-          class_variable_set(:@@provider, provider)
+        def vectorsearch
+          class_variable_set(:@@provider, LangchainrbRails.config.vectorsearch)
         end
 
         # Search for similar texts

lib/langchainrb_rails/config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module LangchainrbRails
+  class Config
+    # This class is used to configure the gem config inside Rails apps, in the `config/initializers/langchainrb_rails.rb` file.
+    #
+    # Langchain is configured in the following way:
+    #     LangchainrbRails.configure do |config|
+    #       config.vectorsearch = ...
+    #     end
+    attr_accessor :vectorsearch
+
+    def initialize
+      # Define the defaults for future configuration here
+      @vectorsearch = {}
+    end
+  end
+end

lib/langchainrb_rails/generators/langchainrb_rails/pinecone_generator.rb

@@ -0,0 +1,70 @@
+require "rails/generators/active_record"
+
+module LangchainrbRails
+  module Generators
+    #
+    # PineconeGenerator does the following:
+    # 1. Creates the `langchainrb_rails.rb` initializer file
+    # 2. Adds necessary code to the ActiveRecord model to enable vectorsearch
+    # 3. Adds `pinecone` gem to the Gemfile
+    #
+    # Usage:
+    #     rails generate langchainrb_rails:pinecone --model=Product --llm=openai
+    #
+    class PineconeGenerator < Rails::Generators::Base
+      desc "This generator adds Pinecone vectorsearch integration to your ActiveRecord model"
+
+      include ::ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
+
+      class_option :model, type: :string, required: true, desc: "ActiveRecord Model to add vectorsearch to", aliases: "-m"
+      class_option :llm, type: :string, required: true, desc: "LLM provider that will be used to generate embeddings and completions"
+
+      # Available LLM providers to be passed in as --llm option
+      LLMS = {
+        "cohere" => "Langchain::LLM::Cohere",
+        "google_palm" => "Langchain::LLM::GooglePalm",
+        "hugging_face" => "Langchain::LLM::HuggingFace",
+        "llama_cpp" => "Langchain::LLM::LlamaCpp",
+        "ollama" => "Langchain::LLM::Ollama",
+        "openai" => "Langchain::LLM::OpenAI",
+        "replicate" => "Langchain::LLM::Replicate"
+      }
+
+      # Creates the `langchainrb_rails.rb` initializer file
+      def create_initializer_file
+        template "pinecone_initializer.rb", "config/initializers/langchainrb_rails.rb"
+      end
+
+      # Adds `vectorsearch` class method to the model and `after_save` callback that calls `upsert_to_vectorsearch()`
+      def add_to_model
+        inject_into_class "app/models/#{model_name.downcase}.rb", model_name do
+          "  vectorsearch\n\n  after_save :upsert_to_vectorsearch\n\n"
+        end
+      end
+
+      # Adds `pinecone` gem to the Gemfile
+      # TODO: Can we automatically run `bundle install`?
+      def add_to_gemfile
+        gem "pinecone"
+      end
+
+      private
+
+      # @return [String] Name of the model
+      def model_name
+        options["model"]
+      end
+
+      # @return [String] LLM provider to use
+      def llm
+        options["llm"]
+      end
+
+      # @return [Langchain::LLM::*] LLM class
+      def llm_class
+        Langchain::LLM.const_get(LLMS[llm])
+      end
+    end
+  end
+end

lib/langchainrb_rails/generators/langchainrb_rails/templates/pinecone_initializer.rb.tt

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+LangchainrbRails.configure do |config|
+  config.vectorsearch = Langchain::Vectorsearch::Pinecone.new(
+    llm: <%= llm_class %>.new(api_key: ENV["<%= llm.upcase %>_API_KEY"]),
+    environment: "",
+    api_key: ENV["PINECONE_API_KEY"],
+    index_name: ""
+  )
+end

lib/langchainrb_rails/railtie.rb

@@ -7,5 +7,9 @@ class Railtie < Rails::Railtie
         ::ActiveRecord::Base.include LangchainrbRails::ActiveRecord::Hooks
       end
     end
+
+    generators do
+      require_relative "generators/langchainrb_rails/pinecone_generator"
+    end
   end
 end

spec/config_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe LangchainrbRails::Config do
+  it "has a vectorsearch property" do
+    expect(subject).to respond_to(:vectorsearch)
+  end
+end