func_bot 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2642f560765801d53e14efe88c613738759eb83c5ea65bac70696987eb38783
-  data.tar.gz: fc5683415acbaed9f68013aad668dbb180d1059b1496c514bcbcd05d5be6044c
+  metadata.gz: 3c00ad5a2b3aea12bced2b60da8ffe88910c0413ba5a56163f8f08dee540b3e0
+  data.tar.gz: 2c91552073019309fc23ae95046763143f1a7f403bd9ee78493201303fe9a592
 SHA512:
-  metadata.gz: a17a9594c4a6ec3cdfbf31db3531afb2074e314fd092851c76d73fa41f221a3e03c35a183ef2a7a86618e15bbd20cd9ff7d642e5efb5dbb9c55e48495eef1165
-  data.tar.gz: 615b2b10f8c235b67dd7489ea3624a83c3b53a9b0eb57843d816d66dc1672a4c6692cfd615dd7c2238e3c62c5521093dfd32b8186c358fb595b7eedaca201499
+  metadata.gz: 3397880c0ff9482c56653bc3f9b552cdd747f946d13e5091dffa5cc004127506e1c49b2a409daf03c1699fd6368f884d42fd07c4f1fa9b0ca546ea17127c5923
+  data.tar.gz: d7139064f6ec1dd6546356be3ff93a2a31a0c12307d426e0ffe686db40fca419564d944c30d426cb03d26f093918df411a10d7503f6cdf1f825f63917ad5f880

data/README.md

@@ -37,6 +37,26 @@ rails g func_bot:function <function_name>
   - The `parsed_response` and `response` methods are available to all functions.
     - `parsed_response` is a hash that contains the response relevant to your function from OpenAI.
     - `response` is the raw response from OpenAI.
+  - Functions also have access to the `bot` attribute which returns the instance of the bot that called the function.
+
+    - This is useful if you need to access the bot's history or other methods.
+    - There might be times when you need to ask gpt a question from within a function, but you don't want to trigger the function again. You can set the `bot.include_functions` attribute to false before asking the question and then set it back to true after.
+
+    ```ruby
+    module FuncBot
+      module Functions
+        class SomeFunction < BaseFunction
+          def execute
+            bot.include_functions = false
+            response = bot.ask "Some question that you don't want to trigger any functions for"
+            bot.include_functions = true
+            do_something_with_response(response)
+            ....
+          end
+        end
+      end
+    end
+    ```
 
 - 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.

data/lib/func_bot/bots/client.rb

@@ -11,17 +11,26 @@ module FuncBot
 
       def call
         open_ai.chat(
-          parameters: {
-            model: "gpt-3.5-turbo-0613",
-            messages: bot.history.payload,
-            temperature: 0.7,
-            functions: FuncBot::Functions::List.call(bot)
-          }
+          parameters: chat_params
         )
       end
 
       private
 
+      def chat_params
+        params = {
+          model: "gpt-3.5-turbo-0613",
+          messages: bot.history.payload,
+          temperature: 0.7
+        }
+        params.merge!(function_params) if bot.include_functions
+        params
+      end
+
+      def function_params
+        {functions: FuncBot::Functions::List.call}
+      end
+
       def open_ai
         @client ||= OpenAI::Client.new
       end

data/lib/func_bot/functions/list.rb

@@ -3,15 +3,11 @@
 module FuncBot
   module Functions
     class List
-      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
+      def self.call
+        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
       end
     end

data/lib/func_bot/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: func_bot
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - lbp