react_ai 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3aacc461fe13509ef3fa146423501596363d0c548a5311fd1af303ffff16d0af
+  data.tar.gz: 43ebb709bb580d16eb020669b9937653e16cdd45e4d23d66acd9e1606c8d6ca4
+SHA512:
+  metadata.gz: 71931954621b173c64bc230f78d0aad183804aea0635f3ffe60c3110d5247ed35265f4fa966be5dc3fb211534fbb1265b87d5d33386c0471ba670c6e7df491ae
+  data.tar.gz: 83cc6afbefd787d7b1552cd2e8bcc3e5dd4825f1d27a07eeb234dac0da0f045a8f73c9feaa4dc3f3b0b4a55a93046fc7b406857c4edbbfac73591bec097db8dd

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+
+
+## [0.0.2] - 2024-01-08
+- Add the ability to search wikipedia as a tool.
+
+## [0.0.1] - 2023-11-24
+
+- Add an implmentation of ReAct that implements the calculator tool in a naive way. 

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in react_ai.gemspec
+gemspec
+
+gem "rake"
+gem "minitest"
+gem "standard"

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    react_ai (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    minitest (5.20.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rubocop (1.56.4)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      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.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.31.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.56.4)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.2.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.19.1)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  minitest
+  rake
+  react_ai!
+  standard
+
+BUNDLED WITH
+   2.3.26

data/README.md

@@ -0,0 +1,47 @@
+# ReactAi
+
+Welcome to ```react_ai``` a gemified version of [my attempt to recreate the ReAct pattern in Ruby](https://github.com/thedayisntgray/Ruby-ReAct-Agent) with added features.
+
+## Purpose
+
+The [ReAct pattern](https://arxiv.org/abs/2210.03629) is a technique used to circumvent the limitation LLMs have of only being able to respond past the date they were trained. We do this by prompting our LLM to use tools that we can define for it. Another advantage of using tools is that we can reduce hallucinations and therefore improve accuracy of LLM responses.
+
+## Features
+
+### Tools
+- Calculator
+- Wikipedia
+
+### CLI 
+- A simple CLI tool to test prompts
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add react_ai
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install react_ai
+
+Create a ```.env``` file in the root directory and add your open-ai key and your're ready to go!🔥
+
+```
+OPEN_AI_KEY='your open ai key'
+```
+
+## Usage
+
+You can use this gem via the commmand line after it is installed by typing:
+
+```./exe/react_ai "Some prompt for our LLM!"```
+
+Here's an example of what a user prompt and subsequent response might look like:
+
+
+https://github.com/thedayisntgray/react_ai/assets/4859128/bbc6cba8-914b-4d6a-9a45-77e819acaec2
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thedayisntgray/react_ai.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/exe/react_ai

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "react_ai"
+
+ReactAi::Cli.new(ARGV).run

data/lib/react_ai/cli.rb

@@ -0,0 +1,12 @@
+module ReactAi
+  class Cli
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def run
+      input = @argv.join(" ")
+      puts ReactAi::Agent.new.query(input, 5)
+    end
+  end
+end

data/lib/react_ai/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ReactAi
+  VERSION = "0.0.2"
+end

data/lib/react_ai.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "dotenv/load"
+require "openai"
+require_relative "react_ai/cli"
+require_relative "react_ai/version"
+
+module ReactAi
+  class Error < StandardError; end
+
+  class Agent
+    def initialize(agent_prompt: "You run in a loop of Thought, Action, PAUSE, Observation.
+      At the end of the loop you output an Answer
+      Use Thought to describe your thoughts about the question you have been asked.
+      Use Action to run one of the actions available to you - then return PAUSE.
+      Observation will be the result of running those actions.
+
+      Your available actions are:
+
+      calculate:
+      e.g. calculate: 4 * 7 / 3
+      Runs a calculation and returns the number - uses Ruby so be sure to use floating point syntax if necessary
+
+      wikipedia:
+      e.g. wikipedia: Ruby On Rails
+      Returns a summary from searching Wikipedia
+
+      Always look things up on Wikipedia if you have the opportunity to do so.
+
+      Example session:
+
+      Question: What is the capital of France?
+      Thought: I should look up France on Wikipedia
+      Action: wikipedia: France
+      PAUSE
+
+      You will be called again with this:
+
+      Observation: France is a country. The capital is Paris.
+
+      You then output:
+
+      Answer: The capital of France is Paris")
+      @client = OpenAI::Client.new(access_token: ENV["OPEN_AI_KEY"])
+      @messages = []
+
+      @known_actions = [
+        "wikipedia",
+        "calculate"
+      ]
+
+      unless agent_prompt.nil?
+        @messages << {"role" => "system", "content" => agent_prompt}
+      end
+    end
+
+    def query(question, max_iterations)
+      next_prompt = question
+      max_iterations.times do |i|
+        result = execute(next_prompt)
+        print result
+        actions = result.split("\n").map { |a| /^Action: (\w+): (.*)$/.match(a) }.compact.first
+
+        if actions
+          tool = actions[1]
+          action_input = actions[2]
+
+          unless @known_actions.include?(tool)
+            raise "Unknown Action: #{tool}"
+          end
+          puts " -- running #{tool} #{action_input}"
+          observation = send(tool, action_input)
+          puts "Observation: #{observation}"
+          next_prompt = "Observation: #{observation}"
+
+        else
+          return # standard:disable Lint/NonLocalExitFromIterator
+        end
+      end
+    end
+
+    def calculate(expr)
+      # consider integrating dentaku instead of using eval() which is unsafe
+      # https://github.com/rubysolo/dentaku
+      eval(expr)
+    end
+
+    def wikipedia(query)
+      uri = URI("https://en.wikipedia.org/w/api.php")
+      params = {action: "query", list: "search", srsearch: query, format: "json"}
+      uri.query = URI.encode_www_form(params)
+      res = Net::HTTP.get_response(uri)
+      JSON.parse(res.body)["query"]["search"][0]["snippet"]
+    end
+
+    def execute(question)
+      @messages << {"role" => "user", "content" => question}
+      response = @client.chat(
+        parameters: {
+          model: "gpt-3.5-turbo",
+          messages: @messages
+        }
+      )
+
+      result = response.dig("choices").first.dig("message").dig("content")
+      @messages << {"role" => "assistant", "content" => result}
+      result
+    end
+  end
+end

data/react_ai.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/react_ai/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "react_ai"
+  spec.version = ReactAi::VERSION
+  spec.authors = ["Landon Gray"]
+  spec.email = ["thedayisntgray@gmail.com"]
+
+  spec.summary = "ReAct is an llm prompting pattern that enables an LLM to take actions such as searching the web or using a calculator."
+  spec.homepage = "https://github.com/thedayisntgray/react_ai"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/react_ai.rbs

@@ -0,0 +1,4 @@
+module ReactAi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: react_ai
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Landon Gray
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-09 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- thedayisntgray@gmail.com
+executables:
+- react_ai
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- exe/react_ai
+- lib/react_ai.rb
+- lib/react_ai/cli.rb
+- lib/react_ai/version.rb
+- react_ai.gemspec
+- sig/react_ai.rbs
+homepage: https://github.com/thedayisntgray/react_ai
+licenses: []
+metadata:
+  homepage_uri: https://github.com/thedayisntgray/react_ai
+  source_code_uri: https://github.com/thedayisntgray/react_ai
+  changelog_uri: https://github.com/thedayisntgray/react_ai/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: ReAct is an llm prompting pattern that enables an LLM to take actions such
+  as searching the web or using a calculator.
+test_files: []