boxcars 0.2.15 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94f8c86ef9a5d967f854447e0e2807d116ca95c2ebfe40fc624162144fbf77a3
-  data.tar.gz: 1230243ce0c1d6fb37855d093202daa65584df540f306bea57a1ed3daf331c45
+  metadata.gz: 92af5ad71c16886afc760bcc1b98a1d050486f8cf7010e0f05ee5015aa767710
+  data.tar.gz: a0e5f39d40f79d4e4e5e337c00657764b5f9b329ec6bcc0f5a6e4ea62b0675b5
 SHA512:
-  metadata.gz: 50d40ff9d3e5bd80f65dee223bd5f4de6c90d681b797f973f665a770bfc64f761acc4c2f22ef39f59731064c1350af56a47525d867acfc223a79635ded27906d
-  data.tar.gz: b574a4f7f27f2f24e2ca13577b51cdaf609a00a5372d3f8b112c724412c66f08242a7853abe1e8c7ae542ecc28854c07a01be803606c27cba87153a4a21086a7
+  metadata.gz: 06123e9f6ea4cb294b258056b6e50af7654b2c4866b1585fb32e520eee4e64dcdecc7cf8dc4d019a42a3193b01be6a02fba8190ef52add4eb70ad7f1a79d492c
+  data.tar.gz: 3320ee8fdb68a4bf9601a6a584d64517242e0e80b14b812b6f04f3e0eaed05b5d520541e5547c72b7b3a8ebea044e7173163cafccc2cc8f9bb5c25b25a231ffe

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v0.2.15](https://github.com/BoxcarsAI/boxcars/tree/v0.2.15) (2023-06-09)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.2.14...v0.2.15)
+
+**Merged pull requests:**
+
+- make suggested next actions optional [\#94](https://github.com/BoxcarsAI/boxcars/pull/94) ([francis](https://github.com/francis))
+
 ## [v0.2.14](https://github.com/BoxcarsAI/boxcars/tree/v0.2.14) (2023-06-06)
 
 [Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.2.13...v0.2.14)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boxcars (0.2.15)
+    boxcars (0.2.16)
       google_search_results (~> 2.2)
       gpt4all (~> 0.0.4)
       hnswlib (~> 0.8)

data/README.md

@@ -10,7 +10,7 @@
   <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, Vector Search and more. This can even be extended with your concepts as well (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 (with both Sequel an Active Record support), Rails Active Record, Vector Search and more. This can even be extended with your concepts as well (including your concepts).
 
 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.
 

data/lib/boxcars/boxcar/sql_active_record.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Boxcars is a framework for running a series of tools to get an answer to a question.
+module Boxcars
+  # A Boxcar that interprets a prompt and executes SQL code using Active Record to get answers
+  class SQLActiveRecord < SQLBase
+    # @param connection [ActiveRecord::Connection] The SQL connection to use for this boxcar.
+    # @param tables [Array<String>] The tables to use for this boxcar. Will use all if nil.
+    # @param except_tables [Array<String>] The tables to exclude from this boxcar. Will exclude none if nil.
+    # @param kwargs [Hash] Any other keyword arguments to pass to the parent class. This can include
+    #   :name, :description, :prompt, :top_k, :stop, and :engine
+    def initialize(connection: nil, tables: nil, except_tables: nil, **kwargs)
+      connection ||= ::ActiveRecord::Base.connection
+      super(connection: connection, tables: tables, except_tables: except_tables, **kwargs)
+    end
+
+    private
+
+    def table_schema(table)
+      ["CREATE TABLE #{table} (",
+       connection&.columns(table)&.map { |c| " #{c.name} #{c.sql_type} #{c.null ? "NULL" : "NOT NULL"}" }&.join(",\n"),
+       ");"].join("\n")
+    end
+
+    def dialect
+      connection.class.name.split("::").last.sub("Adapter", "")
+    end
+
+    def get_output(code)
+      connection&.exec_query(code)
+    end
+  end
+end

data/lib/boxcars/boxcar/{sql.rb → sql_base.rb}

@@ -3,19 +3,21 @@
 # Boxcars is a framework for running a series of tools to get an answer to a question.
 module Boxcars
   # A Boxcar that interprets a prompt and executes SQL code to get answers
-  class SQL < EngineBoxcar
+  # Use one of the subclasses for ActiveRecord or Sequel
+  # @abstract
+  class SQLBase < EngineBoxcar
     # the description of this engine boxcar
     SQLDESC = "useful for when you need to query a database for %<name>s."
     LOCKED_OUT_TABLES = %w[schema_migrations ar_internal_metadata].freeze
-    attr_accessor :connection
+    attr_accessor :connection, :the_tables
 
-    # @param connection [ActiveRecord::Connection] The SQL connection to use for this boxcar.
+    # @param connection [ActiveRecord::Connection] or [Sequel Object] The SQL connection to use for this boxcar.
     # @param tables [Array<String>] The tables to use for this boxcar. Will use all if nil.
     # @param except_tables [Array<String>] The tables to exclude from this boxcar. Will exclude none if nil.
     # @param kwargs [Hash] Any other keyword arguments to pass to the parent class. This can include
     #   :name, :description, :prompt, :top_k, :stop, and :engine
     def initialize(connection: nil, tables: nil, except_tables: nil, **kwargs)
-      @connection = connection || ::ActiveRecord::Base.connection
+      @connection = connection
       check_tables(tables, except_tables)
       kwargs[:name] ||= "Database"
       kwargs[:description] ||= format(SQLDESC, name: name)
@@ -33,40 +35,47 @@ module Boxcars
     private
 
     def check_tables(rtables, exceptions)
+      requested_tables = nil
       if rtables.is_a?(Array) && tables.length.positive?
-        @requested_tables = rtables
+        requested_tables = rtables
         all_tables = tables
         rtables.each do |t|
-          raise ArgumentError, "table #{t} needs to be an Active Record model" unless all_tables.include?(t)
+          raise ArgumentError, "table #{t} not found in database" unless all_tables.include?(t)
         end
       elsif rtables
         raise ArgumentError, "tables needs to be an array of Strings"
       else
-        @requested_tables = tables
+        requested_tables = tables.to_a
       end
-      @except_models = LOCKED_OUT_TABLES + exceptions.to_a
+      except_tables = LOCKED_OUT_TABLES + exceptions.to_a
+      @the_tables = requested_tables - except_tables
     end
 
     def tables
       connection&.tables
     end
 
+    # abstract method to get the prompt for this boxcar
     def table_schema(table)
-      ["CREATE TABLE #{table} (",
-       connection&.columns(table)&.map { |c| " #{c.name} #{c.sql_type} #{c.null ? "NULL" : "NOT NULL"}" }&.join(",\n"),
-       ");"].join("\n")
+      raise NotImplementedError
     end
 
     def schema
-      wanted_tables = @requested_tables - @except_models
-      wanted_tables.map(&method(:table_schema)).join("\n")
+      the_tables.map(&method(:table_schema)).join("\n")
     end
 
+    # abstract method to get the prompt for this boxcar
     def dialect
-      connection.class.name.split("::").last.sub("Adapter", "")
+      raise NotImplementedError
     end
 
-    def clean_up_output(output)
+    # abstract method to get the output for the last query
+    def get_output(code)
+      raise NotImplementedError
+    end
+
+    def clean_up_output(code)
+      output = get_output(code)
       output = output.as_json if output.is_a?(::ActiveRecord::Result)
       output = 0 if output.is_a?(Array) && output.empty?
       output = output.first if output.is_a?(Array) && output.length == 1
@@ -79,7 +88,7 @@ module Boxcars
       code = text[/^SQLQuery: (.*)/, 1]
       code = extract_code text.split('SQLQuery:').last.strip
       Boxcars.debug code, :yellow
-      output = clean_up_output(connection.exec_query(code))
+      output = clean_up_output(code)
       Result.new(status: :ok, answer: output, explanation: "Answer: #{output.to_json}", code: code)
     rescue StandardError => e
       Result.new(status: :error, answer: nil, explanation: "Error: #{e.message}", code: code)

data/lib/boxcars/boxcar/sql_sequel.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Boxcars is a framework for running a series of tools to get an answer to a question.
+module Boxcars
+  # A Boxcar that interprets a prompt and executes Sequel SQL code to get answers
+  class SQLSequel < SQLBase
+    # @param connection [SEQUEL Database object] The Sequel connection to use for this boxcar.
+    # @param tables [Array<String>] The tables to use for this boxcar. Will use all if nil.
+    # @param except_tables [Array<String>] The tables to exclude from this boxcar. Will exclude none if nil.
+    # @param kwargs [Hash] Any other keyword arguments to pass to the parent class. This can include
+    #   :name, :description, :prompt, :top_k, :stop, and :engine
+    def initialize(connection: nil, tables: nil, except_tables: nil, **kwargs)
+      super(connection: connection, tables: tables, except_tables: except_tables, **kwargs)
+    end
+
+    private
+
+    def table_schema(table)
+      ["CREATE TABLE #{table} (",
+       connection&.schema(table)&.map { |c| " #{c[0]} #{c[1][:type]} #{c[1][:allow_null] ? "NULL" : "NOT NULL"}" }&.join(",\n"),
+       ");"].join("\n")
+    end
+
+    def dialect
+      connection.database_type
+    end
+
+    def get_output(code)
+      connection[code].all
+    end
+  end
+end

data/lib/boxcars/boxcar.rb

@@ -39,7 +39,7 @@ module Boxcars
     # @param outputs [Array<String>] The output keys.
     # @raise [RuntimeError] If the outputs are not the same.
     def validate_outputs(outputs:)
-      return if outputs.sort == output_keys.sort
+      return if (outputs - output_keys - ['log']).empty?
 
       raise "Did not get output keys that were expected, got: #{outputs}. Expected: #{output_keys}"
     end
@@ -153,7 +153,9 @@ require "boxcars/boxcar/engine_boxcar"
 require "boxcars/boxcar/calculator"
 require "boxcars/boxcar/google_search"
 require "boxcars/boxcar/wikipedia_search"
-require "boxcars/boxcar/sql"
+require "boxcars/boxcar/sql_base"
+require "boxcars/boxcar/sql_active_record"
+require "boxcars/boxcar/sql_sequel"
 require "boxcars/boxcar/swagger"
 require "boxcars/boxcar/active_record"
 require "boxcars/vector_store"

data/lib/boxcars/train/zero_shot.rb

@@ -63,7 +63,9 @@ module Boxcars
         end
 
         action = match[:action].strip
+        Boxcars.debug("Action: #{action}", :yellow)
         action_input = match[:action_input].strip.delete_prefix('"').delete_suffix('"')
+        Boxcars.debug("Action Input: #{action_input}", :yellow)
         [action, action_input]
       end
     end

data/lib/boxcars/train.rb

@@ -154,7 +154,7 @@ module Boxcars
     def return_stopped_response(early_stopping_method, intermediate_steps, **kwargs)
       case early_stopping_method
       when "force"
-        TrainFinish({ output: "Agent stopped due to max iterations." }, "")
+        TrainFinish.new({ output: "Agent stopped due to max iterations." }, "")
       when "generate"
         thoughts = ""
         intermediate_steps.each do |action, observation|
@@ -167,13 +167,13 @@ module Boxcars
         full_output = predict(**full_inputs)
         parsed_output = extract_boxcar_and_input(full_output)
         if parsed_output.nil?
-          TrainFinish({ output: full_output }, full_output)
+          TrainFinish.new({ output: full_output }, full_output)
         else
           boxcar, boxcar_input = parsed_output
           if boxcar == finish_boxcar_name
-            TrainFinish({ output: boxcar_input }, full_output)
+            TrainFinish.new({ output: boxcar_input }, full_output)
           else
-            TrainFinish({ output: full_output }, full_output)
+            TrainFinish.new({ output: full_output }, full_output)
           end
         end
       else
@@ -199,7 +199,7 @@ module Boxcars
           rescue Boxcars::ConfigurationError, Boxcars::SecurityError => e
             raise e
           rescue StandardError => e
-            Boxcars.error "Error in #{boxcar.name} boxcar#call: #{e}", :red
+            Boxcars.error "Error in #{boxcar.name} boxcar#call: #{e}\nbt:#{caller[0..5].join("\n   ")}", :red
             observation = "Error - #{e}, correct and try again."
           end
         elsif output.boxcar == :error

data/lib/boxcars/version.rb

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

data/lib/boxcars.rb

@@ -107,10 +107,24 @@ module Boxcars
     Boxcars.configuration.logger
   end
 
+  # Keep a running log of log messages
+  def self.log
+    @log ||= []
+    @log
+  end
+
+  # Resets the log and return the old log
+  def self.take_log
+    logs = @log
+    @log = []
+    logs
+  end
+
   # Logging system
   # debug log
   def self.debug(msg, color = nil, **options)
     msg = colorize(msg.to_s, color, **options) if color
+    log << msg
     if logger
       logger.debug(msg)
     else
@@ -121,6 +135,7 @@ module Boxcars
   # info log
   def self.info(msg, color = nil, **options)
     msg = colorize(msg.to_s, color, **options) if color
+    log << msg
     if logger
       logger.info(msg)
     else
@@ -131,6 +146,7 @@ module Boxcars
   # warn log
   def self.warn(msg, color = nil, **options)
     msg = colorize(msg.to_s, color, **options) if color
+    log << msg
     if logger
       logger.warn(msg)
     else
@@ -141,6 +157,7 @@ module Boxcars
   # error log
   def self.error(msg, color = nil, **options)
     msg = colorize(msg.to_s, color, **options) if color
+    log << msg
     if logger
       logger.error(msg)
     else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcars
 version: !ruby/object:Gem::Version
-  version: 0.2.15
+  version: 0.2.16
 platform: ruby
 authors:
 - Francis Sullivan
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_search_results
@@ -109,7 +109,9 @@ files:
 - lib/boxcars/boxcar/calculator.rb
 - lib/boxcars/boxcar/engine_boxcar.rb
 - lib/boxcars/boxcar/google_search.rb
-- lib/boxcars/boxcar/sql.rb
+- lib/boxcars/boxcar/sql_active_record.rb
+- lib/boxcars/boxcar/sql_base.rb
+- lib/boxcars/boxcar/sql_sequel.rb
 - lib/boxcars/boxcar/swagger.rb
 - lib/boxcars/boxcar/vector_answer.rb
 - lib/boxcars/boxcar/wikipedia_search.rb