ruby_bots 0.0.23 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f033f968d4ac24541d10ae38913ea8752d1c6a08c538b3bab6716bcd72365e7a
-  data.tar.gz: c1f905d49c704475e7c96f0ab8957ac78cf422fc6fdfd38e0b15c0a2e3fe4671
+  metadata.gz: 7500351293df6637a79657ff218f06faa376a9a35104e11cf8d7f232af2de1d0
+  data.tar.gz: 1fbcb4915525bc159649c098ae66c02cdb41a1ae15941e709d5073327026559a
 SHA512:
-  metadata.gz: b361259f543091c9a252419bcbe9d07a839b4b92249f790d58e8f09c7d421e62225d1e4f704d5dbad2932fb436f3668215c8e4f863550d2802475c00d776b46b
-  data.tar.gz: 011546a87f231642929daaf6a6edcd9a483da7961992958f30a0dfa8f402125c843860466c270407986c665d1a0e557a1e21652a543175374991cee1f68741b7
+  metadata.gz: b76904f26db1b284a6ebc7cd262dcc9d86276afaead350bff6f61964b633d05314f857f3128996b8395fc7cd2df04eab796af9fd81cfef0a43008625d86f89e7
+  data.tar.gz: e685e6fa6df00ceb1c89bceeadf15a2ca06f8ebac02b1b5f7941fbedfbedf98ca5ad0093c300707d25a5fef26203fcc990ccc9339817b9ee260d56bdb80e8790

data/lib/ruby_bots/bot.rb

@@ -1,10 +1,11 @@
 module RubyBots
+  # Base class for all RubyBots bots
   class Bot < Tool
     attr_accessor :tools
 
-    def initialize(name:, description:, tools:)
+    def initialize(tools:, name: 'RubyBots Bot', description: 'This is a RubyBots bot')
       @tools = tools
-      super(name: name, description: description)
+      super(name:, description:)
     end
 
     private
@@ -12,5 +13,9 @@ module RubyBots
     def run(input)
       raise NotImplementedError
     end
+
+    def tool_name?(param)
+      errors << 'invalid tool name' unless @tools.map(&:name).include?(param)
+    end
   end
-end
+end

data/lib/ruby_bots/bots/openai_bot.rb

@@ -1,38 +1,45 @@
 module RubyBots
+  # Bot class for OpenAI. This will use open AI to determine which tool to use for the response.
   class OpenAIBot < OpenAITool
     attr_accessor :tools
 
-    DEFAULT_DESCRIPTION = "This bot will use OpenAI to determine the appropriate tool."
-    
-    def initialize(name: "OpenAI bot", description: DEFAULT_DESCRIPTION, tools:)
+    validate_output :tool_name?
+
+    DEFAULT_DESCRIPTION = 'This bot will use OpenAI to determine the appropriate tool.'.freeze
+
+    def initialize(tools:, name: 'OpenAI bot', description: DEFAULT_DESCRIPTION)
       @tools = tools
-      super(name: name, description: description)
+      super(name:, description:)
     end
 
     def system_instructions
       <<~PROMPT
-      You are an assistant designed to select a tool for a user to use. You are provided with the user's input.
-      Select from the following tools (name - description):
-      #{tools.map{|t| t.name + " - " + t.description}.join("\n")}
+        You are an assistant designed to select a tool for a user to use. You are provided with the user's input.
+        Select from the following tools (name - description):
+        #{tools.map { |t| "#{t.name} - #{t.description}" }.join('\n')}
 
-      Return only the name of the tool that best fits the user's request.
-      If no tools match the user's request respond with "no tool" and nothing more.
+        Return only the name of the tool that best fits the user's request.
+        If no tools match the user's request respond with "no tool" and nothing more.
       PROMPT
     end
 
     private
-    
+
     def run(input)
       params = {
         messages: [
           { role: :system, content: system_instructions },
           { role: :user, content: input }
         ]
-      }.merge(default_params) 
+      }.merge(default_params)
 
       response = client.chat(parameters: params)
 
