boxcars 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 463f57f1436cfea29e0a60bbfce071afd355a5d0cadbe1d69f96adc7393eacd6
-  data.tar.gz: 282e528fb8cb8b532b621db5c2e7ce2b82c4607057c01f0feb1eaacfe98ba09b
+  metadata.gz: d42ec321ce559b15e1b9da6b7d0338f13ce1faca17a5c70dfc1b516eb51062f9
+  data.tar.gz: 2b8841ca63703ef49426bf004207e808267bc7a692a33188f45d34bdf02c54ea
 SHA512:
-  metadata.gz: c76d2772db0925f71779c0bac1a2e92af20bcf398cc6e7cf943edeadb2014426554fba607b034fd68ac88bd26f2d42eef114de57332e83a4fe76558a9b2f0cea
-  data.tar.gz: '0489fffef87c32fbf6a7a9af4fbca77ef991437353211174617b6ea8e229e49accc85c39af93414ce1628a4472cc208d8075570abba5e8269b30cfb66000a40e'
+  metadata.gz: e793cc40fd92d2ea1e249f3f613b4a4bd51954a794c02a201e171d6f38a84da95d851464feab60e11729813c80b90bf8091dfb4750fa4be0084439b94ee8d9a2
+  data.tar.gz: 147e84f7839647fe86ac26d3ed0c9be34a450540dc29d43bd86b6b2fac944718fecb6ba0be324048dd836999ae8f1f0ad83e6f1d50e5975f8510905b35ded432

data/Gemfile.lock

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

data/lib/boxcars/boxcar/url_text.rb

@@ -18,11 +18,20 @@ module Boxcars
     # @return [String] The text for the url.
     def run(url)
       url = URI.parse(url)
-      get_answer(url)
+      do_encoding(get_answer(url))
     end
 
     private
 
+    def do_encoding(answer)
+      if answer.is_a?(Result)
+        answer.explanation = answer.explanation.encode(xml: :text)
+        answer
+      else
+        answer.encode(xml: :text)
+      end
+    end
+
     def html_to_text(url, response)
       Nokogiri::HTML(response.body).css(%w[h1 h2 h3 h4 h5 h6 p a].join(",")).map do |e|
         itxt = e.inner_text.strip

data/lib/boxcars/conversation.rb

@@ -90,7 +90,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: no_history.map { |ln| { role: ln.first, content: ln.last % inputs } } }
+      { messages: no_history.map { |ln| { role: ln.first, content: cformat(ln.last, inputs) } } }
     rescue ::KeyError => e
       first_line = e.message.to_s.split("\n").first
       Boxcars.error "Missing prompt input key: #{first_line}"
@@ -102,14 +102,20 @@ module Boxcars
     # @return [Hash] The formatted prompt { prompt: "..."}
     def as_prompt(inputs = nil)
       if show_roles
-        no_history.map { |ln| format("#{ln.first}: #{ln.last}", inputs) }.compact.join("\n\n")
+        no_history.map { |ln| cformat("#{ln.first}: #{ln.last}", inputs) }.compact.join("\n\n")
       else
-        no_history.map { |ln| format(ln.last, inputs) }.compact.join("\n\n")
+        no_history.map { |ln| cformat(ln.last, inputs) }.compact.join("\n\n")
       end
     rescue ::KeyError => e
       first_line = e.message.to_s.split("\n").first
       Boxcars.error "Missing prompt input key: #{first_line}"
       raise KeyError, "Prompt format error: #{first_line}"
     end
+
+    # special format that replaces lone percent signs with double percent signs
+    def cformat(*args)
+      args[0].gsub!(/%(?!<)/, '%%') if args.length > 1
+      format(*args)
+    end
   end
 end

data/lib/boxcars/observation.rb

@@ -29,7 +29,12 @@ module Boxcars
 
     # @return [String] An explanation of the result
     def to_s
-      note
+      note.to_s
+    end
+
+    # @return [String] An explanation of the result
+    def to_text
+      to_s
     end
 
     # create a new Observaton from a text string with a status of :ok

data/lib/boxcars/result.rb

@@ -3,7 +3,7 @@
 module Boxcars
   # used by Boxcars to return structured result and additional context
   class Result
