func_bot 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68e7cc778676e7b037cff5572cd69c2f61559763fd57b8e31328f487fa839148
-  data.tar.gz: cb9ca4334b4c08384216a03988e7b3343809cf7d0ee9e0ba69706b17a3c91e48
+  metadata.gz: 3c00ad5a2b3aea12bced2b60da8ffe88910c0413ba5a56163f8f08dee540b3e0
+  data.tar.gz: 2c91552073019309fc23ae95046763143f1a7f403bd9ee78493201303fe9a592
 SHA512:
-  metadata.gz: b22ff1a5ebedc9261dc022bed342d8272b1bd15ed73c749038c4c2711f7785fa9dae7452fe0e8a40337dc46ae43daa2df7bc7ba7b4af28a8fa3f0844aff9efe3
-  data.tar.gz: 45ac6d18634f9615dcbd3807726543bab58409a7c6e20d80c8a0ad039a5f9bbcccf1c2e801c6b1070bce3aaf4632d435538aa6313f468e22dfe889efca24c156
+  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
-          }
+          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/base_function.rb

@@ -3,15 +3,15 @@
 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")
+          bot.response.dig("choices", 0, "message", "function_call", "arguments")
         )
       end
     end

data/lib/func_bot/functions/handler.rb

@@ -17,7 +17,7 @@ module FuncBot
       private
 
       def function_data
-        constantize_function.new(bot.response).execute
+        constantize_function.new(bot).execute
       end
 
       def constantize_function

data/lib/func_bot/version.rb

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

data/lib/func_bot.rb

@@ -12,12 +12,13 @@ require_relative "func_bot/functions/list"
 
 module FuncBot
   class Bot
-    attr_accessor :response
+    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)

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: func_bot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - lbp