-      response.dig("choices", 0, "message", "content")
+      response.dig('choices', 0, 'message', 'content')
+    end
+
+    def tool_name?(param)
+      errors << 'invalid tool name' unless @tools.map(&:name).include?(param)
     end
   end
-end
+end

data/lib/ruby_bots/bots/openai_react_bot.rb

@@ -1,126 +1,129 @@
 module RubyBots
+  # This bot uses the ReAct framework to select from the provide tools and respond to the user.
+  # The input from the tools that are called by the bot are fed back into the messages as observations.
   class OpenAIReactBot < OpenAIBot
     attr_accessor :tools
 
-    DEFAULT_DESCRIPTION = "This bot will use the ReAct framework to determine the appropriate response. It is powered by OpenAI and the ReAct framework."
-    
-    DEFAULT_TOOLS = [
-      RubyBots::Tool.new(name:"search", description:"Search the web for information. Input should be the string to search for."),
-      RubyBots::Tool.new(name:"calculate", description:"Solve math problems. Input should be a mathematical expression with no additional details or context."),
-    ]
+    DEFAULT_DESCRIPTION = <<~DESCRIPTION.strip_heredoc
+      This bot will use the ReAct framework to determine the appropriate response. It is powered by OpenAI and the ReAct framework.
+    DESCRIPTION
 
-    def initialize(name: "OpenAI ReAct bot", description: DEFAULT_DESCRIPTION, tools: DEFAULT_TOOLS)
-      @tools = tools
-      super(name: name, description: description)
+    DEFAULT_TOOLS = [
+      RubyBots::Tool.new(
+        name: 'search',
+        description: 'Search the web for information. Input should be the string to search for.'
+      ),
+      RubyBots::Tool.new(
+        name: 'calculate',
+        description: <<~DESC.strip_heredoc
+          Solve math problems. Input should be a mathematical expression with no additional details or context.
+        DESC
+      )
+    ].freeze
+
+    def initialize(tools: DEFAULT_TOOLS, name: 'OpenAI ReAct bot', description: DEFAULT_DESCRIPTION)
+      super(tools:, name:, description:)
     end
 
     def examples
-      [ EXAMPLE_ONE, EXAMPLE_TWO, EXAMPLE_THREE ]
+      [EXAMPLE_ONE, EXAMPLE_TWO]
     end
 
-    
-    EXAMPLE_ONE = <<~EXAMPLE
-    User: What is the current temperature in the city Julia Roberts was born in?
-    Thought: I need to know where Julia Roberts was born.
-    Action: search[Julia Roberts birthplace]
-    Observation: Smyrna, Georgia
-    Thought: I need to know the current temperature in Smyrna, Georgia.
-    Action: search[current temperature Smyrna, Georgia]
-    Observation: 72 degrees Fahrenheit
-    Thought: I need to tell the user the current temperature in the city Julia Roberts was born in.
-    Answer: 72 degrees Fahrenheit
+    EXAMPLE_ONE = <<~EXAMPLE.strip_heredoc
+      User: What is the current temperature in the city Julia Roberts was born in?
+      Thought: I need to know where Julia Roberts was born.
+      Action: search[Julia Roberts birthplace]
+      Observation: Smyrna, Georgia
+      Thought: I need to know the current temperature in Smyrna, Georgia.
+      Action: search[current temperature Smyrna, Georgia]
+      Observation: 72 degrees Fahrenheit
+      Thought: I need to tell the user the current temperature in the city Julia Roberts was born in.
+      Answer: 72 degrees Fahrenheit
     EXAMPLE
