boxcars 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d131a1f5eb1cb3c6f3cece9c2fcf3246ea81376386b4e7ea23a0d14ee739301
-  data.tar.gz: 2d0295a8b37da8ab8b7320d9b01c763cd333c5b8f2f20dfe452a54101cd3fd38
+  metadata.gz: c3331a78e13cbbd90ee2b5c37d09ee6721ca9f5812654c045649f4555198ace1
+  data.tar.gz: 727f2acecdfb28ba6ef6e313f946182ee8569758e62f37d68e32dbf075a62cba
 SHA512:
-  metadata.gz: 62ee3e7bf7bf6ba12d07db731195427dd726cc1ecd97ae88998a642d78c48b9e0cfc6c317676f9b37b1007496da6565dba021d513ec26528349c00b41dd0c854
-  data.tar.gz: 7dd1ae996ad38c616aa62f69c126a5101e4723bbacec3a25e06cf245a9792cc72edc7806d629163fea7f78d61269125ad6f136da47895bca485f928c198a21ef
+  metadata.gz: 95adc97ef8b02af5c6ddd9ae5d6463e39df4935290ee902075a2211b02f4968d18d6faf367678a64507b899b88ba9505392ccf166483c3cfbbe211e07aafe8c6
+  data.tar.gz: d2d6e03b64404313dc8fa5d9ad671a5be19575cdf0b45e4c4d8b9e05b48a649eb6d8de9d371bab39c508630743c1fd97275d2ae25e324f32d28ac94510c42dd8

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Changelog
 