-    attr_reader :status, :answer, :explanation, :suggestions, :added_context
+    attr_accessor :status, :answer, :explanation, :suggestions, :added_context
 
     # @param status [Symbol] :ok or :error
     # @param answer [String] The answer to the question

data/lib/boxcars/train/xml_train.rb

@@ -13,6 +13,7 @@ module Boxcars
     # @param kwargs [Hash] Additional arguments including: name, description, top_k, return_direct, and stop
     # @abstract
     def initialize(boxcars:, prompt:, engine: nil, **kwargs)
+      @using_xml = true
       super
     end
 
@@ -41,7 +42,9 @@ module Boxcars
     end
 
     def build_output(text)
-      if text =~ /#{close_tag(thought_prefix)}/
+      if text.end_with?("</usetool>")
+        "<data>#{engine_prefix}#{text}</output></data>"
+      elsif text =~ /#{close_tag(thought_prefix)}/
         "<data>#{engine_prefix}#{text}</data>"
       else
         "<data>#{text}</data>"

data/lib/boxcars/train.rb

@@ -3,7 +3,7 @@
 module Boxcars
   # @abstract
   class Train < EngineBoxcar
-    attr_reader :boxcars, :return_values, :return_intermediate_steps,
+    attr_reader :boxcars, :return_values, :return_intermediate_steps, :using_xml,
                 :max_iterations, :early_stopping_method, :name_to_boxcar_map,
                 :observation_prefix, :thought_prefix, :final_answer_prefix, :answer_prefix, :question_prefix, :engine_prefix
 
@@ -184,6 +184,18 @@ module Boxcars
       end
     end
 
+    def get_boxcar_result(boxcar, boxcar_input)
+      boxcar_result = boxcar.run(boxcar_input)
+      return boxcar_result unless using_xml
+
+      if boxcar_result.is_a?(Result)
+        boxcar_result.answer = boxcar_result.answer.encode(xml: :text)
+      else
+        boxcar_result = boxcar_result.encode(xml: :text)
+      end
+      boxcar_result
+    end
+
     # execute the train train
     # @param inputs [Hash] The inputs.
     # @return [Hash] The output.
@@ -197,7 +209,7 @@ module Boxcars
 
         if (boxcar = name_to_boxcar_map[output.boxcar])
           begin
-            observation = Observation.ok(boxcar.run(output.boxcar_input))
+            observation = Observation.ok(get_boxcar_result(boxcar, output.boxcar_input))
             return_direct = boxcar.return_direct
           rescue Boxcars::ConfigurationError, Boxcars::SecurityError => e
             raise e
@@ -212,9 +224,7 @@ module Boxcars
           observation = Observation.err("Error - #{output.boxcar} is not a valid action, try again.")
           return_direct = false
         end
-        # rubocop:disable Lint/RedundantStringCoercion
-        Boxcars.debug "Observation: #{observation.to_s}", :green
-        # rubocop:enable Lint/RedundantStringCoercion
+        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.3.2"
+  VERSION = "0.3.4"
 end

data/lib/boxcars/x_node.rb

@@ -10,7 +10,6 @@ module Boxcars
       @node = node
       @valid_names = []
       @children = {}
-      # @attributes = node.attributes.transform_values(&:value)
       @attributes = node.attributes.values.to_h { |a| [a.name.to_sym, a.value] }
 
       node.children.each do |child|
@@ -30,8 +29,13 @@ module Boxcars
 
     def self.from_xml(xml)
       doc = Nokogiri::XML.parse(xml)
-      raise XmlError, "XML is not valid: #{doc.errors.map { |e| "#{e.line}:#{e.column} #{e.message}" }}" if doc.errors.any?
-
+      if doc.errors.any?
+        Boxcars.debug("XML: #{xml}", :yellow)
+        # rubocop:disable Lint/Debugger
+        debugger if ENV.fetch("DEBUG_XML", false)
+        # rubocop:enable Lint/Debugger
+        raise XmlError, "XML is not valid: #{doc.errors.map { |e| "#{e.line}:#{e.column} #{e.message}" }}"
+      end
       XNode.new(doc.root)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcars
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Francis Sullivan
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_search_results