boxcars 0.2.14 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1039f86c58712c10143cc26438da14571013081bcff08aed3d9fcac4b1e84060
-  data.tar.gz: fca9f08855cae8e4e8a4171c043e92884e245582b049b4cc75bfa4d2cd98e51a
+  metadata.gz: 92af5ad71c16886afc760bcc1b98a1d050486f8cf7010e0f05ee5015aa767710
+  data.tar.gz: a0e5f39d40f79d4e4e5e337c00657764b5f9b329ec6bcc0f5a6e4ea62b0675b5
 SHA512:
-  metadata.gz: 5f24a578f4004d99a0d71c05f4a0ed520dda2e562d1327ec68bdf8682a927b741e870ed348a1a273319003f515521ef8a12c8778b70994764a945e31f906f807
-  data.tar.gz: be067a2ba1ba2e032a58d32f46071f5510a5ce0f15fbc89a06fe84f4fd854ec825a0ea0c786a90ba87c20bb1893ff59512170ac2e338080e25f85b2474b6fb64
+  metadata.gz: 06123e9f6ea4cb294b258056b6e50af7654b2c4866b1585fb32e520eee4e64dcdecc7cf8dc4d019a42a3193b01be6a02fba8190ef52add4eb70ad7f1a79d492c
+  data.tar.gz: 3320ee8fdb68a4bf9601a6a584d64517242e0e80b14b812b6f04f3e0eaed05b5d520541e5547c72b7b3a8ebea044e7173163cafccc2cc8f9bb5c25b25a231ffe

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # 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)
+
+**Closed issues:**
+
+- VectorAnswer always return error "Query must a string" [\#90](https://github.com/BoxcarsAI/boxcars/issues/90)
+- Readme vector search example 404 [\#86](https://github.com/BoxcarsAI/boxcars/issues/86)
+- Add Boxcar similar to LLMChain [\#85](https://github.com/BoxcarsAI/boxcars/issues/85)
+
+**Merged pull requests:**
+
+- Chore/refactored vector stores [\#92](https://github.com/BoxcarsAI/boxcars/pull/92) ([jaigouk](https://github.com/jaigouk))
+- Fix the issue of calling the wrong method in vector\_answer.rb. [\#91](https://github.com/BoxcarsAI/boxcars/pull/91) ([xleotranx](https://github.com/xleotranx))
+- issue\_83 Fix readme 404 [\#87](https://github.com/BoxcarsAI/boxcars/pull/87) ([beouk](https://github.com/beouk))
+
 ## [v0.2.13](https://github.com/BoxcarsAI/boxcars/tree/v0.2.13) (2023-05-24)
 
 [Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.2.12...v0.2.13)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boxcars (0.2.14)
+    boxcars (0.2.16)
       google_search_results (~> 2.2)
       gpt4all (~> 0.0.4)
       hnswlib (~> 0.8)
@@ -88,9 +88,11 @@ GEM
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     io-console (0.6.0)
+    io-console (0.6.0-java)
     irb (1.6.4)
       reline (>= 0.3.0)
     json (2.6.3)
+    json (2.6.3-java)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2023.0218.1)
@@ -100,6 +102,7 @@ GEM
     multipart-post (2.3.0)
     netrc (0.11.0)
     nio4r (2.5.9)
+    nio4r (2.5.9-java)
     octokit (4.25.1)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
@@ -173,6 +176,9 @@ GEM
       faraday (>= 0.17.3, < 3)
     sqlite3 (1.6.3)
       mini_portile2 (~> 2.8.0)
+    sqlite3 (1.6.3-arm64-darwin)
+    sqlite3 (1.6.3-x86_64-darwin)
+    sqlite3 (1.6.3-x86_64-linux)
     strings-ansi (0.2.0)
     timers (4.3.5)
     traces (0.9.1)
@@ -187,6 +193,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
+    unf (0.1.4-java)
     unf_ext (0.0.8.2)
     unicode-display_width (2.4.2)
     vcr (6.1.0)

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/engine_boxcar.rb

@@ -56,7 +56,7 @@ module Boxcars
     def apply(input_list:, current_conversation: nil)
       response = generate(input_list: input_list, current_conversation: current_conversation)
       response.generations.to_h do |generation|
-        [output_keys.first, generation[0].text]
+        [output_key, generation[0].text]
       end
     end
 
@@ -65,7 +65,7 @@ module Boxcars
     # @param kwargs [Hash] A hash of input values to use for the prompt.
     # @return [String] The output value.
     def predict(current_conversation: nil, **kwargs)
-      prediction = apply(current_conversation: current_conversation, input_list: [kwargs])[output_keys.first]
+      prediction = apply(current_conversation: current_conversation, input_list: [kwargs])[output_key]
       Boxcars.debug(prediction, :white) if Boxcars.configuration.log_generated
       prediction
     end
@@ -95,7 +95,7 @@ module Boxcars
           conversation.add_user(answer.answer)
         else
           Boxcars.debug answer.to_json, :magenta
-          return { output_keys.first => answer }
+          return { output_key => answer }
         end
       end
       Boxcars.error answer.to_json, :red

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

@@ -5,22 +5,25 @@ module Boxcars
   # A Train using the zero-shot react method.
   class ZeroShot < Train
     attr_reader :boxcars, :observation_prefix, :engine_prefix
+    attr_accessor :wants_next_actions
 
     # @param boxcars [Array<Boxcars::Boxcar>] The boxcars to run.
     # @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'.
     # @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)
+    # @param kwargs [Hash] Additional arguments to pass to the train. wants_next_actions: true
+    def initialize(boxcars:, engine: nil, name: 'Zero Shot', description: 'Zero Shot Train', prompt: nil, **kwargs)
       @observation_prefix = 'Observation: '
       @engine_prefix = 'Thought:'
+      @wants_next_actions = kwargs.fetch(:wants_next_actions, false)
       prompt ||= my_prompt
       super(engine: engine, boxcars: boxcars, prompt: prompt, name: name, description: description)
     end
 
     # @return Hash The additional variables for this boxcar.
     def prediction_additional(_inputs)
-      { boxcar_names: boxcar_names, boxcar_descriptions: boxcar_descriptions }.merge super
+      { boxcar_names: boxcar_names, boxcar_descriptions: boxcar_descriptions, next_actions: next_actions }.merge super
     end
 
     # Extract the boxcar and input from the engine output.
@@ -60,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
@@ -72,13 +77,14 @@ module Boxcars
            "Question: the input question you must answer\n",
            "Thought: you should always think about what to do\n",
            "Action: the action to take, should be one from this list: %<boxcar_names>s\n",
-           "Action Input: the input to the action\n",
+           "Action Input: an input question to the action\n",
            "Observation: the result of the action\n",
            "... (this Thought/Action/Action Input/Observation sequence can repeat N times)\n",
            "Thought: I know the final answer\n",
            "Final Answer: the final answer to the original input question\n",
-           "Next Actions: Up to 3 logical suggested next questions for the user to ask after getting this answer.\n",
+           "%<next_actions>s\n",
            "Remember to start a line with \"Final Answer:\" to give me the final answer.\n",
+           "Also make sure to specify a question for the Action Input.\n",
            "Begin!"),
       user("Question: %<input>s"),
       assi("Thought: %<agent_scratchpad>s")
@@ -92,13 +98,21 @@ module Boxcars
       @boxcar_descriptions ||= boxcars.map { |boxcar| "#{boxcar.name}: #{boxcar.description}" }.join("\n")
     end
 
+    def next_actions
+      if wants_next_actions
+        "Next Actions: Up to 3 logical suggested next questions for the user to ask after getting this answer.\n"
+      else
+        ""
+      end
+    end
+
     # The prompt to use for the train.
     def my_prompt
       @conversation ||= Conversation.new(lines: CTEMPLATE)
       @my_prompt ||= ConversationPrompt.new(
         conversation: @conversation,
         input_variables: [:input],
-        other_inputs: [:boxcar_names, :boxcar_descriptions, :agent_scratchpad],
+        other_inputs: [:boxcar_names, :boxcar_descriptions, :next_actions, :agent_scratchpad],
         output_variables: [:answer])
     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.14"
+  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.14
+  version: 0.2.16
 platform: ruby
 authors:
 - Francis Sullivan
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_search_results
@@ -92,6 +92,7 @@ files:
 - ".env_sample"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -108,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
@@ -167,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Boxcars is a gem that enables you to create new systems with AI composability.