+## [v0.4.1](https://github.com/BoxcarsAI/boxcars/tree/v0.4.1) (2023-07-25)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.4.0...v0.4.1)
+
+**Merged pull requests:**
+
+- Do not use the engine\_prefix to start the LLM prompt for the XML Train [\#106](https://github.com/BoxcarsAI/boxcars/pull/106) ([francis](https://github.com/francis))
+- Adding 16k context [\#105](https://github.com/BoxcarsAI/boxcars/pull/105) ([eltoob](https://github.com/eltoob))
+
+## [v0.4.0](https://github.com/BoxcarsAI/boxcars/tree/v0.4.0) (2023-07-19)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.3.5...v0.4.0)
+
+**Closed issues:**
+
+- Add Anthropic Engine [\#103](https://github.com/BoxcarsAI/boxcars/issues/103)
+
+**Merged pull requests:**
+
+- Add Anthropic Engine - closes \#103 [\#104](https://github.com/BoxcarsAI/boxcars/pull/104) ([francis](https://github.com/francis))
+
+## [v0.3.5](https://github.com/BoxcarsAI/boxcars/tree/v0.3.5) (2023-07-13)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.3.4...v0.3.5)
+
+## [v0.3.4](https://github.com/BoxcarsAI/boxcars/tree/v0.3.4) (2023-07-11)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.3.3...v0.3.4)
+
+## [v0.3.3](https://github.com/BoxcarsAI/boxcars/tree/v0.3.3) (2023-07-10)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.3.2...v0.3.3)
+
+## [v0.3.2](https://github.com/BoxcarsAI/boxcars/tree/v0.3.2) (2023-07-10)
+
+[Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.3.1...v0.3.2)
+
+**Merged pull requests:**
+
+- add XML Train and XML Zero Shot [\#102](https://github.com/BoxcarsAI/boxcars/pull/102) ([francis](https://github.com/francis))
+
 ## [v0.3.1](https://github.com/BoxcarsAI/boxcars/tree/v0.3.1) (2023-07-01)
 
 [Full Changelog](https://github.com/BoxcarsAI/boxcars/compare/v0.2.16...v0.3.1)

data/Gemfile.lock

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

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 LLMs (OpenAI, Anthropic, Gpt4all), 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).
+Boxcars is a gem that enables you to create new systems with AI composability, using various concepts such as LLMs (OpenAI, Anthropic, Gpt4all), Search, SQL (with both Sequel and 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.
 
@@ -48,7 +48,7 @@ Or install it yourself as:
 
 We will be adding more examples soon, but here are a couple to get you started. First, you'll need to set up your environment variables for OpenAI and Google SERP (OPENAI_ACCESS_TOKEN, SERPAPI_API_KEY). If you prefer not to set these variables in your environment, you can pass them directly into the API.
 
-In the examples below, we added one rubygem to load the environment at the first line, but depending on what you want, you might not need this.
+In the examples below, we added one Ruby gem to load the environment at the first line, but depending on what you want, you might not need this.
 ```ruby
 require "dotenv/load"
 require "boxcars"
@@ -68,12 +68,12 @@ irb -r dotenv/load -r ./lib/boxcars
 # run the calculator
 engine = Boxcars::Openai.new(max_tokens: 256)
 calc = Boxcars::Calculator.new(engine: engine)
-puts calc.run "what is pi to the forth power divided by 22.1?"
+puts calc.run "what is pi to the fourth power divided by 22.1?"
 ```
 Produces:
 ```text
 > Entering Calculator#run
-what is pi to the forth power divided by 22.1?
+what is pi to the fourth power divided by 22.1?
 RubyREPL: puts (Math::PI**4)/22.1
 Answer: 4.407651178009159
 
@@ -82,20 +82,20 @@ Answer: 4.407651178009159
 4.407651178009159
 ```
 
-Note that since Openai is currently the most used Engine, if you do not pass in an engine, it will default as expected. So, this is the equialent shorter version of the above script:
+Note that since Openai is currently the most used Engine, if you do not pass in an engine, it will default as expected. So, this is the equivalent shorter version of the above script:
 ```ruby
 # run the calculator
 calc = Boxcars::Calculator.new # just use the default Engine
-puts calc.run "what is pi to the forth power divided by 22.1?"
+puts calc.run "what is pi to the fourth power divided by 22.1?"
 ```
 You can change the default_engine with `Boxcars::configuration.default_engine = NewDefaultEngine`
 ### Boxcars currently implemented
 
 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
+- GoogleSearch: uses the SERP API to do searches
 - WikipediaSearch: uses the Wikipedia API to do searches
 - 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.
+- SQL: given an ActiveRecord connection, it will generate and run sql statements from a prompt.
 - ActiveRecord: given an ActiveRecord connection, it will generate and run ActiveRecord statements from a prompt.
 - Swagger: give a Swagger Open API file (YAML or JSON), answer questions about or run against the referenced service. See [here](https://github.com/BoxcarsAI/boxcars/blob/main/notebooks/swagger_examples.ipynb) for examples.
 

data/lib/boxcars/boxcar/xml_engine_boxcar.rb

@@ -0,0 +1,31 @@
+# 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 XMLEngineBoxcar < EngineBoxcar
+    # An XML Engine Boxcar is a container for a single tool to run.
+
+    # Parse out the action and input from the engine output.
+    # @param engine_output [String] The output from the engine.
+    # @return [Array<String>] The action and input.
+    def get_answer(engine_output)
+      xn_get_answer(XNode.from_xml(engine_output))
+    end
+
+    # get answer an XNode
+    # @param xnode [XNode] The XNode to use.
+    # @return [Array<String, String>] The action and input.
+    def xn_get_answer(xnode)
+      reply = xnode.xtext("//reply")
+
+      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 or didn't use tags. I was expecting a 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/xml_engine_boxcar"
 require "boxcars/boxcar/calculator"
 require "boxcars/boxcar/ruby_calculator"
 require "boxcars/boxcar/google_search"

data/lib/boxcars/engine/openai.rb

@@ -9,9 +9,9 @@ module Boxcars
 
     # The default parameters to use when asking the engine.
     DEFAULT_PARAMS = {
-      model: "gpt-3.5-turbo",
+      model: "gpt-3.5-turbo-16k",
       temperature: 0.2,
-      max_tokens: 512
+      max_tokens: 2048
     }.freeze
 
     # the default name of the engine
@@ -44,7 +44,7 @@ module Boxcars
     end
 
     def conversation_model?(model)
-      ["gpt-3.5-turbo", "gpt-4"].include?(model)
+      ["gpt-3.5-turbo", "gpt-4", "gpt-3.5-turbo-16k"].include?(model)
     end
 
     # Get an answer from the engine.

data/lib/boxcars/train/xml_zero_shot.rb

@@ -16,7 +16,7 @@ module Boxcars
     # @param prompt [Boxcars::Prompt] The prompt to use. Defaults to the built-in prompt.
     # @param kwargs [Hash] Additional arguments to pass to the train. wants_next_actions: true
     def initialize(boxcars:, engine: nil, name: 'Zero Shot XML', description: 'Zero Shot Train wiht XML', prompt: nil, **kwargs)
-      @engine_prefix = '<thought>'
+      @engine_prefix = ''
       @wants_next_actions = kwargs.fetch(:wants_next_actions, false)
       prompt ||= my_prompt
       super(engine: engine, boxcars: boxcars, prompt: prompt, name: name, description: description, **kwargs)
@@ -33,18 +33,18 @@ module Boxcars
            " <action>the action to take, from this action list above</action>\n",
            " <action_input>input to the action</action_input>\n",
            " <observation>the result of the action</observation>\n",
-           " ... (this Thought/Action/Action Input/Observation sequence can repeat N times)\n",
+           " ... (this thought/action/action_input/observation sequence repeats until you know the final answer) ...\n",
            " <thought>I know the final answer</thought>\n",
            " <final_answer>the final answer to the original input question</final_answer>\n",
            "-- FORMAT END -\n",
            "Your answer should always have begin and end tags for each element.\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 ",
+           "Also make sure to specify arguments for the action_input.\n",
+           "Finally, if you can deduct the answer from the question or observations, you can ",
            "jump to final_answer and give me the answer.\n",
            "</training>"),
       hist, # insert thoughts here from previous runs
       user("<question>%<input>s</question>"),
-      assi("<thought>%<agent_scratchpad>s")
+      assi("%<agent_scratchpad>s")
     ].freeze
 
     # The prompt to use for the train.

data/lib/boxcars/train.rb

@@ -45,7 +45,7 @@ module Boxcars
     # @param intermediate_steps [Array] The intermediate steps to build the scratchpad from.
     # @return [String] The scratchpad.
     def construct_scratchpad(intermediate_steps)
-      thoughts = ""
+      thoughts = engine_prefix.to_s
       intermediate_steps.each do |action, observation|
         thoughts += action.is_a?(String) ? action : " #{action.log}"
         thoughts += "\n#{observation_text(observation)}\n#{engine_prefix}"
@@ -189,8 +189,8 @@ module Boxcars
       return boxcar_result unless using_xml
 
       if boxcar_result.is_a?(Result)
-        boxcar_result.answer = boxcar_result.answer.encode(xml: :text)
-      else
+        boxcar_result.answer = boxcar_result.answer.encode(xml: :text) if boxcar_result.answer.is_a?(String)
+      elsif boxcar_result.is_a?(String)
         boxcar_result = boxcar_result.encode(xml: :text)
       end
       boxcar_result

data/lib/boxcars/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcars
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Francis Sullivan
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2023-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anthropic
@@ -145,6 +145,7 @@ files:
 - lib/boxcars/boxcar/url_text.rb
 - lib/boxcars/boxcar/vector_answer.rb
 - lib/boxcars/boxcar/wikipedia_search.rb
+- lib/boxcars/boxcar/xml_engine_boxcar.rb
 - lib/boxcars/conversation.rb
 - lib/boxcars/conversation_prompt.rb
 - lib/boxcars/engine.rb