ruby-openai-swarm 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 161226570a77888c84129d825b862ab7868f1d9f54b233eee7ab13950427678e
-  data.tar.gz: e976c2a6bb9dae417b53fdc8f3f8216d3346a295b7e18838d89d24faff5612ce
+  metadata.gz: 984c58d324ae34f1a8eec694c3bca07aaf44420ce9ce322ceffbbc8c722e0ddd
+  data.tar.gz: 4ca2dd01658cbf5091aee65e41951fc64d5f16a72ea93c9dafe4a3802d38cad2
 SHA512:
-  metadata.gz: 65cb09238a9e1ee5fb57d2cd9e73b56d0259bafc3dc19290e449a5db75fefce0d0cf92e65a946f525c5e6571db70e813edaa11a26c436d2a3c28c3baa88bff9f
-  data.tar.gz: d90997ebfbbf64a4d9a815510db0653e07f73f2c7b53e5d5837bcfc760589ecabeca2aba87a799b92f67c1c7c82baa3cd64c44445390e6896bae16d8a5aa67e9
+  metadata.gz: 5a6357efdc1963cfd240fa23aaf3211b89cea7c39e04b4101a4ff2f25e48eb6810cc281a29977fcf5cc2ef33c23ffde4667334cc34374408fff8791c656273b4
+  data.tar.gz: b241abf134b927a950e50bdd4f2bfb06a6217a5ac5b9ea5c80d306bfcce2dd24e7c7b6f1ff85c8fd6700ac3a10080cccd13354f2f15afa6533d466d46014c7a7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai-swarm (0.3.0)
+    ruby-openai-swarm (0.3.1)
       ruby-openai (~> 7.3)
 
 GEM

data/examples/airline/main.rb

@@ -65,4 +65,4 @@ params:
 GUIDE_EXAMPLES
 puts guide_examples
 
-OpenAISwarm::Repl.run_demo_loop(triage_agent, context_variables: context_variables, stream: true, debug: env_debug)
+OpenAISwarm::Repl.run_demo_loop(triage_agent, context_variables: context_variables, debug: env_debug)

data/examples/basic/function_calling.rb

@@ -46,7 +46,6 @@ Details:
 	     Example: “What’s the weather in NYC?”
 	     Action: Calls get_weather with location “New York City”.
 	     Response: Only provides weather details.
-
 	2. Multiple Function Calls
 	     Example: “Tell me the weather in New York and the latest news headlines.”
 	     Action: Calls get_weather for weather and get_news for news.
@@ -59,19 +58,4 @@ GUIDE_EXAMPLES
 
 puts guide_examples
 
-# OpenAISwarm::Repl.run_demo_loop(agent, stream: true, debug: env_debug)
-
-OpenAISwarm.new.run_and_stream(
-  agent: agent,
-  debug: true,
-  messages: [{"role" => "user", "content" => "Tell me the weather in New York and the latest news headlines."}]
-) do |chunk|
-  if chunk.key?("content") && !chunk["content"].nil?
-    puts ">>>#{chunk}"
-  end
-
-  if chunk.key?('response')
-    binding.pry
-    # log_llm_request(chunk['response'])
-  end
-end
+OpenAISwarm::Repl.run_demo_loop(agent, stream: true, debug: env_debug)

data/lib/ruby-openai-swarm/agent.rb

@@ -6,6 +6,7 @@ module OpenAISwarm
                   :strategy,
                   :noisy_tool_calls,
                   :temperature,
+                  :current_tool_name,
                   :resource
     # These attributes can be read and written externally. They include:
     # - name: The name of the agent.
@@ -25,7 +26,8 @@ module OpenAISwarm
       parallel_tool_calls: true,
       resource: nil,
       noisy_tool_calls: [],
-      strategy: {}
+      strategy: {},
+      current_tool_name: nil
     )
       @name = name
       @model = model
@@ -36,7 +38,8 @@ module OpenAISwarm
       @parallel_tool_calls = parallel_tool_calls
       @resource = resource
       @noisy_tool_calls = noisy_tool_calls
-      @strategy = AgentStrategyOptions.new(strategy)
+      @strategy = Agents::StrategyOptions.new(strategy)
+      @current_tool_name = current_tool_name.nil? ? nil : current_tool_name.to_s
     end
   end
 end

data/lib/ruby-openai-swarm/agents/change_tracker.rb

