boxcars 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 666f9b91451e8b6db61eb1162cb6508a566a46b676d646f1fb0000175714cede
-  data.tar.gz: bee7b55be2288bf9361012bd562f88d91f64ce7972b0cf5c495a5fce87eea77c
+  metadata.gz: f8cfde09f23575d2b54249bd2b6d2c15697092b7c52db4d5f0546bb0113a3949
+  data.tar.gz: d557f681bf8a26251608b17038650868563da9d54753789c568331328cfa456b
 SHA512:
-  metadata.gz: '0681f5bd00bbfe2afd67011d76c561640a0575a9656b20913d3c60193208ea33361003ee652d01802b49702b106bd4f3d5bc91c1c7f2023bc2e8224edca14a8d'
-  data.tar.gz: 794fe20c2f9b8f14402db177bdee3d3e5318ab652e69c02929f9ae79d6daca096ae386a4e85730da4004927ab31aff53cc3a8d960ca661d6a5dd192432ffeabb
+  metadata.gz: db5af829a8a6e600cbb402e53aa7aaf1f9374725c5cf1d61ee908cb58ffda305b03ee00a4664e9f1134dc6887be9dab8c7877ad4c6b981e5a5665bfc1cfec2f3
+  data.tar.gz: 17930e46fa46b4d1a268367aff6d9b5851fac890f00d5a87e722ed3833552bb851614a5ab606cb9a08afce611a5882c9838094e31c1d34b9d17c05923656fc38

data/Gemfile.lock

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

data/README.md

@@ -17,10 +17,11 @@ This gem was inspired by the popular Python library Langchain. However, we wante
 
 ## Concepts
 All of these concepts are in a module named Boxcars:
-- Prompt: used by an Engine to generate text results.
-- Engine: an entity that generates text from a Prompt. OpenAI's LLM text generatory is the default Engine if no other is specified.
-- Boxcar: an encapsulation of a concept that performs something of interest (such as search, math, or SQL). A can use an Engine to do its work.
-- Train: Given a list of Boxcars and an optionally an Engine, a Train breaks down a problem into pieces for individual Boxcars to solve. The individual results are then combined until a final answer is found. ZeroShot is the only current implementation of Train, and you can either construct it directly or use `Boxcars::train` when you want to build a Train.
+
+- Boxcar - an encapsulation that performs something of interest (such as search, math, SQL or an Active Record Query). A Boxcar can use an Engine (described below) to do its work.
+- Train - Given a list of Boxcars and optionally an Engine, a Train breaks down a problem into pieces for individual Boxcars to solve. The individual results are then combined until a final answer is found. ZeroShot is the only current implementation of Train (but we are adding more soon), and you can either construct it directly or use `Boxcars::train` when you want to build a Train.
+- Prompt - used by an Engine to generate text results. Most of the Boxcars have built-in prompts, so you only need to worry about these if you are extending the system.
+- Engine - an entity that generates text from a Prompt. OpenAI's LLM text generator is the default Engine if no other is specified.
 
 ## Installation
 
@@ -86,6 +87,7 @@ Here is what we have so far, but please put up a PR with your new ideas.
 - 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.
+- ActiveRecord: given an ActiveRecord connection, it will generate and run ActiveRecord statements from a prompt.
 
 ### Run a list of Boxcars
 ```ruby
@@ -114,7 +116,18 @@ Final Answer: 201.06
 < Exiting Zero Shot#run
 201.06
 ```
+### More Examples
+See [this](https://github.com/BoxcarsAI/boxcars/blob/main/notebooks/boxcars_examples.ipynb) Jupyter Notebook for more examples.
+
+Note, some folks that we talked to didn't know that you could run Ruby Jupyter notebooks. [You can](https://github.com/SciRuby/iruby).
+
+### Logging
+If you use this in a Rails application, or configure `Boxcars.configuration.logger = your_logger`, logging will go to your log file.
+
+Also, if you set this flag: `Boxcars.configuration.lop_prompts = true`
+The actual prompts handed to the connected Engine will be logged. This is off by default because it is very wordy, but handy if you are debugging prompts.
 
+Otherwise, we print to standard out.
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -123,7 +136,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/boxcars. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/boxcars/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/BoxcarsAI/boxcars. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/BoxcarsAI/boxcars/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -131,4 +144,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Boxcars project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/boxcars/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Boxcars project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/BoxcarsAI/boxcars/blob/main/CODE_OF_CONDUCT.md).

data/lib/boxcars/boxcar/active_record.rb

@@ -50,7 +50,7 @@ module Boxcars
     def call(inputs:)
       t = predict(question: inputs[input_key], top_k: 5, model_info: model_info, stop: ["Answer:"]).strip
       answer = get_answer(t)
