langchainrb_rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a931eb26d7f80828dd7c24d5c03e89e2c0050a45653904f9e1b03d8f14a5da6f
-  data.tar.gz: 0f3aaf4c70b6ded7a81351c1fc39131ea86dec28e2ec411fc408f53a07e1fec0
+  metadata.gz: b792e1a7888a17c54fad522042ee7f6935df92e684119d4177f9627abb999dfd
+  data.tar.gz: 77444b9ed6d52443c890f045c121ba1a58f78b4d532954fc858e8c01999c90a7
 SHA512:
-  metadata.gz: f61cfaa83f6d799d22ae02d5ae749f55e0918cb42e568050c7b9ca93d3859bbfcc6d0082ef6181ab2c0a6f3f2b376cbc3c3b983915d98a009b4cc3d05eb33a55
-  data.tar.gz: 026f538572f9a5b63253ea788f1f76e1982182b8dd931cee435c18de9db2f1d2210684af04cdd597a9f6c76d3c9e30133be0268378d9213d965346f653043bdf
+  metadata.gz: 5d26a5c5d4a10e6ea4794d809ceb15feb6262deb4754bfc12362e1e0e536b8643f46a9f98d464ae7372d6ef1b3d45ed34cf0d5e4c88977b135b4be1d982d5c85
+  data.tar.gz: '084a74842710d2b24db00e01344cbde645249671f4f975a9cc8f37763af53597e4cd3d2b5cd0f036320e181cbc20f8be8dca525279550529f9d58d8234fd601b'

data/Gemfile.lock

@@ -1,21 +1,111 @@
 PATH
   remote: .
   specs:
-    langchainrb_rails (0.1.1)
+    langchainrb_rails (0.1.2)
       langchainrb (~> 0.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (7.1.1)
+      actionpack (= 7.1.1)
+      activesupport (= 7.1.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.1)
+      actionpack (= 7.1.1)
+      activejob (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.1)
+      actionpack (= 7.1.1)
+      actionview (= 7.1.1)
+      activejob (= 7.1.1)
+      activesupport (= 7.1.1)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.1)
+      actionview (= 7.1.1)
+      activesupport (= 7.1.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.1)
+      actionpack (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.1)
+      activesupport (= 7.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.1)
+      activesupport (= 7.1.1)
+      globalid (>= 0.3.6)
+    activemodel (7.1.1)
+      activesupport (= 7.1.1)
+    activerecord (7.1.1)
+      activemodel (= 7.1.1)
+      activesupport (= 7.1.1)
+      timeout (>= 0.4.0)
+    activestorage (7.1.1)
+      actionpack (= 7.1.1)
+      activejob (= 7.1.1)
+      activerecord (= 7.1.1)
+      activesupport (= 7.1.1)
+      marcel (~> 1.0)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
     addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     baran (0.1.9)
     base64 (0.1.1)
+    bigdecimal (3.1.4)
+    builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
     colorize (0.8.1)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.3)
     diff-lcs (1.5.0)
+    drb (2.1.1)
+      ruby2_keywords
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.8.3)
+      rdoc
+      reline (>= 0.3.8)
     json (2.6.3)
     json-schema (4.0.0)
       addressable (>= 2.8)
@@ -28,7 +118,31 @@ GEM
       zeitwerk (~> 2.5)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
+    loofah (2.21.4)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
     method_source (1.0.0)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    mutex_m (0.1.2)
+    net-imap (0.4.2)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.15.4-x86_64-darwin)
+      racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.4)
       ast (~> 2.4.1)
@@ -41,11 +155,54 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
+    psych (5.1.1.1)
+      stringio
     public_suffix (5.0.3)
     racc (1.7.1)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.1)
+      actioncable (= 7.1.1)
+      actionmailbox (= 7.1.1)
+      actionmailer (= 7.1.1)
+      actionpack (= 7.1.1)
+      actiontext (= 7.1.1)
+      actionview (= 7.1.1)
+      activejob (= 7.1.1)
+      activemodel (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      bundler (>= 1.15.0)
+      railties (= 7.1.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.1)
+      actionpack (= 7.1.1)
+      activesupport (= 7.1.1)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.0.6)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
     regexp_parser (2.8.2)
+    reline (0.3.9)
+      io-console (~> 0.5)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -78,6 +235,7 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     standard (1.31.2)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
@@ -92,9 +250,18 @@ GEM
       rubocop-performance (~> 1.19.1)
     standardrb (1.0.1)
       standard
+    stringio (3.0.8)
+    thor (1.3.0)
     tiktoken_ruby (0.0.6-x86_64-darwin)
+    timeout (0.4.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode (0.4.4.4)
     unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
     yard (0.9.34)
     zeitwerk (2.6.11)
 
@@ -105,6 +272,7 @@ DEPENDENCIES
   langchainrb
   langchainrb_rails!
   pry-byebug (~> 3.10.0)
+  rails (> 6.0.0)
   rake (~> 13.0)
   rspec (~> 3.0)
   standardrb

data/README.md

@@ -4,8 +4,6 @@
 
 👨‍💻👩‍💻 CURRENTLY SEEKING PEOPLE TO FORM THE CORE GROUP OF MAINTAINERS WITH
 
-:warning: UNDER ACTIVE AND RAPID DEVELOPMENT (MAY BE BUGGY AND UNTESTED)
-
 ![Tests status](https://github.com/andreibondarev/langchainrb_rails/actions/workflows/ci.yml/badge.svg?branch=main)
 [![Gem Version](https://badge.fury.io/rb/langchainrb_rails.svg)](https://badge.fury.io/rb/langchainrb_rails)
 [![Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/gems/langchainrb_rails)
@@ -25,8 +23,19 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     gem install langchainrb_rails
 
-## Usage
+## Rails Generators
+
+### Pinecone Generator - adds vectorsearch to your ActiveRecord model
 
-```ruby
-require "langchainrb_rails"
 ```
+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

data/lib/langchainrb_rails/active_record/hooks.rb

@@ -9,12 +9,7 @@ module LangchainrbRails
     #
     # 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 LangchainrbRails
         # 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

data/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

data/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

data/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

data/lib/langchainrb_rails/railtie.rb

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

data/lib/langchainrb_rails/version.rb

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

data/lib/langchainrb_rails.rb

@@ -3,6 +3,7 @@
 require "langchain"
 require_relative "langchainrb_rails/version"
 require "langchainrb_rails/railtie"
+require "langchainrb_rails/config"
 
 module LangchainrbRails
   class Error < StandardError; end
@@ -10,4 +11,23 @@ module LangchainrbRails
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: langchainrb_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrei Bondarev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2023-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: langchainrb
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.34
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 description: Rails wrapper for langchainrb gem
 email:
 - andrei.bondarev13@gmail.com
@@ -68,6 +82,9 @@ files:
 - Rakefile
 - lib/langchainrb_rails.rb
 - lib/langchainrb_rails/active_record/hooks.rb
+- lib/langchainrb_rails/config.rb
+- lib/langchainrb_rails/generators/langchainrb_rails/pinecone_generator.rb
+- lib/langchainrb_rails/generators/langchainrb_rails/templates/pinecone_initializer.rb.tt
 - lib/langchainrb_rails/railtie.rb
 - lib/langchainrb_rails/version.rb
 - sig/langchainrb_rails.rbs