-  
-    EXAMPLE_TWO = <<~EXAMPLE
-    User: What is the square of the age of Albert Einstein at his death?
-    Thought: I need to know the age of Albert Einstein at his death.
-    Action: search[Albert Einstein age at death]
-    Observation: 76 years old
-    Thought: I need to know the square of 76.
-    Action: calculate[76^2]
-    Observation: 5776
-    Thought: I need to tell the user the square of the age of Albert Einstein at his death.
-    Answer: 5776
-    EXAMPLE
-  
-    EXAMPLE_THREE = <<~EXAMPLE
-    User: What is half of the amount of years that have passed since the year the first airplane flew?
-    Thought: I need to know the year the first airplane flew.
-    Action: search[first airplane flight year]
-    Observation: 1903
-    Thought: I need to know the current year.
-    Action: search[current year]
-    Observation: 2023
-    Thought: I need to know the amount of years that have passed since 1903.
-    Action: calculate[2023 - 1903]
-    Observation: 120
-    Thought: I need to know half of 120.
-    Action: calculate[120 / 2]
-    Observation: 60
-    Thought: I need to tell the user half of the amount of years that have passed since the year the first airplane flew.
-    Answer: 60
+
+    EXAMPLE_TWO = <<~EXAMPLE.strip_heredoc
+      User: What is half of the amount of years that have passed since the year the first airplane flew?
+      Thought: I need to know the year the first airplane flew.
+      Action: search[first airplane flight year]
+      Observation: 1903
+      Thought: I need to know the current year.
+      Action: search[current year]
+      Observation: 2023
+      Thought: I need to know the amount of years that have passed since 1903.
+      Action: calculate[2023 - 1903]
+      Observation: 120
+      Thought: I need to know half of 120.
+      Action: calculate[120 / 2]
+      Observation: 60
+      Thought: I need to tell the user half of the amount of years that have passed since the year the first airplane flew.
+      Answer: 60
     EXAMPLE
 
+    def prefix
+      <<~PROMPT.strip_heredoc
+        You are an assistant designed to provide solutions for a user. You are provided with the user's input.
+      PROMPT
+    end
+
+    def suffix
+      ''
+    end
+
     def system_instructions
       <<~PROMPT
-      You are an assistant designed to provide solutions for a user. You are provided with the user's input.
-      You run in a loop of thought, action, observation, and reflection until you have a solution for the user.
-      You can utilize the following actions to gather more information (name - description):
-      #{ tools.map{ |t| t.name + " - " + t.description }.join("\n") }
+        #{prefix}
+
+        You run in a loop of thought, action, observation, and reflection until you have a solution for the user.
+        You can utilize the following actions (name - description):
+        #{tools.map { |t| "#{t.name} - #{t.description}" }.join("\n")}
+
+        You should begin by providing a thought and an action with the necessary input for the action. The action will be executed externally, and then you will be called again with the observation returned from the action.
+
+        You should then begin the loop again and provide a thought and action.
 
-      You should begin by providing a thought and an action with the necessary input for the action. The action will be
-      executed externally, and then you will be called again with the observation returned from the action.
-      
-      You should then begin the loop again and provide a thought and action.
+        If you have a solution for the user, return the solution instead of a new action.
+        The final answer should only answer the question without additional information about reasoning or process.
 
-      If you have a solution for the user, return the solution instead of a new action.
-      The final answer should only answer the question without additional information about reasoning or process.
+        #{suffix}
 
-      Examples:
-      #{ examples.join("\n\n") }
+        Examples:
+        #{examples.join("\n\n")}
       PROMPT
     end
 
     private
-    
-    def run(input)
-      params = {
-        messages: [
-          { role: :system, content: system_instructions },
-          { role: :user, content: input }
-        ]
-      }.merge(default_params) 
 
-      response = client.chat(parameters: params)
-      response = response.dig("choices", 0, "message", "content")
+    def run(input)
+      params = initial_params(input)
 
-      while !is_answer?(response)
+      until answer?(response = client.chat(parameters: params).dig('choices', 0, 'message', 'content'))
         params[:messages] << { role: :assistant, content: response }
