boxcars 0.2.0 → 0.2.2

data/lib/boxcars/train/zero_shot.rb

@@ -1,35 +1,11 @@
+# frozen_string_literal: true
+
 # Agent for the MRKL chain
 module Boxcars
   # A Train using the zero-shot react method.
   class ZeroShot < Train
     attr_reader :boxcars, :observation_prefix, :engine_prefix
 
-    # default prompt prefix
-    PREFIX = "Answer the following questions as best you can. You have access to the following actions:".freeze
-
-    # default prompt instructions
-    FORMAT_INSTRUCTIONS = <<~FINPUT.freeze
-      Use the following format:
-
-      Question: the input question you must answer
-      Thought: you should always think about what to do
-      Action: the action to take, should be one of [%<boxcar_names>s]
-      Action Input: the input to the action
-      Observation: the result of the action
-      ... (this Thought/Action/Action Input/Observation sequence can repeat N times)
-      Thought: I now know the final answer
-      Final Answer: the final answer to the original input question
-      Next Actions: If you have them, up to three suggested actions for the user to take after getting this answer.
-    FINPUT
-
-    # default prompt suffix
-    SUFFIX = <<~SINPUT.freeze
-      Begin!
-
-      Question: %<input>s
-      Thought:%<agent_scratchpad>s
-    SINPUT
-
     # @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'.
@@ -38,26 +14,26 @@ module Boxcars
     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 ||= my_prompt
       super(engine: engine, boxcars: boxcars, prompt: prompt, name: name, description: description)
     end
 
-    # 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.
-    # @param input_variables [Array<Symbol>] List of input variables the final prompt will expect.
-    # @return [Boxcars::Prompt] A Prompt with the template assembled from the pieces here.
-    def self.create_prompt(boxcars:, prefix: PREFIX, suffix: SUFFIX, input_variables: [:input, :agent_scratchpad])
-      boxcar_strings = boxcars.map { |boxcar| "#{boxcar.name}: #{boxcar.description}" }.join("\n")
-      boxcar_names = boxcars.map(&:name)
-      format_instructions = format(FORMAT_INSTRUCTIONS, boxcar_names: boxcar_names.join(", "))
-      template = [prefix, boxcar_strings, format_instructions, suffix].join("\n\n")
-      Prompt.new(template: template, input_variables: input_variables)
+    # @return Hash The additional variables for this boxcar.
+    def prediction_additional
+      { boxcar_names: boxcar_names, boxcar_descriptions: boxcar_descriptions }.merge super
+    end
+
+    # Extract the boxcar and input from the engine output.
+    # @param text [String] The output from the engine.
+    # @return [Array<Boxcars::Boxcar, String>] The boxcar and input.
+    def extract_boxcar_and_input(text)
+      get_action_and_input(engine_output: text)
     end
 
+    private
+
     # the final answer action string
-    FINAL_ANSWER_ACTION = "Final Answer:".freeze
+    FINAL_ANSWER_ACTION = "Final Answer:"
 
     # Parse out the action and input from the engine output.
     # @param engine_output [String] The output from the engine.
@@ -69,13 +45,14 @@ module Boxcars
       #   with "Action Input:" should be separated by a newline.
       if engine_output.include?(FINAL_ANSWER_ACTION)
         answer = engine_output.split(FINAL_ANSWER_ACTION).last.strip
-        ['Final Answer', answer]
+        Result.new(status: :ok, answer: answer, explanation: engine_output)
       else
         # the thought should be the frist line here if it doesn't start with "Action:"
         thought = engine_output.split(/\n+/).reject(&:empty?).first
         Boxcars.debug("Though: #{thought}", :cyan)
         regex = /Action: (?<action>.*)\nAction Input: (?<action_input>.*)/
         match = regex.match(engine_output)
+        # TODO: this should return an error to the results that can be used for corrections
         raise ValueError, "Could not parse engine output: #{engine_output}" unless match
 
         action = match[:action].strip
