boxcars 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1a16f4a38b33df747173cfabb27c183b95eccdcf35b4b8167db16fec1ecc913
-  data.tar.gz: cdbc64c7a8d71c9bd2812a07ed022f25c08f2bd68e34d2a3bc8686dafde486d0
+  metadata.gz: 0d131a1f5eb1cb3c6f3cece9c2fcf3246ea81376386b4e7ea23a0d14ee739301
+  data.tar.gz: 2d0295a8b37da8ab8b7320d9b01c763cd333c5b8f2f20dfe452a54101cd3fd38
 SHA512:
-  metadata.gz: ba80d07797ef09b43012048e52cb7181a707595f848b9a1b3f62890442e0355f190219301467bb51aecb9b6581d81908e8d1995b2b707ded618287bb50f10db6
-  data.tar.gz: 41c28b0fdca5dfb4da99c19963cd014bcdd1f3a582c0efdd0446f612bfdafae4c6a22303c0bcff4e5c1da02fae355a782651000802c90f20ca2c66b53d07b683
+  metadata.gz: 62ee3e7bf7bf6ba12d07db731195427dd726cc1ecd97ae88998a642d78c48b9e0cfc6c317676f9b37b1007496da6565dba021d513ec26528349c00b41dd0c854
+  data.tar.gz: 7dd1ae996ad38c616aa62f69c126a5101e4723bbacec3a25e06cf245a9792cc72edc7806d629163fea7f78d61269125ad6f136da47895bca485f928c198a21ef

data/Gemfile

@@ -13,6 +13,8 @@ gem "rake", "~> 13.0"
 
 gem "sqlite3", "~> 1.6"
 
+gem "async", "~>1.31.0"
+
 gem "activerecord", "~> 7.0"
 
 gem "github_changelog_generator", "~> 1.16"

data/Gemfile.lock

@@ -1,51 +1,56 @@
 PATH
   remote: .
   specs:
-    boxcars (0.3.5)
+    boxcars (0.4.0)
+      anthropic (~> 0.1)
       google_search_results (~> 2.2)
       gpt4all (~> 0.0.4)
       hnswlib (~> 0.8)
       nokogiri (~> 1.15)
       pgvector (~> 0.2)
-      ruby-openai (~> 4.1)
+      ruby-openai (~> 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activerecord (7.0.4.3)
-      activemodel (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activesupport (7.0.4.3)
+    activemodel (7.0.6)
+      activesupport (= 7.0.6)
+    activerecord (7.0.6)
+      activemodel (= 7.0.6)
+      activesupport (= 7.0.6)
+    activesupport (7.0.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
+    anthropic (0.1.0)
+      faraday (>= 1)
+      faraday-multipart (>= 1)
     ast (2.4.2)
     async (1.31.0)
       console (~> 1.10)
       nio4r (~> 2.3)
       timers (~> 4.1)
-    async-http (0.60.1)
+    async-http (0.60.2)
       async (>= 1.25)
       async-io (>= 1.28)
       async-pool (>= 0.2)
       protocol-http (~> 0.24.0)
       protocol-http1 (~> 0.15.0)
       protocol-http2 (~> 0.15.0)
-      traces (>= 0.8.0)
+      traces (>= 0.10.0)
     async-http-faraday (0.12.0)
       async-http (~> 0.42)
       faraday
-    async-io (1.34.3)
+    async-io (1.35.0)
       async
     async-pool (0.4.0)
       async (>= 1.25)
     concurrent-ruby (1.2.2)
-    console (1.16.2)
+    console (1.17.4)
+      fiber-annotation
       fiber-local
     crack (0.4.5)
       rexml
@@ -56,7 +61,7 @@ GEM
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.8.1)
-    faraday (2.7.9)
+    faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-http-cache (2.5.0)
@@ -64,8 +69,9 @@ GEM
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
     faraday-net_http (3.0.2)
-    faraday-retry (2.1.0)
+    faraday-retry (2.2.0)
       faraday (~> 2.0)
+    fiber-annotation (0.2.0)
     fiber-local (1.0.0)
     github_changelog_generator (1.16.4)
       activesupport
@@ -86,55 +92,48 @@ GEM
     http-accept (1.7.0)
     http-cookie (1.0.5)
       domain_name (~> 0.5)
-    i18n (1.13.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     io-console (0.6.0)
-    io-console (0.6.0-java)
-    irb (1.6.4)
-      reline (>= 0.3.0)
+    irb (1.7.4)
+      reline (>= 0.3.6)
     json (2.6.3)
-    json (2.6.3-java)
+    language_server-protocol (3.17.0.3)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2023.0218.1)
-    mini_portile2 (2.8.2)
-    minitest (5.18.0)
+    minitest (5.18.1)
     multi_json (1.15.0)
     multipart-post (2.3.0)
     netrc (0.11.0)
     nio4r (2.5.9)
-    nio4r (2.5.9-java)
-    nokogiri (1.15.2-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.15.2-java)
-      racc (~> 1.4)
-    nokogiri (1.15.2-x86_64-darwin)
+    nokogiri (1.15.3-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.2-x86_64-linux)
+    nokogiri (1.15.3-x86_64-linux)
       racc (~> 1.4)
     octokit (4.25.1)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     os (1.1.4)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     pg (1.5.3)
-    pgvector (0.2.0)
+    pgvector (0.2.1)
     protocol-hpack (1.4.2)
-    protocol-http (0.24.1)
+    protocol-http (0.24.4)
     protocol-http1 (0.15.0)
       protocol-http (~> 0.22)
     protocol-http2 (0.15.1)
       protocol-hpack (~> 1.4)
       protocol-http (~> 0.18)
-    public_suffix (5.0.1)
+    public_suffix (5.0.3)
     racc (1.7.1)
-    racc (1.7.1-java)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.0)
-    reline (0.3.3)
+    regexp_parser (2.8.1)
+    reline (0.3.6)
       io-console (~> 0.5)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
@@ -151,21 +150,22 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.51.0)
+    rspec-support (3.12.1)
+    rubocop (1.54.2)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
@@ -177,7 +177,7 @@ GEM
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
-    ruby-openai (4.1.0)
+    ruby-openai (4.2.0)
       faraday (>= 1)
       faraday-multipart (>= 1)
     ruby-progressbar (1.13.0)
