boxcars 0.2.15 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94f8c86ef9a5d967f854447e0e2807d116ca95c2ebfe40fc624162144fbf77a3
-  data.tar.gz: 1230243ce0c1d6fb37855d093202daa65584df540f306bea57a1ed3daf331c45
+  metadata.gz: a2448419a2e348f8111fa19bd7b9bb1a05ab19b30d3dc9c0255ae0bd8673c156
+  data.tar.gz: fd6577be64b72941a87cbdb8c1c1ca31a7c88383869fa67f86d21cf721749168
 SHA512:
-  metadata.gz: 50d40ff9d3e5bd80f65dee223bd5f4de6c90d681b797f973f665a770bfc64f761acc4c2f22ef39f59731064c1350af56a47525d867acfc223a79635ded27906d
-  data.tar.gz: b574a4f7f27f2f24e2ca13577b51cdaf609a00a5372d3f8b112c724412c66f08242a7853abe1e8c7ae542ecc28854c07a01be803606c27cba87153a4a21086a7
+  metadata.gz: fd21eb8cd3ea3cc2fdf29140a3dce7dec26a7e4ffbd791d7aa7dd63aaa267c34d4ead764f85d3f7dbb9d1038330e3614bbfaf7f8c34818544b0d282568ad66f5
+  data.tar.gz: e12626132060202679533c3a101f4ec4fb1c9846f7d54beb9bc84ce7d71cb4f56be10f16a2c229480cc6c4378a074566f26a7ccbeeadc0c7ffc27ab81dfc6ee4

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## [Unreleased](https://github.com/BoxcarsAI/boxcars/tree/HEAD)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.2.16...HEAD)
+
+**Closed issues:**
+
+- Add a running log of prompts for debugging [\#99](https://github.com/BoxcarsAI/boxcars/issues/99)
+
+## [v0.2.16](https://github.com/BoxcarsAI/boxcars/tree/v0.2.16) (2023-06-26)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.2.15...v0.2.16)
+
+**Implemented enhancements:**
+
+- Support Sequel connection type [\#22](https://github.com/BoxcarsAI/boxcars/issues/22)
+
+**Closed issues:**
+
+- Using the SQL model This model's maximum context length is 4097 tokens [\#88](https://github.com/BoxcarsAI/boxcars/issues/88)
+
+**Merged pull requests:**
+
+- Add running logs [\#100](https://github.com/BoxcarsAI/boxcars/pull/100) ([francis](https://github.com/francis))
+- create new Sequel boxcar, and refactor Active Record SQL boxcar [\#98](https://github.com/BoxcarsAI/boxcars/pull/98) ([francis](https://github.com/francis))
+- Support for Sequel SQL connection types [\#97](https://github.com/BoxcarsAI/boxcars/pull/97) ([eltoob](https://github.com/eltoob))
+
+## [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.3.1)
       google_search_results (~> 2.2)
       gpt4all (~> 0.0.4)
       hnswlib (~> 0.8)
@@ -55,7 +55,7 @@ GEM
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.8.1)
-    faraday (2.7.4)
+    faraday (2.7.9)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-http-cache (2.5.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/active_record.rb

@@ -147,7 +147,7 @@ module Boxcars
     end
 
     def change_count(changes_code)
-      return 0 unless changes_code
+      return 0 unless changes_code && changes_code != "None"
 
       rollback_after_running do
         Boxcars.debug "computing change count with: #{changes_code}", :yellow
@@ -200,7 +200,8 @@ module Boxcars
     def error_message(err, stage)
       msg = err.message
       msg = ::Regexp.last_match(1) if msg =~ /^(.+)' for #<Boxcars::ActiveRecord/
-      "#{stage} Error: #{msg} - please fix \"#{stage}:\" to not have this error"
+      msg.gsub!(/Boxcars::ActiveRecord::/, '')
+      "For the value you gave for #{stage}, fix this error: #{msg}"
     end
 
     def get_active_record_answer(text)

data/lib/boxcars/boxcar/calculator.rb

@@ -43,7 +43,7 @@ module Boxcars
     CTEMPLATE = [
       syst("You can do basic math, but for any hard calculations that a human could not do ",
            "in their head, use the following approach instead. ",
-           "Return code written in the Ruby programming language that prints the results. ",
+           "Return code written in the Ruby programming language that prints the results to the console. ",
            "If anyone gives you a hard math problem, just ",
            "use the following format and we’ll take care of the rest:\n",
            "${{Question with hard calculation.}}\n",

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
@@ -63,7 +63,11 @@ module Boxcars
     # @return [String] The answer to the question.
     def run(*args, **kwargs)
       rv = conduct(*args, **kwargs)
-      rv.is_a?(Result) ? rv.to_answer : rv
+      rv = rv[:answer] if rv.is_a?(Hash) && rv.key?(:answer)
+      return rv.answer if rv.is_a?(Result)
+      return rv[output_keys[0]] if rv.is_a?(Hash)
+
+      rv
     end
 
     # Get an extended answer from the boxcar.
@@ -74,6 +78,7 @@ module Boxcars
     def conduct(*args, **kwargs)
       Boxcars.info "> Entering #{name}#run", :gray, style: :bold
       rv = depart(*args, **kwargs)
+      remember_history(rv)
       Boxcars.info "< Exiting #{name}#run", :gray, style: :bold
       rv
     end
@@ -94,8 +99,48 @@ module Boxcars
       [:user, strs.join]
     end
 
+    # history entries
+    def self.hist
+      [:history, ""]
+    end
+
+    # save this boxcar to a file
+    def save(path:)
+      File.write(path, YAML.dump(self))
+    end
+
+    # load this boxcar from a file
+    # rubocop:disable Security/YAMLLoad
+    def load(path:)
+      YAML.load(File.read(path))
+    end
+    # rubocop:enable Security/YAMLLoad
+
     private
 
+    # remember the history of this boxcar. Take the current intermediate steps and
+    # create a history that can be used on the next run.
+    # @param current_results [Array<Hash>] The current results.
+    def remember_history(current_results)
+      return unless current_results[:intermediate_steps] && is_a?(Train)
+
+      # insert conversation history into the prompt
+      history = []
+      history << Boxcar.user("Question: #{current_results[:input]}")
+      current_results[:intermediate_steps].each do |action, obs|
+        if action.is_a?(TrainAction)
+          obs = Observation.new(status: :ok, note: obs) if obs.is_a?(String)
+          next if obs.status != :ok
+
+          history << Boxcar.assi("Thought: #{action.log}\n", "Observation: #{obs.note}")
+        else
+          Boxcars.error "Unknown action: #{action}", :red
+        end
+      end
+      history << Boxcar.assi("Thought: I know the final answer\nFinal Answer: #{current_results[:output]}")
+      prompt.add_history(history)
+    end
+
     # Get an answer from the boxcar.
     def run_boxcar(inputs:, return_only_outputs: false)
       inputs = our_inputs(inputs)
@@ -117,13 +162,11 @@ module Boxcars
       if kwargs.empty?
         raise Boxcars::ArgumentError, "run supports only one positional argument." if args.length != 1
 
-        return run_boxcar(inputs: args[0])[output_keys.first]
-      end
-      if args.empty?
-        ans = run_boxcar(inputs: kwargs)
-        return ans[output_keys.first]
+        return run_boxcar(inputs: args[0])
       end
 
+      return run_boxcar(inputs: kwargs) if args.empty?
+
       raise Boxcars::ArgumentError, "run supported with either positional or keyword arguments but not both. Got args" \
                                     ": #{args} and kwargs: #{kwargs}."
     end
@@ -148,12 +191,15 @@ module Boxcars
   end
 end
 
+require "boxcars/observation"
 require "boxcars/result"
 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/conversation.rb

@@ -5,7 +5,7 @@ module Boxcars
   class Conversation
     attr_reader :lines, :show_roles
 
-    PEOPLE = %i[system user assistant].freeze
+    PEOPLE = %i[system user assistant history].freeze
 
     def initialize(lines: [], show_roles: false)
       @lines = lines
@@ -64,6 +64,20 @@ module Boxcars
       @lines += conversation.lines
     end
 
+    # insert converation above history line
+    # @param conversation [Conversation] The conversation to add
+    def add_history(conversation)
+      @lines = @lines.dup
+      # find the history line
+      hi = lines.rindex { |ln| ln[0] == :history }
+      # insert the conversation above the history line
+      @lines.insert(hi, *conversation.lines)
+    end
+
+    def no_history
+      @lines.reject { |ln| ln[0] == :history }
+    end
+
     # return just the messages for the conversation
     def message_text
       lines.map(&:last).join("\n")
@@ -73,7 +87,7 @@ module Boxcars
     # @param inputs [Hash] The inputs to use for the prompt.
     # @return [Hash] The formatted prompt { messages: ...}
     def as_messages(inputs = nil)
-      { messages: lines.map { |ln| { role: ln.first, content: ln.last % inputs } } }
+      { messages: no_history.map { |ln| { role: ln.first, content: ln.last % inputs } } }
     rescue ::KeyError => e
       first_line = e.message.to_s.split("\n").first
       Boxcars.error "Missing prompt input key: #{first_line}"
@@ -85,9 +99,9 @@ module Boxcars
     # @return [Hash] The formatted prompt { prompt: "..."}
     def as_prompt(inputs = nil)
       if show_roles
-        lines.map { |ln| format("#{ln.first}: #{ln.last}", inputs) }.join("\n\n")
+        no_history.map { |ln| format("#{ln.first}: #{ln.last}", inputs) }.compact.join("\n\n")
       else
-        lines.map { |ln| format(ln.last, inputs) }.join("\n\n")
+        no_history.map { |ln| format(ln.last, inputs) }.compact.join("\n\n")
       end
     rescue ::KeyError => e
       first_line = e.message.to_s.split("\n").first

data/lib/boxcars/conversation_prompt.rb

@@ -36,5 +36,16 @@ module Boxcars
       new_prompt.conversation.add_conversation(conversation)
       new_prompt
     end
+
+    # add conversation history to the prompt
+    # @param history [Hash] The history to add to the prompt.
+    def add_history(history)
+      conversation.add_history(Conversation.new(lines: history))
+    end
+
+    # print the prompt
+    def to_s
+      conversation.to_s
+    end
   end
 end

data/lib/boxcars/observation.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Boxcars
+  # used by Boxcars to return structured result and additional context
+  class Observation
+    attr_reader :note, :status, :added_context
+
+    # @param note [String] The note to use for the result
+    # @param status [Symbol] :ok or :error
+    # @param added_context [Hash] Any additional context to add to the result
+    def initialize(note:, status: :ok, **added_context)
+      @note = note
+      @status = status
+      @added_context = added_context
+    end
+
+    # @return [Hash] The result as a hash
+    def to_h
+      {
+        note: note,
+        status: status
+      }.merge(added_context).compact
+    end
+
+    # @return [String] The result as a json string
+    def to_json(*args)
+      JSON.generate(to_h, *args)
+    end
+
+    # @return [String] An explanation of the result
+    def to_s
+      note
+    end
+
+    # create a new Observaton from a text string with a status of :ok
+    # @param note [String] The text to use for the observation
+    # @param added_context [Hash] Any additional context to add to the result
+    # @return [Boxcars::Observation] The observation
+    def self.ok(note, **kwargs)
+      new(note: note, status: :ok, **kwargs)
+    end
+
+    # create a new Observaton from a text string with a status of :error
+    # @param note [String] The text to use for the observation
+    # @param added_context [Hash] Any additional context to add to the result
+    # @return [Boxcars::Observation] The observation
+    def self.err(note, **kwargs)
+      new(note: note, status: :error, **kwargs)
+    end
+  end
+end

data/lib/boxcars/ruby_repl.rb

@@ -8,7 +8,7 @@ module Boxcars
     def call(code:)
       Boxcars.debug "RubyREPL: #{code}", :yellow
 
-      # wrap the code in an excption block so we can catch errors
+      # wrap the code in an exception block so we can catch errors
       wrapped = "begin\n#{code}\nrescue Exception => e\n  puts 'Error: ' + e.message\nend"
       output = ""
       IO.popen("ruby", "r+") do |io|
@@ -19,6 +19,8 @@ module Boxcars
       if output =~ /^Error: /
         Boxcars.debug output, :red
         Result.from_error(output, code: code)
+      elsif output.blank?
+        Result.from_error("The code you gave me did not print a result", code: code)
       else
         output = ::Regexp.last_match(1) if output =~ /^\s*Answer:\s*(.*)$/m
         Boxcars.debug "Answer: #{output}", :yellow, style: :bold

data/lib/boxcars/train/zero_shot.rb

@@ -18,7 +18,7 @@ module Boxcars
       @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)
+      super(engine: engine, boxcars: boxcars, prompt: prompt, name: name, description: description, **kwargs)
     end
 
     # @return Hash The additional variables for this boxcar.
@@ -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
@@ -83,7 +85,11 @@ module Boxcars
            "%<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",
+           "Finally, if you can deduct the answer from the question or observation, you can ",
+           "start with \"Final Answer:\" and give me the answer.\n",
            "Begin!"),
+      # insert thoughts here from previous runs
+      hist,
       user("Question: %<input>s"),
       assi("Thought: %<agent_scratchpad>s")
     ].freeze

data/lib/boxcars/train.rb

@@ -16,7 +16,8 @@ module Boxcars
       @boxcars = boxcars
       @name_to_boxcar_map = boxcars.to_h { |boxcar| [boxcar.name, boxcar] }
       @return_values = [:output]
-      @return_intermediate_steps = kwargs.delete(:return_intermediate_steps) || false
+      @return_intermediate_steps = kwargs.fetch(:return_intermediate_steps, true)
+      kwargs.delete(:return_intermediate_steps)
       @max_iterations = kwargs.delete(:max_iterations) || 25
       @early_stopping_method = kwargs.delete(:early_stopping_method) || "force"
       kwargs[:stop] ||= ["\n#{observation_prefix}"]
@@ -33,14 +34,16 @@ module Boxcars
     # build the scratchpad for the engine
     # @param intermediate_steps [Array] The intermediate steps to build the scratchpad from.
     # @return [String] The scratchpad.
+    # rubocop:disable Lint/RedundantStringCoercion
     def construct_scratchpad(intermediate_steps)
       thoughts = ""
       intermediate_steps.each do |action, observation|
         thoughts += action.is_a?(String) ? action : " #{action.log}"
-        thoughts += "\n#{observation_prefix}#{observation}\n#{engine_prefix}"
+        thoughts += "\n#{observation_prefix}#{observation.to_s}\n#{engine_prefix}"
       end
       thoughts
     end
+    # rubocop:enable Lint/RedundantStringCoercion
 
     # determine the next action
     # @param full_inputs [Hash] The inputs to the engine.
@@ -51,7 +54,7 @@ module Boxcars
       loop do
         full_inputs[:agent_scratchpad] += full_output
         output = predict(**full_inputs)
-        full_output += output
+        full_output += output.to_s
         parsed_output = extract_boxcar_and_input(full_output)
         break unless parsed_output.nil?
       end
@@ -95,7 +98,7 @@ module Boxcars
 
     # the output keys
     def output_keys
-      return return_values + ["intermediate_steps"] if return_intermediate_steps
+      return return_values + [:intermediate_steps] if return_intermediate_steps
 
       return_values
     end
@@ -116,7 +119,7 @@ module Boxcars
     def pre_return(output, intermediate_steps)
       Boxcars.debug output.log, :yellow, style: :bold
       final_output = output.return_values
-      final_output["intermediate_steps"] = intermediate_steps if return_intermediate_steps
+      final_output[:intermediate_steps] = intermediate_steps if return_intermediate_steps
       final_output
     end
 
@@ -154,7 +157,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 +170,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
@@ -194,22 +197,24 @@ module Boxcars
 
         if (boxcar = name_to_boxcar_map[output.boxcar])
           begin
-            observation = boxcar.run(output.boxcar_input)
+            observation = Observation.ok(boxcar.run(output.boxcar_input))
             return_direct = boxcar.return_direct
           rescue Boxcars::ConfigurationError, Boxcars::SecurityError => e
             raise e
           rescue StandardError => e
-            Boxcars.error "Error in #{boxcar.name} boxcar#call: #{e}", :red
-            observation = "Error - #{e}, correct and try again."
+            Boxcars.error "Error in #{boxcar.name} boxcar#call: #{e}\nbt:#{caller[0..5].join("\n   ")}", :red
+            observation = Observation.err("Error - #{e}, correct and try again.")
           end
         elsif output.boxcar == :error
           observation = output.log
           return_direct = false
         else
-          observation = "#{output.boxcar} is not a valid boxcar, try another one."
+          observation = Observation.err("Error - #{output.boxcar} is not a valid action, try again.")
           return_direct = false
         end
-        Boxcars.debug "Observation: #{observation}", :green
+        # rubocop:disable Lint/RedundantStringCoercion
+        Boxcars.debug "Observation: #{observation.to_s}", :green
+        # rubocop:enable Lint/RedundantStringCoercion
         intermediate_steps.append([output, observation])
         if return_direct
           output = TrainFinish.new({ return_values[0] => observation }, "")

data/lib/boxcars/version.rb

@@ -2,5 +2,5 @@
 
 module Boxcars
   # The current version of the gem.
-  VERSION = "0.2.15"
+  VERSION = "0.3.1"
 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.3.1
 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-07-01 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
@@ -120,6 +122,7 @@ files:
 - lib/boxcars/engine/gpt4all_eng.rb
 - lib/boxcars/engine/openai.rb
 - lib/boxcars/generation.rb
+- lib/boxcars/observation.rb
 - lib/boxcars/prompt.rb
 - lib/boxcars/result.rb
 - lib/boxcars/ruby_repl.rb