boxcars 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8de5394d5685d1b4deaa0c3c600b2211c6eda983d00fe474d25beb8733e11cce
-  data.tar.gz: 73bf2070533a235a8c3e6036d6f48465fc6d4ed22d8b120797d87441cb2657f9
+  metadata.gz: 10f7d544a53712e622028ebb6dc8e52c9dec9497f6e4436ef0ab456b27885c1e
+  data.tar.gz: 44e91be763215a67dec30899f9155b59b43397c225afe3a7e5677b888bc39056
 SHA512:
-  metadata.gz: c7996425e870726fc4a0e395fbf1a2f68b5bae9e584998fdbb6250aace415cdbc5953272871be8127df48a274548b5c5e34a6e8470f822c936b8b8c3df15333c
-  data.tar.gz: d3231558be47f6496dab661f63592ef4d44c9eb0426f4686a4caacd548b1dd1c2d68f1c1b8cfa97b2e3c3929c86531a121d4dee9473d16360931b44b30f8903e
+  metadata.gz: ac6c9bd9ff37d2c7ead36371f26f968fdce01ee5f5cfdcc1c9f876d6a879680c10faef74a285ee0fc1e8a1c23656ebe7c650be7d6d04370884566cc09942aa32
+  data.tar.gz: 58aaf3c88912de6cd2b6746a7a2b990f05227c9c9369e4fd3b64811f5ed479dc86608c7a60d8f9ce80cd1d26daefa565a6a3d925091190b4d36acfef4b344fc0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boxcars (0.4.4)
+    boxcars (0.4.5)
       anthropic (~> 0.1)
       google_search_results (~> 2.2)
       gpt4all (~> 0.0.4)

data/lib/boxcars/boxcar/json_engine_boxcar.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Boxcars is a framework for running a series of tools to get an answer to a question.
+module Boxcars
+  # For Boxcars that use an engine to do their work.
+  class JSONEngineBoxcar < EngineBoxcar
+    # A JSON Engine Boxcar is a container for a single tool to run.
+    attr_accessor :wanted_data, :data_description
+
+    # @param prompt [Boxcars::Prompt] The prompt to use for this boxcar with sane defaults.
+    # @param wanted_data [String] The data to extract from.
+    # @param data_description [String] The description of the data.
+    # @param kwargs [Hash] Additional arguments
+    def initialize(prompt: nil, wanted_data: nil, data_description: nil, **kwargs)
+      @wanted_data = wanted_data || "summarize the pertinent facts from the input data"
+      @data_description = data_description || "the input data"
+      the_prompt = prompt || default_prompt
+      kwargs[:description] ||= "JSON Engine Boxcar"
+      super(prompt: the_prompt, **kwargs)
+    end
+
+    def default_prompt
+      stock_prompt = <<~SYSPR
+        I will provide you with %<data_description>s, and your job is to extract information as described below.
+
+        Your Output must be valid JSON with no lead in or post answer text in the output format below:
+
+        Output Format:
+          {
+            %<wanted_data>s
+          }
+      SYSPR
+      sprompt = format(stock_prompt, wanted_data: wanted_data, data_description: data_description)
+      ctemplate = [
+        Boxcar.syst(sprompt),
+        Boxcar.user("%<input>s")
+      ]
+      conv = Conversation.new(lines: ctemplate)
+      ConversationPrompt.new(conversation: conv, input_variables: [:input], other_inputs: [], output_variables: [:answer])
+    end
+
+    # Parse out the action and input from the engine output.
+    # @param engine_output [String] The output from the engine.
+    # @return [Result] The result.
+    def get_answer(engine_output)
+      extract_answer(JSON.parse(engine_output))
+    rescue StandardError => e
+      Result.from_error("Error: #{e.message}:\n#{engine_output}")
+    end
+
+    # get answer from parsed JSON
+    # @param data [Hash] The data to extract from.
+    # @return [Result] The result.
+    def extract_answer(data)
+      reply = data
+
+      if reply.present?
+        Result.new(status: :ok, answer: reply, explanation: reply)
+      else
+        # we have an unexpected output from the engine
+        Result.new(status: :error, answer: nil,
+                   explanation: "You gave me an improperly formatted answer. I was expecting a valid reply.")
+      end
+    end
+  end
+end

data/lib/boxcars/boxcar.rb

@@ -211,6 +211,7 @@ end
 require "boxcars/observation"
 require "boxcars/result"
 require "boxcars/boxcar/engine_boxcar"
+require "boxcars/boxcar/json_engine_boxcar"
 require "boxcars/boxcar/xml_engine_boxcar"
 require "boxcars/boxcar/calculator"
 require "boxcars/boxcar/ruby_calculator"

data/lib/boxcars/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcars
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Francis Sullivan
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anthropic
@@ -137,6 +137,7 @@ files:
 - lib/boxcars/boxcar/calculator.rb
 - lib/boxcars/boxcar/engine_boxcar.rb
 - lib/boxcars/boxcar/google_search.rb
+- lib/boxcars/boxcar/json_engine_boxcar.rb
 - lib/boxcars/boxcar/ruby_calculator.rb
 - lib/boxcars/boxcar/sql_active_record.rb
 - lib/boxcars/boxcar/sql_base.rb