@@ -185,14 +185,11 @@ GEM
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
-    sqlite3 (1.6.3)
-      mini_portile2 (~> 2.8.0)
     sqlite3 (1.6.3-arm64-darwin)
-    sqlite3 (1.6.3-x86_64-darwin)
     sqlite3 (1.6.3-x86_64-linux)
     strings-ansi (0.2.0)
     timers (4.3.5)
-    traces (0.9.1)
+    traces (0.11.1)
     tty-cursor (0.7.1)
     tty-progressbar (0.18.2)
       strings-ansi (~> 0.2)
@@ -204,7 +201,6 @@ GEM
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
-    unf (0.1.4-java)
     unf_ext (0.0.8.2)
     unicode-display_width (2.4.2)
     vcr (6.1.0)
@@ -215,14 +211,12 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
-  universal-java-11
-  x86_64-darwin-21
-  x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
   activerecord (~> 7.0)
   activesupport (~> 7.0)
+  async (~> 1.31.0)
   boxcars!
   debug (~> 1.1)
   dotenv (~> 2.8)
@@ -242,4 +236,4 @@ DEPENDENCIES
   webmock (~> 3.18.1)
 
 BUNDLED WITH
-   2.4.7
+   2.4.16

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 OpenAI, 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 an 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.
 
@@ -20,7 +20,7 @@ All of these concepts are in a module named Boxcars:
 - Boxcar - an encapsulation that performs something of interest (such as search, math, SQL, an Active Record Query, or an API call to a service). A Boxcar can use an Engine (described below) to do its work, and if not specified but needed, the default Engine is used `Boxcars.engine`.
 - 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. Our Boxcars have built-in prompts, but you have the flexibility to change or augment them if you so desire.
-- Engine - an entity that generates text from a Prompt. OpenAI's LLM text generator is the default Engine if no other is specified, and you can override the default engine if so desired (`Boxcar.configuration.default_engine`).
+- Engine - an entity that generates text from a Prompt. OpenAI's LLM text generator is the default Engine if no other is specified, and you can override the default engine if so desired (`Boxcar.configuration.default_engine`). We have an Engine for Anthropic's Claude API named `Boxcars::Anthropic`, and another Engine for GPT named `Boxcars::Gpt4allEng`.
 - VectorStore - a place to store and query vectors.
 
 ## Security

data/boxcars.gemspec

