langchainrb_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c1e0233e3c6a9b90521be85e3ce43bb0eafab6f148cc5e7ce3183493d0be423
+  data.tar.gz: 20e683575cbc95f361df5c642fdb922638d541ffbcb8018907a76305243b852b
+SHA512:
+  metadata.gz: 310d63172807b8cb6fcb58056fce57800a6c074423b5cd880b6ca4fd9900b44f657b8bd7dfd39de8aefc30085a257c8467708a3afd4d6cbfafe3949f5970e5d6
+  data.tar.gz: 5b721ba6d1801760779d94e66718f6de0e0e3b242814419fd4fc664b2ba335aa585b53de706d6e44176b1609f6ff7e5be8dc3c73b114bedd34cb7b99aa4f2fd7

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-10-22
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in langchainrb_rails.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standardrb"
+
+gem "langchainrb"

data/Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    langchainrb_rails (0.1.0)
+      langchainrb (~> 0.6.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    baran (0.1.9)
+    base64 (0.1.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    json-schema (4.0.0)
+      addressable (>= 2.8)
+    langchainrb (0.6.19)
+      baran (~> 0.1.9)
+      colorize (~> 0.8.1)
+      json-schema (~> 4.0.0)
+      pragmatic_segmenter (~> 0.3.0)
+      tiktoken_ruby (~> 0.0.5)
+      zeitwerk (~> 2.5)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    method_source (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pragmatic_segmenter (0.3.23)
+      unicode
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    public_suffix (5.0.3)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.4)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.31.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.56.4)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.1)
+    standardrb (1.0.1)
+      standard
+    tiktoken_ruby (0.0.6-x86_64-darwin)
+    unicode (0.4.4.4)
+    unicode-display_width (2.5.0)
+    yard (0.9.34)
+    zeitwerk (2.6.11)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  langchainrb
+  langchainrb_rails!
+  pry-byebug (~> 3.10.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standardrb
+  yard (~> 0.9.34)
+
+BUNDLED WITH
+   2.4.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Andrei Bondarev
+
+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,32 @@
+💎🔗 Langchain.rb for Rails
+---
+⚡ Building applications with LLMs through composability ⚡
+
+👨‍💻👩‍💻 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)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/andreibondarev/langchainrb_rails/blob/main/LICENSE.txt)
+[![](https://dcbadge.vercel.app/api/server/WDARp7J2n8?compact=true&style=flat)](https://discord.gg/WDARp7J2n8)
+
+
+Langchain.rb is a library that's an abstraction layer on top many emergent AI, ML and other DS tools. The goal is to abstract complexity and difficult concepts to make building AI/ML-supercharged applications approachable for traditional software engineers.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    bundle add langchainrb_rails
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    gem install langchainrb_rails
+
+## Usage
+
+```ruby
+require "langchainrb_rails"
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/langchainrb_rails/active_record/hooks.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module LangchainrbRails
+  module ActiveRecord
+    # This module adds the following functionality to your ActiveRecord models:
+    # * `vectorsearch` class method to set the vector search provider
+    # * `similarity_search` class method to search for similar texts
+    # * `upsert_to_vectorsearch` instance method to upsert the record to the vector search provider
+    #
+    # 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"])
+    #                 )
+    #
+    #       after_save :upsert_to_vectorsearch
+    #
+    #       # Overwriting how the model is serialized before it's indexed
+    #       def as_vector
+    #         [
+    #           "Title: #{title}",
+    #           "Description: #{description}",
+    #           ...
+    #         ]
+    #         .compact
+    #         .join("\n")
+    #       end
+    #     end
+    #
+    # Create the default schema
+    #     Recipe.class_variable_get(:@@provider).create_default_schema
+    # Query the vector search provider
+    #     Recipe.similarity_search("carnivore dish")
+    # Delete the default schema to start over
+    #     Recipe.class_variable_get(:@@provider).destroy_default_schema
+    #
+    module Hooks
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # Index the text to the vector search provider
+      # You'd typically call this method in an ActiveRecord callback
+      #
+      # @return [Boolean] true
+      # @raise [Error] Indexing to vector search DB failed
+      def upsert_to_vectorsearch
+        if previously_new_record?
+          self.class.class_variable_get(:@@provider).add_texts(
+            texts: [as_vector],
+            ids: [id]
+          )
+        else
+          self.class.class_variable_get(:@@provider).update_texts(
+            texts: [as_vector],
+            ids: [id]
+          )
+        end
+      end
+
+      # Used to serialize the DB record to an indexable vector text
+      # Overwrite this method in your model to customize
+      #
+      # @return [String] the text representation of the model
+      def as_vector
+        to_json
+      end
+
+      module ClassMethods
+        # Set the vector search provider
+        #
+        # @param provider [Object] The `Langchain::Vectorsearch::*` instance
+        def vectorsearch(provider:)
+          class_variable_set(:@@provider, provider)
+        end
+
+        # Search for similar texts
+        #
+        # @param query [String] The query to search for
+        # @param k [Integer] The number of results to return
+        # @return [ActiveRecord::Relation] The ActiveRecord relation
+        def similarity_search(query, k: 1)
+          records = class_variable_get(:@@provider).similarity_search(
+            query: query,
+            k: k
+          )
+
+          # We use "__id" when Weaviate is the provider
+          ids = records.map { |record| record.dig("id") || record.dig("__id") }
+          where(id: ids)
+        end
+
+        # Ask a question and return the answer
+        #
+        # @param question [String] The question to ask
+        # @param k [Integer] The number of results to have in context
+        # @yield [String] Stream responses back one String at a time
+        # @return [String] The answer to the question
+        def ask(question:, k: 4, &block)
+          class_variable_get(:@@provider).ask(
+            question: question,
+            k: k,
+            &block
+          )
+        end
+      end
+    end
+  end
+end

data/lib/langchainrb_rails/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LangchainrbRails
+  class Railtie < Rails::Railtie
+    initializer "langchain" do
+      ActiveSupport.on_load(:active_record) do
+        ::ActiveRecord::Base.include LangchainrbRails::ActiveRecord::Hooks
+      end
+    end
+  end
+end

data/lib/langchainrb_rails/version.rb

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

data/lib/langchainrb_rails.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "langchain"
+require_relative "langchainrb_rails/version"
+require "langchainrb_rails/railtie"
+
+module LangchainrbRails
+  class Error < StandardError; end
+  
+  module ActiveRecord
+    autoload :Hooks, "langchainrb_rails/active_record/hooks"
+  end
+end

data/sig/langchainrb_rails.rbs

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

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: langchainrb_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrei Bondarev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: langchainrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.19
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.19
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+description: Rails wrapper for langchainrb gem
+email:
+- andrei.bondarev13@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/langchainrb_rails.rb
+- lib/langchainrb_rails/active_record/hooks.rb
+- lib/langchainrb_rails/railtie.rb
+- lib/langchainrb_rails/version.rb
+- sig/langchainrb_rails.rbs
+homepage: https://rubygems.org/gems/langchainrb_rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/langchainrb_rails
+  source_code_uri: https://github.com/andreibondarev/langchainrb_rails
+  changelog_uri: https://github.com/andreibondarev/langchainrb_rails/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/langchainrb_rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Rails wrapper for langchainrb gem
+test_files: []