-      puts answer.colorize(:magenta)
+      Boxcars.info answer, :magenta
       { output_key => answer }
     end
 
@@ -108,7 +108,7 @@ module Boxcars
 
       bad_words.each do |w|
         if word_list.include?(w)
-          puts "code included destructive instruction: #{w} #{code}".colorize(:red)
+          Boxcars.info "code included destructive instruction: #{w} #{code}", :red
           return false
         end
       end
@@ -128,7 +128,7 @@ module Boxcars
       return 0 unless changes_code
 
       rollback_after_running do
-        puts "computing change count with: #{changes_code}".colorize(:yellow)
+        Boxcars.debug "computing change count with: #{changes_code}", :yellow
         evaluate_input changes_code
       end
     end
@@ -138,7 +138,7 @@ module Boxcars
       changes = change_count(changes_code)
       return true unless changes&.positive?
 
-      puts "Pending Changes: #{changes}".colorize(:yellow, style: :bold)
+      Boxcars.debug "Pending Changes: #{changes}", :yellow, style: :bold
       change_str = "#{changes} change#{'s' if changes.to_i > 1}"
       raise SecurityError, "Can not run code that makes #{change_str} in read-only mode" if read_only?
 
@@ -148,7 +148,7 @@ module Boxcars
     end
 
     def run_active_record_code(code)
-      puts code.colorize(:yellow)
+      Boxcars.debug code, :yellow
       if read_only?
         rollback_after_running do
           evaluate_input code

data/lib/boxcars/boxcar/calculator.rb

@@ -40,7 +40,7 @@ module Boxcars
     def call(inputs:)
       t = predict(question: inputs[input_key], stop: ["```output"]).strip
       answer = get_answer(t)
-      puts answer.colorize(:magenta)
+      Boxcars.info answer, :magenta
       { output_key => answer }
     end
 

data/lib/boxcars/boxcar/engine_boxcar.rb

@@ -36,7 +36,7 @@ module Boxcars
       prompts = []
       input_list.each do |inputs|
         new_prompt = prompt.format(**inputs)
-        puts "Prompt after formatting:\n#{new_prompt.colorize(:cyan)}" if Boxcars.configuration.log_prompts
+        Boxcars.debug("Prompt after formatting:\n#{new_prompt}", :cyan) if Boxcars.configuration.log_prompts
         prompts.push(new_prompt)
       end
       engine.generate(prompts: prompts, stop: stop)

data/lib/boxcars/boxcar/sql.rb

@@ -44,7 +44,7 @@ module Boxcars
     def call(inputs:)
       t = predict(question: inputs[input_key], dialect: dialect, top_k: 5, table_info: schema, stop: ["Answer:"]).strip
       answer = get_answer(t)
-      puts answer.colorize(:magenta)
+      Boxcars.debug answer, :magenta
       { output_key => answer }
     end
 
@@ -72,7 +72,7 @@ module Boxcars
 
     def get_embedded_sql_answer(text)
       code = text[/^SQLQuery: (.*)/, 1]
-      puts code.colorize(:yellow)
+      Boxcars.debug code, :yellow
       output = connection.exec_query(code).to_a
       "Answer: #{output}"
     end

data/lib/boxcars/boxcar.rb

@@ -62,9 +62,9 @@ module Boxcars
     # you can pass one or the other, but not both.
     # @return [String] The answer to the question.
     def run(*args, **kwargs)
-      puts "> Entering #{name}#run".colorize(:gray, style: :bold)
+      Boxcars.info "> Entering #{name}#run", :gray, style: :bold
       rv = do_run(*args, **kwargs)
-      puts "< Exiting #{name}#run".colorize(:gray, style: :bold)
+      Boxcars.info "< Exiting #{name}#run", :gray, style: :bold
       rv
     end
 
@@ -77,7 +77,7 @@ module Boxcars
       begin
         output = call(inputs: inputs)
       rescue StandardError => e
-        puts "Error in #{name} boxcar#call: #{e}".colorize(:red)
+        error "Error in #{name} boxcar#call: #{e}", :red
         raise e
       end
       validate_outputs(outputs: output.keys)
@@ -101,7 +101,7 @@ module Boxcars
 
     def our_inputs(inputs)
       if inputs.is_a?(String)
-        puts inputs.colorize(:blue) # the question
+        Boxcars.info inputs, :blue # the question
         if input_keys.length != 1
           raise Boxcars::ArgumentError, "A single string input was passed in, but this boxcar expects " \
                                         "multiple inputs (#{input_keys}). When a boxcar expects " \