@@ -84,11 +61,40 @@ module Boxcars
       end
     end
 
-    # Extract the boxcar and input from the engine output.
-    # @param text [String] The output from the engine.
-    # @return [Array<Boxcars::Boxcar, String>] The boxcar and input.
-    def extract_boxcar_and_input(text)
-      get_action_and_input(engine_output: text)
+    CTEMPLATE = [
+      syst("Answer the following questions as best you can. You have access to the following actions:\n",
+           "%<boxcar_descriptions>s"),
+      syst("Use the following format:\n",
+           "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 of [%<boxcar_names>s]\n",
+           "Action Input: the input 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 now know the final answer\n",
+           "Final Answer: the final answer to the original input question\n",
+           "Next Actions: If you have them, up to 3 suggested actions for the user to take after getting this answer.\n",
+           "Begin!"),
+      user("Question: %<input>s"),
+      assi("Thought: %<agent_scratchpad>s")
+    ].freeze
+
+    def boxcar_names
+      @boxcar_names ||= boxcars.map(&:name)
+    end
+
+    def boxcar_descriptions
+      @boxcar_descriptions ||= boxcars.map { |boxcar| "#{boxcar.name}: #{boxcar.description}" }.join("\n")
+    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],
+        output_variables: [:answer])
     end
   end
 end

data/lib/boxcars/train.rb

@@ -3,23 +3,25 @@
 module Boxcars
   # @abstract
   class Train < EngineBoxcar
-    attr_reader :engine, :boxcars, :name, :description, :prompt, :return_values, :return_intermediate_steps,
-                :max_iterations, :early_stopping_method
+    attr_reader :boxcars, :return_values, :return_intermediate_steps,
+                :max_iterations, :early_stopping_method, :name_to_boxcar_map
 
     # A Train will use a engine to run a series of boxcars.
-    # @param engine [Boxcars::Engine] The engine to use for this train.
     # @param boxcars [Array<Boxcars::Boxcar>] The boxcars to run.
-    # @param prompt [String] The prompt to use.
+    # @param prompt [Boxcars::Prompt] The prompt to use.
+    # @param engine [Boxcars::Engine] The engine to use for this train.
+    # @param kwargs [Hash] Additional arguments including: name, description, top_k, return_direct, and stop
     # @abstract
     def initialize(boxcars:, prompt:, engine: nil, **kwargs)
       @boxcars = boxcars
-      @name = name || self.class.name
+      @name_to_boxcar_map = boxcars.to_h { |boxcar| [boxcar.name, boxcar] }
       @return_values = [:output]
-      @return_intermediate_steps = kwargs[:return_intermediate_steps] || false
-      @max_iterations = kwargs[:max_iterations] || 25
-      @early_stopping_method = kwargs[:early_stopping_method] || "force"
+      @return_intermediate_steps = kwargs.delete(:return_intermediate_steps) || false
+      @max_iterations = kwargs.delete(:max_iterations) || 25
+      @early_stopping_method = kwargs.delete(:early_stopping_method) || "force"
+      kwargs[:stop] ||= ["\n#{observation_prefix}"]
 
-      super(prompt: prompt, engine: engine, name: kwargs[:name], description: kwargs[:description])
+      super(prompt: prompt, engine: engine, **kwargs)
     end
 
     # Extract the boxcar name and input from the text.
@@ -27,11 +29,6 @@ module Boxcars
     def extract_boxcar_and_input(text)
     end
 
-    # the stop strings list
-    def stop
-      ["\n#{observation_prefix}"]
-    end
-
     # build the scratchpad for the engine
     # @param intermediate_steps [Array] The intermediate steps to build the scratchpad from.
     # @return [String] The scratchpad.
@@ -48,16 +45,20 @@ module Boxcars
     # @param full_inputs [Hash] The inputs to the engine.
     # @return [Boxcars::Action] The next action.
     def get_next_action(full_inputs)