@@ -31,12 +31,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # runtime dependencies
+  spec.add_dependency "anthropic", "~> 0.1"
   spec.add_dependency "google_search_results", "~> 2.2"
   spec.add_dependency "gpt4all", "~> 0.0.4"
   spec.add_dependency "hnswlib", "~> 0.8"
   spec.add_dependency "nokogiri", "~> 1.15"
   spec.add_dependency "pgvector", "~> 0.2"
-  spec.add_dependency "ruby-openai", "~> 4.1"
+  spec.add_dependency "ruby-openai", "~> 4.2"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/boxcars/boxcar/active_record.rb

@@ -200,7 +200,7 @@ module Boxcars
     def error_message(err, stage)
       msg = err.message
       msg = ::Regexp.last_match(1) if msg =~ /^(.+)' for #<Boxcars::ActiveRecord/
-      msg.gsub!(/Boxcars::ActiveRecord::/, '')
+      msg.gsub!("Boxcars::ActiveRecord::", '')
       "For the value you gave for #{stage}, fix this error: #{msg}"
     end
 

data/lib/boxcars/boxcar/ruby_calculator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Boxcars is a framework for running a series of tools to get an answer to a question.
+module Boxcars
+  # A Boxcar executes ruby code to do math
+  class RubyCalculator < Boxcar
+    # the description of this engine boxcar
+    CALCDESC = "will run a ruby calculation to answer a math question"
+
+    # @param kwargs [Hash] Any other keyword arguments to pass to the parent class.
+    def initialize(**kwargs)
+      kwargs[:name] ||= "RubyCalculator"
+      kwargs[:description] ||= CALCDESC
+      kwargs[:parameters] ||= default_params
+
+      super(**kwargs)
+    end
+
+    def default_params
+      { question: {
+          type: :string,
+          description: "a Ruby programming string that will compute the answer to a math question",
+          required: true
+          } }
+    end
+
+    # run a ruby calculator question
+    # @param question [String] The question to ask Google.
+    # @return [String] The answer to the question.
+    def run(question)
+      code = "puts(#{question})"
+      ruby_executor = Boxcars::RubyREPL.new
+      rv = ruby_executor.call(code: code)
+      puts "Question: #{question}"
+      puts "Answer: #{rv}"
+      rv
+    end
+  end
+end

data/lib/boxcars/boxcar.rb

@@ -3,16 +3,18 @@
 module Boxcars
   # @abstract
   class Boxcar
-    attr_reader :name, :description, :return_direct
+    attr_reader :name, :description, :return_direct, :parameters
 
     # A Boxcar is a container for a single tool to run.
     # @param name [String] The name of the boxcar. Defaults to classname.
     # @param description [String] A description of the boxcar.
     # @param return_direct [Boolean] If true, return the output of this boxcar directly, without merging it with the inputs.
-    def initialize(description:, name: nil, return_direct: false)
+    # @param parameters [Hash] The parameters for this boxcar.
+    def initialize(description:, name: nil, return_direct: false, parameters: nil)
       @name = name || self.class.name
       @description = description || @name
       @return_direct = return_direct
+      @parameters = parameters || { question: { type: :string, description: "the input question", required: true } }
     end
 
     # Input keys this chain expects.
@@ -110,19 +112,17 @@ module Boxcars
     end
 
     # load this boxcar from a file
-    # rubocop:disable Security/YAMLLoad
     def load(path:)
-      YAML.load(File.read(path))
+      YAML.load_file(path)
     end
-    # rubocop:enable Security/YAMLLoad
 
     def schema
-      params = input_keys.map do |key|
-        "<param name=\"#{key}\" data-type=\"String\" required=\"true\" description=\"#{key}\" />"
+      params = parameters.map do |name, info|
+        "<param name=#{name.to_s.inspect} data-type=#{info[:type].to_s.inspect} required=\"#{info[:required] == true}\" " \
+          "description=#{info[:description].inspect} />"
       end.join("\n")
       <<~SCHEMA.freeze
-        <tool>
-          <tool name="#{name}" version="0.1" description="#{description}">
+        <tool name="#{name}" description="#{description}">
           <params>
             #{params}
           </params>
@@ -212,6 +212,7 @@ require "boxcars/observation"
 require "boxcars/result"
 require "boxcars/boxcar/engine_boxcar"
 require "boxcars/boxcar/calculator"