@@ -0,0 +1,32 @@
+module OpenAISwarm
+  module Agents
+    class ChangeTracker
+      attr_reader :current_agent, :previous_agent, :tracking_agents_tool_name
+
+      def initialize(agent)
+        @tracking_agents_tool_name = []
+        add_tracking_agents_tool_name(agent.current_tool_name)
+        update(agent)
+      end
+
+      def update(agent)
+        @previous_agent = @current_agent
+        @current_agent = agent
+      end
+
+      def add_tracking_agents_tool_name(tool_name)
+        return if tool_name.nil?
+
+        @tracking_agents_tool_name << tool_name
+      end
+
+      def agent_changed?
+        previous_agent&.name != current_agent&.name
+      end
+
+      def switch_agent_reset_message?
+        agent_changed? && current_agent.strategy.switch_agent_reset_message
+      end
+    end
+  end
+end

data/lib/ruby-openai-swarm/agents/strategy_options.rb

@@ -0,0 +1,18 @@
+module OpenAISwarm
+  module Agents
+    class StrategyOptions
+      attr_accessor :switch_agent_reset_message,
+                    :prevent_agent_reentry
+
+      def initialize(strategy = {})
+        @switch_agent_reset_message = strategy[:switch_agent_reset_message] || false
+        # INFO:
+        # 1. When `prevent_agent_reentry` is false, LLM is used to control the agent's jump.
+        #    - In this case, there is a possibility of an infinite loop, so additional mechanisms (e.g., jump count limit) are needed to avoid it.
+        # 2. When `prevent_agent_reentry` is true, it prevents the agent from being called again if it has already been called.
+        #    - In this case, if an agent has already been called, it will not be called again.
+        @prevent_agent_reentry = strategy[:prevent_agent_reentry] || false
+      end
+    end
+  end
+end

data/lib/ruby-openai-swarm/core.rb

@@ -30,12 +30,12 @@ module OpenAISwarm
         params[:required]&.delete(CTX_VARS_NAME.to_sym)
       end
 
-      cleaned_messages = OpenAISwarm::Util.clean_message_tools(messages, agent.noisy_tool_calls)
+      cleaned_messages = Util.clean_message_tools(messages, agent.noisy_tool_calls)
 
       create_params = {
         model: model_override || agent.model,
         messages: cleaned_messages,
-        tools: tools.empty? ? nil : tools,
+        tools: Util.request_tools_excluded(tools, agent_tracker.tracking_agents_tool_name, agent.strategy.prevent_agent_reentry),
       }
 
       # TODO: https://platform.openai.com/docs/guides/function-calling/how-do-functions-differ-from-tools
@@ -148,7 +148,7 @@ module OpenAISwarm
     end
 
     def run(agent:, messages:, context_variables: {}, model_override: nil, stream: false, debug: false, max_turns: Float::INFINITY, execute_tools: true)