-
-        observation = get_observation_from_action(response)
-
-        params[:messages] << { role: :assistant, content: "Observation: #{observation}" }
-
-        response = client.chat(parameters: params)
-
-        response = response.dig("choices", 0, "message", "content")
+        params[:messages] << { role: :assistant, content: "Observation: #{get_observation_from_action(response)}" }
       end
-
       get_answer_from_response(response)
     end
 
-    def is_answer?(input)
+    def initial_params(input)
+      {
+        messages: [
+          { role: :system, content: system_instructions },
+          { role: :user, content: input }
+        ]
+      }.merge(default_params)
+    end
+
+    def answer?(input)
       input.match(/Answer: /)
     end
 
     def get_observation_from_action(response)
-      t = response.match(/Action: ([\s\S]*)/)[1]
-      tool_name = t.match(/([a-zA-Z\-\_]*)\[([\s\S]*)\]/)[1]
-      tool_input = t.match(/([a-zA-Z\-\_]*)\[([\s\S]*)\]/)[2]
+      tool_string = response.match(/Action: ([\s\S]*)/)[1]
+      tool_name = tool_string.match(/([a-zA-Z_\- ]*)\[([\s\S]*)\]/)[1]
+      tool_input = tool_string.match(/([a-zA-Z_\- ]*)\[([\s\S]*)\]/)[2]
 
       notify_observers(:action, tool_name, tool_input)
 
-      tool = tools.find{|t| t.name == tool_name}
+      tool = tools.find { |t| t.name == tool_name }
 
       tool.response(tool_input)
     end

data/lib/ruby_bots/bots/pipeline_bot.rb

@@ -1,13 +1,18 @@
 module RubyBots
+  # Class to provide a pipeline of tools to solve a problem.
+  # This bot will call the tools provided in order until each tool has responded.
+  # The bot will respond with the last tool's response.
   class PipelineBot < Bot
-    DEFAULT_DESCRIPTION = "This bot will utilize all of its tools in a syncronouse pipeline based on the order the tools are provided."
-    
-    def initialize(name: "Pipeline bot", description: DEFAULT_DESCRIPTION, tools:)
-      super(name: name, description: description, tools: tools)
+    DEFAULT_DESCRIPTION = <<~DESCRIPTION.strip_heredoc
+      This bot will utilize all of its tools in a syncronouse pipeline based on the order the tools are provided."
+    DESCRIPTION
+
+    def initialize(tools:, name: 'Pipeline bot', description: DEFAULT_DESCRIPTION)
+      super(tools:, name:, description:)
     end
 
     private
-      
+
     def run(input)
       tools.each do |tool|
         input = tool.run(input)
@@ -16,4 +21,4 @@ module RubyBots
       input
     end
   end
-end
+end

data/lib/ruby_bots/bots/router_bot.rb

@@ -1,41 +1,49 @@
 module RubyBots
+  # Class to provide a router to different tools.
+  # This bot connects to the OpenAI API and uses gpt-4 by default to choose a proper tool to route the user's input.
+  # The bot will only select and use one tool by default.
   class RouterBot < OpenAIBot
-    DEFAULT_DESCRIPTION = "This bot will route the user's input to the appropriate tool. It will only select and use one tool."
-    
-    def initialize(name: "Router bot", description: DEFAULT_DESCRIPTION, tools:)
-      super(name: name, description: description, tools: tools)
+    DEFAULT_DESCRIPTION = <<~DESCRIPTION.strip_heredoc
+      This bot will route the user's input to the appropriate tool. It will only select and use one tool."
+    DESCRIPTION
+
+    def initialize(tools:, name: 'Router bot', description: DEFAULT_DESCRIPTION)
+      super(tools:, name:, description:)
     end
 
     def system_instructions
       <<~PROMPT
-      You are an assistant helping to route a user's input to the correct tool.
-      You can use the following tools (name - description):
-      #{tools.map{|t| t.name + " - " + t.description}.join("\n")}
+        You are an assistant helping to route a user's input to the correct tool.
+        You can use the following tools (name - description):
+        #{tools.map { |t| "#{t.name} - #{t.description}" }.join('\n')}
 