data/lib/boxcars/ruby_repl.rb

@@ -6,14 +6,14 @@ module Boxcars
     # Execute ruby code
     # @param code [String] The code to run
     def call(code:)
-      puts "RubyREPL: #{code}".colorize(:yellow)
+      Boxcars.debug "RubyREPL: #{code}", :yellow
       output = ""
       IO.popen("ruby", "r+") do |io|
         io.puts code
         io.close_write
         output = io.read
       end
-      puts "Answer: #{output}".colorize(:yellow, style: :bold)
+      Boxcars.debug "Answer: #{output}", :yellow, style: :bold
       output
     end
 

data/lib/boxcars/train.rb

@@ -112,7 +112,7 @@ module Boxcars
     # @param intermediate_steps [Array<Hash>] The intermediate steps.
     # @return [Hash] The final output.
     def pre_return(output, intermediate_steps)
-      puts output.log.colorize(:yellow, style: :bold)
+      Boxcars.debug output.log, :yellow, style: :bold
       final_output = output.return_values
       final_output["intermediate_steps"] = intermediate_steps if return_intermediate_steps
       final_output
@@ -198,14 +198,14 @@ module Boxcars
             observation = boxcar.run(output.boxcar_input)
             return_direct = boxcar.return_direct
           rescue StandardError => e
-            puts "Error in #{boxcar.name} boxcar#call: #{e}".colorize(:red)
+            error "Error in #{boxcar.name} boxcar#call: #{e}", :red
             raise e
           end
         else
           observation = "#{output.boxcar} is not a valid boxcar, try another one."
           return_direct = false
         end
-        puts "Observation: #{observation}".colorize(:green)
+        Boxcars.debug "Observation: #{observation}", :green
         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.1.6"
+  VERSION = "0.1.7"
 end

data/lib/boxcars.rb

@@ -19,23 +19,6 @@ module Boxcars
   # Error class for all Boxcars security errors.
   class SecurityError < Error; end
 
-  # simple string colorization
-  class ::String
-    # colorize a string
-    # @param color [Symbol] The color to use.
-    # @param options [Hash] The options to use.
-    def colorize(color, options = {})
-      background = options[:background] || options[:bg] || false
-      style = options[:style]
-      offsets = %i[gray red green yellow blue magenta cyan white]
-      styles = %i[normal bold dark italic underline xx xx underline xx strikethrough]
-      start = background ? 40 : 30
-      color_code = start + (offsets.index(color) || 8)
-      style_code = styles.index(style) || 0
-      "\e[#{style_code};#{color_code}m#{self}\e[0m"
-    end
-  end
-
   # Configuration contains gem settings
   class Configuration
     attr_writer :openai_access_token, :serpapi_api_key
@@ -44,7 +27,6 @@ module Boxcars
     def initialize
       @organization_id = nil
       @logger = Rails.logger if defined?(Rails)
-      @logger ||= Logger.new($stdout)
       @log_prompts = false
     end
 
@@ -115,6 +97,59 @@ module Boxcars
       answer.downcase == 'y'
     end
   end
+
+  # Return a logger, possibly if set.
+  def self.logger
+    Boxcars.configuration.logger
+  end
+
+  # Logging system
+  def self.debug(msg, color = nil, **options)
+    msg = colorize(msg.to_s, color, **options) if color
+    if logger
+      logger.debug(msg)
+    else
+      puts msg
+    end
+  end
+
+  def self.info(msg, color = nil, **options)
+    msg = colorize(msg.to_s, color, **options) if color
+    if logger
+      logger.info(msg)
+    else
+      puts msg
+    end
+  end
+
+  def self.warn(msg, color = nil, **options)
+    msg = colorize(msg.to_s, color, **options) if color
+    if logger
+      logger.warn(msg)
+    else
+      puts msg
+    end
+  end
+
+  def self.error(msg, color = nil, **options)
+    msg = colorize(msg.to_s, color, **options) if color
+    if logger
+      logger.error(msg)
+    else
+      puts msg
+    end
+  end
+
+  def self.colorize(str, color, **options)
+    background = options[:background] || options[:bg] || false
+    style = options[:style]
+    offsets = %i[gray red green yellow blue magenta cyan white]
+    styles = %i[normal bold dark italic underline xx xx underline xx strikethrough]
+    start = background ? 40 : 30
+    color_code = start + (offsets.index(color) || 8)
+    style_code = styles.index(style) || 0
+    "\e[#{style_code};#{color_code}m#{str}\e[0m"
+  end
 end
 
 require "boxcars/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcars
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Francis Sullivan
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-24 00:00:00.000000000 Z
+date: 2023-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug