func_bot 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93f6e105ec4bd586c7570f0400d9d25075c2d0504e81d2db43392196965d03f9
-  data.tar.gz: 0dc35e731b9f25a08ac0a664630a804c67c3019fa8e406df8445d707c7b154bc
+  metadata.gz: e2642f560765801d53e14efe88c613738759eb83c5ea65bac70696987eb38783
+  data.tar.gz: fc5683415acbaed9f68013aad668dbb180d1059b1496c514bcbcd05d5be6044c
 SHA512:
-  metadata.gz: bde8ef39474d86f7cf309ad37afb5c409e6dc87da0447ceec1252b1676360aa035418c66906b5e7a65fbe7e8906b73ddac3f6e7f4b7bfbe5d37e54917f905130
-  data.tar.gz: edefb12cb6eb69ff791c8db07703418e5bfe17f2a5284b8bfec8d457b1bb3c3d333c0c061f099a1d7dc285f9fec2c8c19d2193848f042a838515dd04a492be1c
+  metadata.gz: a17a9594c4a6ec3cdfbf31db3531afb2074e314fd092851c76d73fa41f221a3e03c35a183ef2a7a86618e15bbd20cd9ff7d642e5efb5dbb9c55e48495eef1165
+  data.tar.gz: 615b2b10f8c235b67dd7489ea3624a83c3b53a9b0eb57843d816d66dc1672a4c6692cfd615dd7c2238e3c62c5521093dfd32b8186c358fb595b7eedaca201499

data/README.md

@@ -1,6 +1,6 @@
 # FuncBot
 