-      Return only the name of the tool that best fits the user's request.
-      If no tools match the user's request respond with "I'm sorry, I am still learning." and nothing more.
+        Return only the name of the tool that best fits the user's request.
       PROMPT
     end
 
     private
-      
+
     def run(input)
-      params = {
+      params = initial_params(input)
+
+      response = client.chat(parameters: params)
+
+      response_text = response.dig('choices', 0, 'message', 'content')
+
+      selected_tool = tools.find { |t| t.name == response_text }
+
+      raise RubyBots::InvalidOutputError, 'invalid tool name' unless selected_tool
+
+      selected_tool.response(input)
+    end
+
+    def initial_params(input)
+      {
         messages: [
           { role: :system, content: system_instructions },
           { role: :user, content: input }
         ]
-      }.merge(default_params) 
-
-      response = client.chat(parameters: params)
-        
-      response_text = response.dig("choices", 0, "message", "content")
-      selected_tool = tools.find{|t| t.name == response_text}
-      if selected_tool
-        selected_tool.response(input)
-      else
-        response_text
-      end
+      }.merge(default_params)
     end
   end
-end
+end

data/lib/ruby_bots/tool.rb

@@ -1,4 +1,5 @@
 module RubyBots
+  # Base class for all RubyBots tools and bots
   class Tool
     attr_accessor :name, :description, :errors
 
@@ -23,41 +24,45 @@ module RubyBots
     end
 
     def response(input)
+      run_input_validations(input)
+
+      raise RubyBots::InvalidInputError, { errors: @errors } if @errors.any?
+
+      output = run(input)
+
+      run_output_validations(output)
+
+      raise RubyBots::InvalidOutputError, { errors: @errors } if @errors.any?
+
+      output
+    end
+
+    private
+
+    def run(input)
+      raise NotImplementedError
+    end
+
+    def run_input_validations(input)
       self.class.input_validators ||= []
       self.class.input_validators.each do |validator|
         send(validator, input)
       end
-      
-      if @errors.empty?
-        output = run(input)
-      else
-        raise RubyBots::InvalidInputError.new(errors: @errors)
-      end
-      
+    end
+
+    def run_output_validations(output)
       self.class.output_validators ||= []
       self.class.output_validators.each do |validator|
         send(validator, output)
       end
-
-      if @errors.any?
-        raise RubyBots::InvalidOutputError.new(errors: @errors)
-      end
-
-      output
-    end
-    
-    private 
-
-    def run(input)
-      raise NotImplementedError
     end
 
-    def is_json(param)
+    def json?(param)
       JSON.parse(param)
     rescue JSON::ParserError
-      errors << "invalid JSON"
+      errors << 'invalid JSON'
     rescue TypeError
-      errors << "value is not a String"
+      errors << 'value is not a String'
     end
   end
-end
+end

data/lib/ruby_bots/tools/openai_tool.rb

@@ -1,41 +1,43 @@
 require 'openai'
 
 module RubyBots
+  # Tool for connecting to Open AI. Use this tool to connect to Open AI and get a response.
+  # the default model is gpt-4, it can be altered by overriding the default_params method.
   class OpenAITool < Tool
-    DEFAULT_DESCRIPTION = "This tool will use open ai to determine the output."
-  
-    def initialize(name: "OpenAI Tool", description: DEFAULT_DESCRIPTION)
-      super(name: name, description: description)
+    DEFAULT_DESCRIPTION = 'This tool will use open ai to determine the output.'.freeze
+
+    def initialize(name: 'OpenAI Tool', description: DEFAULT_DESCRIPTION)
+      super(name:, description:)
     end
-  
+
     def client
       @client ||= OpenAI::Client.new(access_token: RubyBots.config.openai_api_key)
     end
-  
+
     def default_params
       {
         model: 'gpt-4',
         temperature: 0
       }
     end
-  
+
     def system_instructions