-      full_output = predict(**full_inputs)
-      parsed_output = extract_boxcar_and_input(full_output)
-      while parsed_output.nil?
-        full_output = _fix_text(full_output)
+      full_output = ""
+      parsed_output = nil
+      loop do
         full_inputs[:agent_scratchpad] += full_output
         output = predict(**full_inputs)
         full_output += output
         parsed_output = extract_boxcar_and_input(full_output)
+        break unless parsed_output.nil?
+      end
+      if parsed_output.is_a?(Result)
+        TrainAction.from_result(boxcar: "Final Answer", result: parsed_output, log: full_output)
+      else
+        TrainAction.new(boxcar: parsed_output[0], boxcar_input: parsed_output[1], log: full_output)
       end
-      TrainAction.new(boxcar: parsed_output[0], boxcar_input: parsed_output[1], log: full_output)
     end
 
     # Given input, decided what to do.
@@ -66,8 +67,7 @@ module Boxcars
     # @return [Boxcars::Action] Action specifying what boxcar to use.
     def plan(intermediate_steps, **kwargs)
       thoughts = construct_scratchpad(intermediate_steps)
-      new_inputs = { agent_scratchpad: thoughts, stop: stop }
-      full_inputs = kwargs.merge(new_inputs)
+      full_inputs = prediction_additional.merge(kwargs).merge(agent_scratchpad: thoughts)
       action = get_next_action(full_inputs)
       return TrainFinish.new({ output: action.boxcar_input }, log: action.log) if action.boxcar == finish_boxcar_name
 
@@ -184,7 +184,6 @@ module Boxcars
     # @return [Hash] The output.
     def call(inputs:)
       prepare_for_new_call
-      name_to_boxcar_map = boxcars.to_h { |boxcar| [boxcar.name, boxcar] }
       intermediate_steps = []
       iterations = 0
       while should_continue?(iterations)

data/lib/boxcars/version.rb

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

data/lib/boxcars.rb

@@ -107,6 +107,7 @@ module Boxcars
   end
 
   # Logging system
+  # debug log
   def self.debug(msg, color = nil, **options)
     msg = colorize(msg.to_s, color, **options) if color
     if logger
@@ -116,6 +117,7 @@ module Boxcars
     end
   end
 
+  # info log
   def self.info(msg, color = nil, **options)
     msg = colorize(msg.to_s, color, **options) if color
     if logger
@@ -125,6 +127,7 @@ module Boxcars
     end
   end
 
+  # warn log
   def self.warn(msg, color = nil, **options)
     msg = colorize(msg.to_s, color, **options) if color
     if logger
@@ -134,6 +137,7 @@ module Boxcars
     end
   end
 
+  # error log
   def self.error(msg, color = nil, **options)
     msg = colorize(msg.to_s, color, **options) if color
     if logger
@@ -143,6 +147,7 @@ module Boxcars
     end
   end
 
+  # simple colorization
   def self.colorize(str, color, **options)
     background = options[:background] || options[:bg] || false
     style = options[:style]
@@ -157,6 +162,8 @@ end
 
 require "boxcars/version"
 require "boxcars/prompt"
+require "boxcars/conversation_prompt"
+require "boxcars/conversation"
 require "boxcars/generation"
 require "boxcars/ruby_repl"
 require "boxcars/engine"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcars
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Francis Sullivan
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -109,11 +109,14 @@ files:
 - lib/boxcars/boxcar/engine_boxcar.rb
 - lib/boxcars/boxcar/google_search.rb
 - lib/boxcars/boxcar/sql.rb
+- lib/boxcars/conversation.rb
+- lib/boxcars/conversation_prompt.rb
 - lib/boxcars/engine.rb
 - lib/boxcars/engine/engine_result.rb
 - lib/boxcars/engine/openai.rb
 - lib/boxcars/generation.rb
 - lib/boxcars/prompt.rb
+- lib/boxcars/result.rb
 - lib/boxcars/ruby_repl.rb
 - lib/boxcars/train.rb
 - lib/boxcars/train/train_action.rb