-FuncBot is a Rails gem built on top of the [ruby-openai](https://github.com/alexrudall/ruby-openai) gem that allows you to easily create chatbots that can answer questions by calling on functions that you define.
+FuncBot is a Rails gem built on top of the [ruby-openai](https://github.com/alexrudall/ruby-openai) gem. It allows you to easily create chatbots that can answer questions by calling on functions you define. It's goal is to provide a simple interface to consume [OpenAI's Function Calling API](https://openai.com/blog/function-calling-and-other-api-updates?ref=upstract.com).
 
 ## Usage
 
@@ -10,7 +10,7 @@ FuncBot is a Rails gem built on top of the [ruby-openai](https://github.com/alex
 rails g func_bot:function <function_name>
 ```
 
-- Update the function in `lib/func_bot/functions/<function_name>.rb`
+- Update the function in `app/lib/func_bot/functions/<function_name>.rb`
 
   - A function can be as simple or as complex as you need it to be. Your bot will process the results and express them to the user.
   - All functions must have an `execute` method.
@@ -38,7 +38,7 @@ rails g func_bot:function <function_name>
     - `parsed_response` is a hash that contains the response relevant to your function from OpenAI.
     - `response` is the raw response from OpenAI.
 
-- Update your new function in the list of functions in `lib/func_bot/functions/list.yml`.
+- Update your new function in the list of functions in `app/lib/func_bot/functions/list.yml`.
   - This list of functions will be available to the bot with every request.
   - Adding good descriptions to the functions will help the bot infer when to use which function.
 - If the user asks a question that is not related to a function in your list, the bot will just ask ChatGPT.
@@ -80,6 +80,13 @@ rails g func_bot:install
 
 ```
 
+- Make sure to add your OpenAI API key to your credentials file or update the `config/initializers/openai.rb` file accordingly.
+
+```yml
+openai:
+  api_key: your-private-key
+```
+
 ## Testing
 
 ```bash

data/lib/func_bot/bots/client.rb

@@ -3,18 +3,26 @@
 module FuncBot
   module Bots
     class Client
-      def self.call(messages)
-        client.chat(
+      attr_accessor :bot
+
+      def initialize(bot)
+        @bot = bot
+      end
+
+      def call
+        open_ai.chat(
           parameters: {
             model: "gpt-3.5-turbo-0613",
-            messages: messages,
+            messages: bot.history.payload,
             temperature: 0.7,
-            functions: FuncBot::Functions::List.call
+            functions: FuncBot::Functions::List.call(bot)
           }
         )
       end
 
-      def self.client
+      private
+
+      def open_ai
         @client ||= OpenAI::Client.new
       end
     end

data/lib/func_bot/bots/history.rb

@@ -1,13 +1,18 @@
 module FuncBot
   module Bots
     class History
-      attr_accessor :history
+      attr_accessor :messages
+
       def initialize
-        @history = []
+        @messages = []
+      end
+
+      def chronicle(role, prompt, name = nil)
+        messages << Message.new(role, prompt, name)
       end
 
-      def push_prompt(role, prompt)
-        @history << Message.new(role, prompt).data
+      def payload
+        messages.map(&:data)
       end
     end
   end

data/lib/func_bot/bots/message.rb

@@ -1,19 +1,19 @@
 module FuncBot
   module Bots
     class Message
-      attr_accessor :role, :prompt, :name
+      attr_accessor :role, :content, :name
 
-      def initialize(role, prompt, name = nil)
+      def initialize(role, content, name = nil)
         @role = role
-        @prompt = prompt
+        @content = content
         @name = name
       end
 
       def data
         if name.nil?
-          {role: role, content: prompt}
+          {role: role, content: content}
         else
-          {role: role, content: prompt, name: name}
+          {role: role, content: content, name: name}
         end
       end
     end

data/lib/func_bot/functions/base_function.rb

@@ -3,14 +3,16 @@
 module FuncBot
   module Functions
     class BaseFunction
-      attr_reader :response
+      attr_reader :bot
 
-      def initialize(response)
-        @response = response
+      def initialize(bot)
+        @bot = bot
       end
 
       def parsed_response
-        JSON.parse(response.dig("choices", 0, "message", "function_call", "arguments"))
+        JSON.parse(
+          bot.response.dig("choices", 0, "message", "function_call", "arguments")
+        )
       end
     end
   end

data/lib/func_bot/functions/handler.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module FuncBot
+  module Functions
+    class Handler
+      attr_accessor :prompt, :bot
+
+      def initialize(bot)
+        @bot = bot
+      end
+
+      def handle
+        bot.history.chronicle("function", function_data, function_name)
+        bot.client.call
+      end
+
+      private
+
+      def function_data
+        constantize_function.new(bot).execute
+      end
+
+      def constantize_function
+        "FuncBot::Functions::#{function_name}".constantize
+      end
+
+      def function_name
+        bot.response.dig("choices", 0, "message", "function_call", "name")
+      end
+
+      def dig_for_content
+        bot.response.dig("choices", 0, "message", "content")
+      end
+    end
+  end
+end

data/lib/func_bot/functions/list.rb

@@ -3,11 +3,15 @@
 module FuncBot
   module Functions
     class List
-      def self.call
-        if File.exist?(Rails.root.join("lib", "func_bot", "functions", "list.yml"))
-          YAML.load_file(Rails.root.join("lib", "func_bot", "functions", "list.yml"))["functions"]
+      def self.call(bot)
+        if bot.include_functions
+          if File.exist?(Rails.root.join("app", "lib", "func_bot", "functions", "list.yml"))
+            YAML.load_file(Rails.root.join("app", "lib", "func_bot", "functions", "list.yml"))["functions"]
+          else
+            raise "app/lib/func_bot/functions/list.yml file not found. Please create it by running rails func_bot:install."
+          end
         else
-          raise "lib/func_bot/functions/list.yml file not found. Please create it by running rails func_bot:install."
+          []
         end
       end
     end

data/lib/func_bot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FuncBot
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/func_bot.rb

@@ -3,14 +3,40 @@ require "openai"
 require "func_bot/version"
 require "func_bot/engine"
 
-require_relative "func_bot/bot"
 require_relative "func_bot/bots/client"
 require_relative "func_bot/bots/history"
 require_relative "func_bot/bots/message"
 require_relative "func_bot/functions/base_function"
+require_relative "func_bot/functions/handler"
 require_relative "func_bot/functions/list"
-require_relative "func_bot/handlers/bot_handler"
-require_relative "func_bot/handlers/function_handler"
 
 module FuncBot
+  class Bot
+    attr_accessor :response, :include_functions
+    attr_reader :client, :history
+
+    def initialize
+      @history = Bots::History.new
+      @client = Bots::Client.new(self)
+      @include_functions = true
+    end
+
+    def ask(prompt)
+      history.chronicle("user", prompt)
+      self.response = client.call
+      self.response = Functions::Handler.new(self).handle if available_function?
+      history.chronicle("assistant", content)
+      history.messages.last.content
+    end
+
+    private
+
+    def available_function?
+      response.dig("choices", 0, "message", "function_call").present?
+    end
+
+    def content
+      response.dig("choices", 0, "message", "content")
+    end
+  end
 end

data/lib/generators/func_bot/function_generator.rb

@@ -3,7 +3,7 @@ module FuncBot
     source_root File.expand_path("templates", __dir__)
 
     def generate_function
-      template "function.rb", "lib/func_bot/functions/#{file_name}_function.rb"
+      template "function.rb", "app/lib/func_bot/functions/#{file_name}_function.rb"
     end
 
     def append_to_functions_list
@@ -15,22 +15,24 @@ module FuncBot
     private
 
     def yml_file
-      Rails.root.join("lib", "func_bot", "functions", "list.yml")
+      Rails.root.join("app", "lib", "func_bot", "functions", "list.yml")
     end
 
     def function_template
-      {name: "#{class_name}Function",
-       description: "TODO: Write a description for this function.",
-       parameters: {
-         type: "TODO: choose from string, integer, boolean, object, etc.",
-         properties: {
-           location: {
-             type: "TODO: Write a type for this parameter. e.g. string, integer, etc.",
-             description: "TODO: Write a description for this parameter."
-           }
-         },
-         required: ["TODO: list the required parameters here"]
-       }}
+      {
+        name: "#{class_name}Function",
+        description: "TODO: Write a description for this function.",
+        parameters: {
+          type: "TODO: choose from string, integer, boolean, object, etc.",
+          properties: {
+            location: {
+              type: "TODO: Write a type for this parameter. e.g. string, integer, etc.",
+              description: "TODO: Write a description for this parameter."
+            }
+          },
+          required: ["TODO: list the required parameters here"]
+        }
+      }
     end
   end
 end

data/lib/generators/func_bot/install_generator.rb

@@ -4,11 +4,8 @@ module FuncBot
 
     def move_files_to_lib
       copy_file "openai.rb", "config/initializers/openai.rb"
-      copy_file "list.yml", "lib/func_bot/functions/list.yml"
-      copy_file "weather_function.rb", "lib/func_bot/functions/weather_function.rb"
-      application do
-        "config.autoload_paths << Rails.root.join('lib')"
-      end
+      copy_file "list.yml", "app/lib/func_bot/functions/list.yml"
+      copy_file "weather_function.rb", "app/lib/func_bot/functions/weather_function.rb"
     end
   end
 end

data/lib/generators/func_bot/templates/weather_function.rb

@@ -7,6 +7,7 @@ module FuncBot
   module Functions
     class WeatherFunction < BaseFunction
       def execute
+        bot.include_functions = false
         weather_info = {
           location: parsed_response["location"],
           temperature: 98,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: func_bot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - lbp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -192,7 +192,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Extensible AI FuncBot with Function calls.
+description: FuncBot is a Rails gem built on top of the ruby-openai gem. It helps
+  you create chatbots that can answer questions by calling on functions you define.
+  It's goal is to provide a simple interface to consume OpenAI's Function Calling
+  API.
 email:
 - 43428385+leopolicastro@users.noreply.github.com
 executables: []
@@ -213,15 +216,13 @@ files:
 - config/initializers/openai.rb
 - config/routes.rb
 - lib/func_bot.rb
-- lib/func_bot/bot.rb
 - lib/func_bot/bots/client.rb
 - lib/func_bot/bots/history.rb
 - lib/func_bot/bots/message.rb
 - lib/func_bot/engine.rb
 - lib/func_bot/functions/base_function.rb
+- lib/func_bot/functions/handler.rb
 - lib/func_bot/functions/list.rb
-- lib/func_bot/handlers/bot_handler.rb
-- lib/func_bot/handlers/function_handler.rb
 - lib/func_bot/version.rb
 - lib/generators/func_bot/function_generator.rb
 - lib/generators/func_bot/install_generator.rb
@@ -255,5 +256,7 @@ requirements: []
 rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
-summary: Extensible AI FuncBot with Function calls.
+summary: FuncBot is a Rails gem built on top of the ruby-openai gem. It helps you
+  create chatbots that can answer questions by calling on functions you define. It's
+  goal is to provide a simple interface to consume OpenAI's Function Calling API.
 test_files: []

data/lib/func_bot/bot.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module FuncBot
-  class Bot
-    attr_accessor :role, :prompt
-
-    delegate :history, to: :@history
-
-    def initialize
-      @history = Bots::History.new
-    end
-
-    def ask(prompt)
-      @prompt = prompt
-      @role = "user"
-      handle_response(call_openai)
-    end
-
-    private
-
-    def call_openai
-      Bots::Client.call(chat_history)
-    end
-
-    def handle_response(response)
-      if function_call?(response)
-        Handlers::FunctionHandler.call(response, history)
-      else
-        Handlers::BotHandler.call(response, history)
-      end
-    end
-
-    def function_call?(response)
-      response.dig("choices", 0, "message", "function_call").present?
-    end
-
-    def chat_history
-      @history.push_prompt(role, prompt)
-    end
-  end
-end

data/lib/func_bot/handlers/bot_handler.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module FuncBot
-  module Handlers
-    class BotHandler
-      class << self
-        def call(response, history)
-          history << Bots::Message.new("assistant", dig_for_content(response)).data
-          dig_for_content(response)
-        end
-
-        private
-
-        def dig_for_content(response)
-          response.dig("choices", 0, "message", "content")
-        end
-      end
-    end
-  end
-end

data/lib/func_bot/handlers/function_handler.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module FuncBot
-  module Handlers
-    class FunctionHandler
-      attr_accessor :prompt, :history
-
-      class << self
-        def call(response, history)
-          @function_name = nil
-          @history = history
-          function_return = constantize_function(response).new(response).execute
-          response = respond_to(function_return)
-          history << Bots::Message.new("assistant", dig_for_content(response)).data
-          dig_for_content(response)
-        end
-
-        def constantize_function(response)
-          "FuncBot::Functions::#{function_name(response)}".constantize
-        end
-
-        def function_name(response = {})
-          @function_name ||= response.dig("choices", 0, "message", "function_call", "name")
-        end
-
-        def dig_for_content(response)
-          response.dig("choices", 0, "message", "content")
-        end
-
-        def respond_to(prompt)
-          @prompt = prompt
-          Bots::Client.call(messages)
-        end
-
-        def messages
-          @history << Bots::Message.new("function", @prompt, function_name).data
-        end
-      end
-    end
-  end
-end