+require "boxcars/boxcar/ruby_calculator"
 require "boxcars/boxcar/google_search"
 require "boxcars/boxcar/url_text"
 require "boxcars/boxcar/wikipedia_search"

data/lib/boxcars/conversation.rb

@@ -3,14 +3,13 @@
 module Boxcars
   # used to keep track of the conversation
   class Conversation
-    attr_reader :lines, :show_roles
+    attr_reader :lines
 
     PEOPLE = %i[system user assistant history].freeze
 
-    def initialize(lines: [], show_roles: false)
+    def initialize(lines: [])
       @lines = lines
       check_lines(@lines)
-      @show_roles = show_roles
     end
 
     # check the lines
@@ -100,9 +99,10 @@ module Boxcars
     # compute the prompt parameters with input substitutions
     # @param inputs [Hash] The inputs to use for the prompt.
     # @return [Hash] The formatted prompt { prompt: "..."}
-    def as_prompt(inputs = nil)
+    def as_prompt(inputs: nil, prefixes: default_prefixes, show_roles: false)
       if show_roles
-        no_history.map { |ln| cformat("#{ln.first}: #{ln.last}", inputs) }.compact.join("\n\n")
+        lines = no_history.map { |ln| [prefixes[ln[0]], ln[1]] }
+        lines.map { |ln| cformat("#{ln.first}#{ln.last}", inputs) }.compact.join("\n\n")
       else
         no_history.map { |ln| cformat(ln.last, inputs) }.compact.join("\n\n")
       end
@@ -117,5 +117,9 @@ module Boxcars
       args[0] = args[0].dup.gsub(/%(?!<)/, '%%') if args.length > 1
       format(*args)
     end
+
+    def default_prefixes
+      { system: 'System: ', user: 'User: ', assistant: 'Assistant: ', history: :history }
+    end
   end
 end

data/lib/boxcars/conversation_prompt.rb

@@ -24,8 +24,8 @@ module Boxcars
     # prompt for non chatGPT params
     # @param inputs [Hash] The inputs to use for the prompt.
     # @return [Hash] The formatted prompt.
-    def as_prompt(inputs)
-      { prompt: conversation.as_prompt(inputs) }
+    def as_prompt(inputs:, prefixes: default_prefixes, show_roles: false)
+      { prompt: conversation.as_prompt(inputs: inputs, prefixes: prefixes, show_roles: show_roles) }
     end
 
     # tack on the ongoing conversation if present to the prompt
@@ -47,5 +47,9 @@ module Boxcars
     def to_s
       conversation.to_s
     end
+
+    def default_prefixes
+      conversation.default_prefixes
+    end
   end
 end