-      "You are a helpful assistant."
+      'You are a helpful assistant.'
     end
 
     private
-    
+
     def run(input)
       params = {
         messages: [
           { role: :system, content: system_instructions },
           { role: :user, content: input }
         ]
-      }.merge(default_params) 
-  
+      }.merge(default_params)
+
       response = client.chat(parameters: params)
-      
-      response.dig("choices", 0, "message", "content")
+
+      response.dig('choices', 0, 'message', 'content')
     end
   end
-end
+end

data/lib/ruby_bots/tools/wolfram_tool.rb

@@ -3,14 +3,15 @@ require 'uri'
 require 'net/http'
 
 module RubyBots
+  # This tool provides an interface to get responses from the Wolfram Alpha API.
+  # This tool requires an App ID key from Wolfram Alpha.
+  # add it to your environment variables as WOLFRAM_APP_ID
+  # it is currently alpha and not fully working or tested.
   class WolframTool < Tool
-    # This tool requires an App ID key from Wolfram Alpha.
-    # add it to your environment variables as WOLFRAM_APP_ID
+    DEFAULT_DESCRIPTION = 'This tool will use the Wolfram Alpha API to answer questions.'.freeze
 
-    DEFAULT_DESCRIPTION = "This tool will use the Wolfram Alpha API to answer questions."
-
-    def initialize(name: "Wolfram tool", description: DEFAULT_DESCRIPTION)
-      super(name: name, description: description)
+    def initialize(name: 'Wolfram tool', description: DEFAULT_DESCRIPTION)
+      super(name:, description:)
     end
 
     private
@@ -21,4 +22,4 @@ module RubyBots
       resp.body
     end
   end
-end
+end

data/lib/ruby_bots/version.rb

@@ -1,3 +1,3 @@
 module RubyBots
-  VERSION = "0.0.23".freeze
-end
+  VERSION = '0.0.25'.freeze
+end

data/lib/ruby_bots.rb

@@ -1,3 +1,4 @@
+# Main module for RubyBots
 module RubyBots
   class << self
     def config
@@ -9,11 +10,13 @@ module RubyBots
     end
   end
 
+  # Configuration class
   class Configuration
     attr_accessor :openai_api_key
-    def initialize()
-      @openai_api_key = ENV["OPENAI_ACCESS_TOKEN"]
-      @wolfram_app_id = ENV["WOLFRAM_APPID"]
+
+    def initialize
+      @openai_api_key = ENV['OPENAI_ACCESS_TOKEN']
+      @wolfram_app_id = ENV['WOLFRAM_APPID']
     end
   end
 
@@ -24,16 +27,27 @@ module RubyBots
   def self.tool
     RubyBots::Tool
   end
-  
+
   class Error < StandardError; end
   class InvalidInputError < Error; end
   class InvalidOutputError < Error; end
 end
 
-require_relative "ruby_bots/tool"
-require_relative "ruby_bots/bot"
-require_relative "ruby_bots/tools/openai_tool.rb"
-require_relative "ruby_bots/bots/openai_bot.rb"
-require_relative "ruby_bots/bots/pipeline_bot.rb"
-require_relative "ruby_bots/bots/router_bot.rb"
-require_relative "ruby_bots/bots/openai_react_bot.rb"
+class String
+  def strip_heredoc
+    gsub(/^#{scan(/^[ \t]*(?=\S)/).min}/, ''.freeze)
+  end
+end
+
+# tools
+require_relative 'ruby_bots/tool'
+require_relative 'ruby_bots/tools/openai_tool'
+
+# bots
+require_relative 'ruby_bots/bot'
+require_relative 'ruby_bots/bots/openai_bot'
+require_relative 'ruby_bots/bots/pipeline_bot'
+require_relative 'ruby_bots/bots/router_bot'
+require_relative 'ruby_bots/bots/openai_react_bot'
+
+require_relative 'ruby_bots/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_bots
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.25
 platform: ruby
 authors:
 - Justin Paulson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-13 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -114,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="