-      agent_tracker = OpenAISwarm::AgentChangeTracker.new(agent)
+      agent_tracker = OpenAISwarm::Agents::ChangeTracker.new(agent)
       if stream
         return run_and_stream(
           agent: agent,
@@ -168,7 +168,7 @@ module OpenAISwarm
 
       while history.length - init_len < max_turns && active_agent
         agent_tracker.update(active_agent)
-        history = [history.first] if agent_tracker.switch_agent_reset_message?
+        history = OpenAISwarm::Util.latest_role_user_message(history) if agent_tracker.switch_agent_reset_message?
 
         completion = get_chat_completion(
           agent_tracker,
@@ -198,6 +198,11 @@ module OpenAISwarm
           debug
         )
 
+        if partial_response.agent
+          agent_tool_name = message['tool_calls'].dig(0, 'function', 'name')
+          agent_tracker.add_tracking_agents_tool_name(agent_tool_name)
+        end
+
         history.concat(partial_response.messages)
         context_variables.merge!(partial_response.context_variables)
         active_agent = partial_response.agent if partial_response.agent
@@ -212,7 +217,7 @@ module OpenAISwarm
 
     # TODO(Grayson): a lot of copied code here that will be refactored
     def run_and_stream(agent:, messages:, context_variables: {}, model_override: nil, debug: false, max_turns: Float::INFINITY, execute_tools: true)
-      agent_tracker = OpenAISwarm::AgentChangeTracker.new(agent)
+      agent_tracker = OpenAISwarm::Agents::ChangeTracker.new(agent)
       active_agent = agent
       context_variables = context_variables.dup
       history = messages.dup
@@ -220,7 +225,7 @@ module OpenAISwarm
 
       while history.length - init_len < max_turns && active_agent
         agent_tracker.update(active_agent)
-        history = [history.first] if agent_tracker.switch_agent_reset_message?
+        history = OpenAISwarm::Util.latest_role_user_message(history) if agent_tracker.switch_agent_reset_message?
 
         message = OpenAISwarm::Util.message_template(agent.name)
         completion = get_chat_completion(
@@ -290,6 +295,11 @@ module OpenAISwarm
           debug
         )
 
+        if partial_response.agent
+          agent_tool_name = message['tool_calls'].dig(0, 'function', 'name')
+          agent_tracker.add_tracking_agents_tool_name(agent_tool_name)
+        end
+
         history.concat(partial_response.messages)
         context_variables.merge!(partial_response.context_variables)
         active_agent = partial_response.agent if partial_response.agent

data/lib/ruby-openai-swarm/util.rb

@@ -1,5 +1,23 @@
 module OpenAISwarm
   module Util
+    class << self
+      def latest_role_user_message(history)
+        return history if history.empty?
+        filtered_messages = symbolize_keys_to_string(history.dup)
+        last_user_message = filtered_messages.reverse.find { |msg| msg['role'] == 'user' }
+        last_user_message ? [last_user_message] : history
+      end
+
+      def request_tools_excluded(tools, tool_names, prevent_agent_reentry = false)
+        return nil if tools.empty?
+        return tools if tool_names.empty? || !prevent_agent_reentry
+
+        symbolize_keys_to_string(tools).reject do |tool|
+          tool_names.include?("#{tool['function']['name']}")
+        end
+      end
+    end
+
     def self.debug_print(debug, *args)
       return unless debug
       timestamp = Time.now.strftime("%Y-%m-%d %H:%M:%S")

data/lib/ruby-openai-swarm/version.rb

@@ -1,3 +1,3 @@
 module OpenAISwarm
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/ruby-openai-swarm.rb

@@ -1,8 +1,8 @@
 require 'ruby-openai-swarm/version'
 require 'ruby-openai-swarm/core_ext'
 require 'ruby-openai-swarm/agent'
-require 'ruby-openai-swarm/agent_change_tracker'
-require 'ruby-openai-swarm/agent_strategy_options'
+require 'ruby-openai-swarm/agents/change_tracker'
+require 'ruby-openai-swarm/agents/strategy_options'
 require 'ruby-openai-swarm/response'
 require 'ruby-openai-swarm/result'
 require 'ruby-openai-swarm/util'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai-swarm
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Grayson
@@ -106,8 +106,8 @@ files:
 - examples/weather_agent/run.rb
 - lib/ruby-openai-swarm.rb
 - lib/ruby-openai-swarm/agent.rb
-- lib/ruby-openai-swarm/agent_change_tracker.rb
-- lib/ruby-openai-swarm/agent_strategy_options.rb
+- lib/ruby-openai-swarm/agents/change_tracker.rb
+- lib/ruby-openai-swarm/agents/strategy_options.rb
 - lib/ruby-openai-swarm/configuration.rb
 - lib/ruby-openai-swarm/core.rb
 - lib/ruby-openai-swarm/core_ext.rb

data/lib/ruby-openai-swarm/agent_change_tracker.rb

@@ -1,22 +0,0 @@
-module OpenAISwarm
-  class AgentChangeTracker
-    attr_reader :current_agent, :previous_agent
-
-    def initialize(agent)
-      update(agent)
-    end
-
-    def update(agent)
-      @previous_agent = @current_agent
-      @current_agent = agent
-    end
-
-    def agent_changed?
-      previous_agent&.name != current_agent&.name
-    end
-
-    def switch_agent_reset_message?
-      agent_changed? && current_agent.strategy.switch_agent_reset_message
-    end
-  end
-end

data/lib/ruby-openai-swarm/agent_strategy_options.rb

@@ -1,9 +0,0 @@
-module OpenAISwarm
-  class AgentStrategyOptions
-    attr_accessor :switch_agent_reset_message
-
-    def initialize(strategy = {})
-      @switch_agent_reset_message = strategy[:switch_agent_reset_message] || false
-    end
-  end
-end