data/lib/boxcars/engine/anthropic.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require 'anthropic'
+# Boxcars is a framework for running a series of tools to get an answer to a question.
+module Boxcars
+  # A engine that uses OpenAI's API.
+  class Anthropic < Engine
+    attr_reader :prompts, :llm_params, :model_kwargs, :batch_size
+
+    # The default parameters to use when asking the engine.
+    DEFAULT_PARAMS = {
+      model: "claude-2",
+      max_tokens_to_sample: 8096,
+      temperature: 0.2
+    }.freeze
+
+    # the default name of the engine
+    DEFAULT_NAME = "Anthropic engine"
+    # the default description of the engine
+    DEFAULT_DESCRIPTION = "useful for when you need to use Anthropic AI to answer questions. " \
+                          "You should ask targeted questions"
+
+    # A engine is the driver for a single tool to run.
+    # @param name [String] The name of the engine. Defaults to "OpenAI engine".
+    # @param description [String] A description of the engine. Defaults to:
+    #        useful for when you need to use AI to answer questions. You should ask targeted questions".
+    # @param prompts [Array<String>] The prompts to use when asking the engine. Defaults to [].
+    def initialize(name: DEFAULT_NAME, description: DEFAULT_DESCRIPTION, prompts: [], **kwargs)
+      @llm_params = DEFAULT_PARAMS.merge(kwargs)
+      @prompts = prompts
+      @batch_size = 20
+      super(description: description, name: name)
+    end
+
+    def conversation_model?(_model)
+      false
+    end
+
+    def anthropic_client(anthropic_api_key: nil)
+      ::Anthropic::Client.new(access_token: anthropic_api_key)
+    end
+
+    # Get an answer from the engine.
+    # @param prompt [String] The prompt to use when asking the engine.
+    # @param anthropic_api_key [String] Optional api key to use when asking the engine.
+    #   Defaults to Boxcars.configuration.anthropic_api_key.
+    # @param kwargs [Hash] Additional parameters to pass to the engine if wanted.
+    def client(prompt:, inputs: {}, **kwargs)
+      api_key = Boxcars.configuration.anthropic_api_key(**kwargs)
+      aclient = anthropic_client(anthropic_api_key: api_key)
+      params = prompt.as_prompt(inputs: inputs, prefixes: default_prefixes, show_roles: true).merge(llm_params.merge(kwargs))
+      params[:prompt] = "\n\n#{params[:prompt]}" unless params[:prompt].start_with?("\n\n")
+      params[:stop_sequences] = params.delete(:stop) if params.key?(:stop)
+      Boxcars.debug("Prompt after formatting:#{params[:prompt]}", :cyan) if Boxcars.configuration.log_prompts
+      aclient.complete(parameters: params)
+    end
+
+    # get an answer from the engine for a question.
+    # @param question [String] The question to ask the engine.
+    # @param kwargs [Hash] Additional parameters to pass to the engine if wanted.
+    def run(question, **kwargs)
+      prompt = Prompt.new(template: question)
+      response = client(prompt: prompt, **kwargs)
+
+      raise Error, "Anthropic: No response from API" unless response
+      raise Error, "Anthropic: #{response['error']}" if response['error']
+
+      answer = response['completion']
+      Boxcars.debug(response, :yellow)
+      answer
+    end
+
+    # Get the default parameters for the engine.
+    def default_params
+      llm_params
+    end
+
+    # Get generation informaton
+    # @param sub_choices [Array<Hash>] The choices to get generation info for.
+    # @return [Array<Generation>] The generation information.
+    def generation_info(sub_choices)
+      sub_choices.map do |choice|
+        Generation.new(
+          text: choice["completion"],
+          generation_info: {
+            finish_reason: choice.fetch("stop_reason", nil),
+            logprobs: choice.fetch("logprobs", nil)
+          }
+        )
+      end
+    end
+
+    # make sure we got a valid response
+    # @param response [Hash] The response to check.
+    # @param must_haves [Array<String>] The keys that must be in the response. Defaults to %w[choices].
+    # @raise [KeyError] if there is an issue with the access token.
+    # @raise [ValueError] if the response is not valid.
+    def check_response(response, must_haves: %w[completion])
+      if response['error']
+        code = response.dig('error', 'code')
+        msg = response.dig('error', 'message') || 'unknown error'
+        raise KeyError, "ANTHOPIC_API_KEY not valid" if code == 'invalid_api_key'
+
+        raise ValueError, "Anthropic error: #{msg}"
+      end
+
+      must_haves.each do |key|
+        raise ValueError, "Expecting key #{key} in response" unless response.key?(key)
+      end
+    end
+
+    # Call out to OpenAI's endpoint with k unique prompts.
+    # @param prompts [Array<String>] The prompts to pass into the model.
+    # @param inputs [Array<String>] The inputs to subsitite into the prompt.
+    # @param stop [Array<String>] Optional list of stop words to use when generating.
+    # @return [EngineResult] The full engine output.
+    def generate(prompts:, stop: nil)
+      params = {}
+      params[:stop] = stop if stop
+      choices = []
+      # Get the token usage from the response.
+      # Includes prompt, completion, and total tokens used.
+      prompts.each_slice(batch_size) do |sub_prompts|
+        sub_prompts.each do |sprompts, inputs|
+          response = client(prompt: sprompts, inputs: inputs, **params)
+          check_response(response)
+          choices << response
+        end
+      end
+
+      n = params.fetch(:n, 1)
+      generations = []
+      prompts.each_with_index do |_prompt, i|
+        sub_choices = choices[i * n, (i + 1) * n]
+        generations.push(generation_info(sub_choices))
+      end
+      EngineResult.new(generations: generations, engine_output: { token_usage: {} })
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # the identifying parameters for the engine
+    def identifying_params
+      params = { model_name: model_name }
+      params.merge!(default_params)
+      params
+    end
+
+    # the engine type
+    def engine_type
+      "claude"
+    end
+
+    # calculate the number of tokens used
+    def get_num_tokens(text:)
+      text.split.length # TODO: hook up to token counting gem
+    end
+
+    # lookup the context size for a model by name
+    # @param modelname [String] The name of the model to lookup.
+    def modelname_to_contextsize(_modelname)
+      100000
+    end
+
+    # Calculate the maximum number of tokens possible to generate for a prompt.
+    # @param prompt_text [String] The prompt text to use.
+    # @return [Integer] the number of tokens possible to generate.
+    def max_tokens_for_prompt(prompt_text)
+      num_tokens = get_num_tokens(prompt_text)
+
+      # get max context size for model by name
+      max_size = modelname_to_contextsize(model_name)
+      max_size - num_tokens
+    end
+
+    def default_prefixes
+      { system: "Human: ", user: "Human: ", assistant: "Assistant: ", history: :history }
+    end
+  end
+end

