boxcars 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fc42578d07a962cd91fbab547ba657842c131729070e57bcf7789aa1648aaee
-  data.tar.gz: 3e3009663c45d58ee616d2d705c74f939b12922b24bceff74d231f5aeaff573d
+  metadata.gz: 8eb0adb30464688c5a68391ffb19a5d08188f87283d7cf3de28b12a30b927971
+  data.tar.gz: 94605b14f7974159d21eb2cf219b8d4695533761084fe784419e47a04843c6c2
 SHA512:
-  metadata.gz: d5a2664fb2b4973b57e41f682a9b194394bc196ada00b9c8cf9106a7876b92065cd9f40ff270650219c282143f812241e16fc450a24f61567acaaf413f44150f
-  data.tar.gz: 1d73a0c1519a3834852ffe7108e43e03460cc6e1b99dbcc9c16bf73c7824016d71628878b32394a33b548a0c84de7f9a41feefa1dc922628957eb0251269cd7a
+  metadata.gz: 4b92e4e8c98ada38bb4acf5ed5f0bd563bcfe2ab29d9781002a585799aba35cfa82992086484886563585ad0b7a9795691f9804ef4807b58aaa29c8bea88a761
+  data.tar.gz: e46f9a26fad0b0eb339868daef5bd4c05d750af08277f83b4edb15839a712553584223f056dc2aa403fccb8b5292a6ea57aadf12c04595f909d561f1fbbe2995

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [v0.1.4](https://github.com/BoxcarsAI/boxcars/tree/v0.1.4) (2023-02-22)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.1.3...v0.1.4)
+
+**Implemented enhancements:**
+
+- Extend Sql concept to produce and run ActiveRecord code instead of SQL [\#9](https://github.com/BoxcarsAI/boxcars/issues/9)
+
+**Merged pull requests:**
+
+- first pass at an ActiveRecord boxcar [\#18](https://github.com/BoxcarsAI/boxcars/pull/18) ([francis](https://github.com/francis))
+- change Boxcars::default\_train to Boxcars::train to improve code reada… [\#17](https://github.com/BoxcarsAI/boxcars/pull/17) ([francis](https://github.com/francis))
+- rename class Serp to GoogleSearch [\#16](https://github.com/BoxcarsAI/boxcars/pull/16) ([francis](https://github.com/francis))
+- Update README.md [\#15](https://github.com/BoxcarsAI/boxcars/pull/15) ([tabrez-syed](https://github.com/tabrez-syed))
+
 ## [v0.1.3](https://github.com/BoxcarsAI/boxcars/tree/v0.1.3) (2023-02-17)
 
 [Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.1.2...v0.1.3)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boxcars (0.1.4)
+    boxcars (0.1.5)
       google_search_results (~> 2.2)
       ruby-openai (~> 3.0)
 

data/README.md

@@ -4,16 +4,16 @@
   <a href="https://www.boxcars.ai">Website</a> |
   <a href="https://www.boxcars.ai/roadmap">Roadmap</a> |
   <a href="https://www.boxcars.ai/blog">Blog</a> |
-  <a href="https://www.boxcars.ai/en/introduction/">Documentation</a> 
+  <a href="https://github.com/BoxcarsAI/boxcars/wiki">Documentation</a> 
 </h4>
 
 <p align="center">
   <a href="https://github.com/BoxcarsAI/boxcars/blob/main/LICENSE.txt"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
 </p>
 
-Boxcars is a gem that enables you to create new systems with AI composability, using various concepts such as OpenAI, Search, SQL, Rails Active Record and more (including your concepts).
+Boxcars is a gem that enables you to create new systems with AI composability, using various concepts such as OpenAI, Search, SQL, Rails Active Record and more. This can even be extended with your concepts as well.(including your concepts).
 
-This work was inspired by the popular Python library Langchain. However, we wanted to give it a Ruby spin and make it more user-friendly for beginners to get started.
+This gem was inspired by the popular Python library Langchain. However, we wanted to give it a Ruby spin and make it more user-friendly for beginners to get started.
 
 ## Concepts
 All of these concepts are in a module named Boxcars:
@@ -79,10 +79,11 @@ Note that since Openai is currently the most used Engine, if you do not pass in
 calc = Boxcars::Calculator.new # just use the default Engine
 puts calc.run "what is pi to the forth power divided by 22.1?"
 ```
+You can change the default_engine with `Boxcars::configuration.default_engine = NewDefaultEngine`
 ### Boxcars currently implemmented
 
 Here is what we have so far, but please put up a PR with your new ideas.
-- Search: uses the SERP API to do seaches
+- GoogleSearch: uses the SERP API to do seaches
 - Calculator: uses an Engine to generate ruby code to do math
 - SQL: given an ActiveRecord connection, it will generate and run sql statments from a prompt.
 

data/boxcars.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Francis Sullivan", "Tabrez Syed"]
   spec.email = ["hi@boxcars.ai"]
 
-  spec.summary = "Boxcars provide an API to connect together Boxcars and then conduct them. Inspired by python langchain."
-  spec.description = "You simply give a number of boxcars to a train, and it does the magic."
+  spec.summary = "Boxcars is a gem that enables you to create new systems with AI composability. Inspired by python langchain."
+  spec.description = "You simply set an OpenAI key, give a number of Boxcars to a Train, and magic ensues when you run it."
   spec.homepage = "https://github.com/BoxcarsAI/boxcars"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"

data/lib/boxcars/boxcar/active_record.rb

@@ -7,26 +7,20 @@ module Boxcars
     # the description of this engine boxcar
     ARDESC = "useful for when you need to query a database for an application named %<name>s."
     LOCKED_OUT_MODELS = %w[ActiveRecord::SchemaMigration ActiveRecord::InternalMetadata ApplicationRecord].freeze
-    attr_accessor :connection, :input_key, :requested_models
+    attr_accessor :connection, :input_key, :requested_models, :read_only
     attr_reader :except_models
 
     # @param engine [Boxcars::Engine] The engine to user for this boxcar. Can be inherited from a train if nil.
     # @param models [Array<ActiveRecord::Model>] The models to use for this boxcar. Will use all if nil.
-    # @param input_key [Symbol] The key to use for the input. Defaults to :question.
-    # @param output_key [Symbol] The key to use for the output. Defaults to :answer.
-    # @param kwargs [Hash] Any other keyword arguments to pass to the parent class. This can include
-    #   :name, :description and :prompt
-    def initialize(engine: nil, models: nil, input_key: :question, output_key: :answer, **kwargs)
-      if models.is_a?(Array) && models.length.positive?
-        @requested_models = models
-        models.each do |m|
-          raise ArgumentError, "model #{m} needs to be an Active Record model" unless m.ancestors.include?(::ActiveRecord::Base)
-        end
-      elsif models
-        raise ArgumentError, "models needs to be an array of Active Record models"
-      end
+    # @param read_only [Boolean] Whether to use read only models. Defaults to true.
+    # @param kwargs [Hash] Any other keyword arguments. These can include:
+    #   :name, :description, :prompt, :input_key, :output_key and :except_models
+    def initialize(engine: nil, models: nil, read_only: true, **kwargs)
+      check_models(models)
       @except_models = LOCKED_OUT_MODELS + kwargs[:except_models].to_a
-      @input_key = input_key
+      @read_only = read_only
+      @input_key = kwargs[:input_key] || :question
+      @output_key = kwargs[:output_key] || :answer
       the_prompt = kwargs[prompt] || my_prompt
       name = kwargs[:name] || "Data"
       super(name: name,
@@ -60,6 +54,21 @@ module Boxcars
 
     private
 
+    def read_only?
+      read_only
+    end
+
+    def check_models(models)
+      if models.is_a?(Array) && models.length.positive?
+        @requested_models = models
+        models.each do |m|
+          raise ArgumentError, "model #{m} needs to be an Active Record model" unless m.ancestors.include?(::ActiveRecord::Base)
+        end
+      elsif models
+        raise ArgumentError, "models needs to be an array of Active Record models"
+      end
+    end
+
     def wanted_models
       the_models = requested_models || ::ActiveRecord::Base.descendants
       the_models.reject { |m| except_models.include?(m.name) }
@@ -75,18 +84,49 @@ module Boxcars
       models.pretty_inspect
     end
 
+    # to be safe, we wrap the code in a transaction and rollback
+    # rubocop:disable Lint/SuppressedException
+    def wrap_in_transaction
+      ::ActiveRecord::Base.transaction do
+        yield
+      ensure
+        raise ::ActiveRecord::Rollback
+      end
+    rescue ::ActiveRecord::Rollback
+    end
+    # rubocop:enable Lint/SuppressedException
+
+    def safe_to_run?(code)
+      return true unless read_only?
+
+      bad_words = %w[delete delete_all destroy destroy_all update update_all upsert upsert_all create save insert drop alter
+                     truncate revoke commit rollback reset execute].freeze
+      without_strings = code.gsub(/('([^'\\]*(\\.[^'\\]*)*)'|"([^"\\]*(\\.[^"\\]*)*"))/, 'XX')
+      word_list = without_strings.split(/[.,()]/)
+
+      bad_words.each do |w|
+        if word_list.include?(w)
+          puts "code included destructive instruction: #{w} #{code}"
+          return false
+        end
+      end
+
+      true
+    end
+
     def get_active_record_answer(text)
       code = text[/^ARCode: (.*)/, 1]
       puts code.colorize(:yellow)
-      begin
-        # rubocop:disable Security/Eval
-        output = eval code
-        # rubocop:enable Security/Eval
-        output = output.first if output.is_a?(Array) && output.length == 1
-        "Answer: #{output.inspect}"
-      rescue StandardError => e
-        "Error: #{e.message}"
-      end
+      raise SecurityError, "Can not run code that makes changes in read-only mode" unless safe_to_run?(code)
+
+      # rubocop:disable Security/Eval
+      output = eval code
+      # rubocop:enable Security/Eval
+      output = 0 if output.is_a?(Array) && output.empty?
+      output = output.first if output.is_a?(Array) && output.length == 1
+      "Answer: #{output.inspect}"
+    rescue StandardError => e
+      "Error: #{e.message}"
     end
 
     def get_answer(text)

data/lib/boxcars/train/zero_shot.rb

@@ -33,14 +33,15 @@ module Boxcars
     # @param engine [Boxcars::Engine] The engine to use for this train.
     # @param name [String] The name of the train. Defaults to 'Zero Shot'.
     # @param description [String] The description of the train. Defaults to 'Zero Shot Train'.
-    def initialize(boxcars:, engine: nil, name: 'Zero Shot', description: 'Zero Shot Train')
+    # @param prompt [Boxcars::Prompt] The prompt to use. Defaults to the built-in prompt.
+    def initialize(boxcars:, engine: nil, name: 'Zero Shot', description: 'Zero Shot Train', prompt: nil)
       @observation_prefix = 'Observation: '
       @engine_prefix = 'Thought:'
-      prompt = self.class.create_prompt(boxcars: boxcars)
+      prompt ||= self.class.create_prompt(boxcars: boxcars)
       super(engine: engine, boxcars: boxcars, prompt: prompt, name: name, description: description)
     end
 
-    # Create prompt in the style of the zero shot agent.
+    # Create prompt in the style of the zero shot agent. Without arguments, returns the default prompt.
     # @param boxcars [Array<Boxcars::Boxcar>] List of boxcars the agent will have access to, used to format the prompt.
     # @param prefix [String] String to put before the main prompt.
     # @param suffix [String] String to put after the main prompt.

data/lib/boxcars/version.rb

@@ -2,5 +2,5 @@
 
 module Boxcars
   # The current version of the gem.
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/boxcars.rb

@@ -16,6 +16,9 @@ module Boxcars
   # Error class for all Boxcars value errors.
   class ValueError < Error; end
 
+  # Error class for all Boxcars security errors.
+  class SecurityError < Error; end
+
   # simple string colorization
   class ::String
     # colorize a string

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcars
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Francis Sullivan
@@ -81,7 +81,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: You simply give a number of boxcars to a train, and it does the magic.
+description: You simply set an OpenAI key, give a number of Boxcars to a Train, and
+  magic ensues when you run it.
 email:
 - hi@boxcars.ai
 executables: []
@@ -144,6 +145,6 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: Boxcars provide an API to connect together Boxcars and then conduct them.
+summary: Boxcars is a gem that enables you to create new systems with AI composability.
   Inspired by python langchain.
 test_files: []