data/lib/boxcars/engine/gpt4all_eng.rb

@@ -34,7 +34,7 @@ module Boxcars
       gpt4all = Gpt4all::ConversationalAI.new
       gpt4all.prepare_resources(force_download: false)
       gpt4all.start_bot
-      input_text = prompt.as_prompt(inputs)[:prompt]
+      input_text = prompt.as_prompt(inputs: inputs)[:prompt]
       Boxcars.debug("Prompt after formatting:\n#{input_text}", :cyan) if Boxcars.configuration.log_prompts
       gpt4all.prompt(input_text)
     rescue StandardError => e

data/lib/boxcars/engine/openai.rb

@@ -63,7 +63,7 @@ module Boxcars
         end
         clnt.chat(parameters: params)
       else
-        params = prompt.as_prompt(inputs).merge(params)
+        params = prompt.as_prompt(inputs: inputs).merge(params)
         Boxcars.debug("Prompt after formatting:\n#{params[:prompt]}", :cyan) if Boxcars.configuration.log_prompts
         clnt.completions(parameters: params)
       end

data/lib/boxcars/engine.rb

@@ -20,5 +20,6 @@ module Boxcars
 end
 
 require "boxcars/engine/engine_result"
+require "boxcars/engine/anthropic"
 require "boxcars/engine/openai"
 require "boxcars/engine/gpt4all_eng"

data/lib/boxcars/prompt.rb

@@ -19,9 +19,11 @@ module Boxcars
     # compute the prompt parameters with input substitutions (used for chatGPT)
     # @param inputs [Hash] The inputs to use for the prompt.
     # @return [Hash] The formatted prompt { messages: ...}
-    def as_prompt(inputs)
+    # rubocop:disable Lint/UnusedMethodArgument
+    def as_prompt(inputs: nil, prefixes: nil, show_roles: nil)
       { prompt: format(inputs) }
     end
+    # rubocop:enable Lint/UnusedMethodArgument
 
     # compute the prompt parameters with input substitutions
     # @param inputs [Hash] The inputs to use for the prompt.
@@ -39,6 +41,9 @@ module Boxcars
       new_prompt
     end
 
+    def default_prefixes
+    end
+
     private
 
     # format the prompt with the input variables

data/lib/boxcars/version.rb

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

data/lib/boxcars.rb

@@ -47,6 +47,11 @@ module Boxcars
       key_lookup(:serpapi_api_key, kwargs)
     end
 
+    # @return [String] The Anthropic API key either from arg or env.
+    def anthropic_api_key(**kwargs)
+      key_lookup(:anthropic_api_key, kwargs)
+    end
+
     private
 
     def check_key(key, val)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcars
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Francis Sullivan
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: anthropic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: google_search_results
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +101,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
 description: You simply set an OpenAI key, give a number of Boxcars to a Train, and
   magic ensues when you run it.
 email:
@@ -123,6 +137,7 @@ files:
 - lib/boxcars/boxcar/calculator.rb
 - lib/boxcars/boxcar/engine_boxcar.rb
 - lib/boxcars/boxcar/google_search.rb
+- lib/boxcars/boxcar/ruby_calculator.rb
 - lib/boxcars/boxcar/sql_active_record.rb
 - lib/boxcars/boxcar/sql_base.rb
 - lib/boxcars/boxcar/sql_sequel.rb
@@ -133,6 +148,7 @@ files:
 - lib/boxcars/conversation.rb
 - lib/boxcars/conversation_prompt.rb
 - lib/boxcars/engine.rb
+- lib/boxcars/engine/anthropic.rb
 - lib/boxcars/engine/engine_result.rb
 - lib/boxcars/engine/gpt4all_eng.rb
 - lib/boxcars/engine/openai.rb