ruby-openai-swarm 0.3.0.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98aa27742c5ae980d9c1c8b9457beb2e61a4ff3a1548790d4205cd0f68cef039
-  data.tar.gz: 37d7a5280f47c2a454a2aba4a5f64587787f1e829fc07b6c27accc90f63f91f8
+  metadata.gz: 49bcf71e27c830e373b9732691667aa4ff8657dc944a8dc113fb4b13e807ccd6
+  data.tar.gz: 38cd26d3670e7a49652b8b52677a2a7bf722c9f5635bfef55bea296d0502c4d1
 SHA512:
-  metadata.gz: 0d671ef9fa72e895bfd3b3e62561fccfc3894a6f19605dd43e68da14b0c9f958d22559da8d9eecd981277a7db035ed39c17535f261cf40849f16a95ac6884516
-  data.tar.gz: 96c6229510613dbb8b858200916bb9ab22583b7918d604adae0b1bc85bb5b89cfae28a6c833b8c16b2acc1758d1d89643c61f240c896ff6d1d3153536801b46d
+  metadata.gz: 0f4b422f084d400ef6eea393f20a650fd02fa8b96370e4781c4228113650763c7eb84c6c1aac21daceb8251cfd83d69ec69b536dff16c3bd7be3e8b0f22a353a
+  data.tar.gz: f24c83ea576a7d305069eda9da308f0d39b257065897377b228c785049c41254d3889d4e82b96d40755151b801b95d3a6f8ae5550d73fb871c902c9b21755793

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai-swarm (0.3.0.1)
+    ruby-openai-swarm (0.4.0)
       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
@@ -37,6 +39,7 @@ module OpenAISwarm
       @resource = resource
       @noisy_tool_calls = noisy_tool_calls
       @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

@@ -1,9 +1,11 @@
 module OpenAISwarm
   module Agents
     class ChangeTracker
-      attr_reader :current_agent, :previous_agent
+      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
 
@@ -12,6 +14,12 @@ module OpenAISwarm
         @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

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

@@ -1,10 +1,17 @@
 module OpenAISwarm
   module Agents
     class StrategyOptions
-      attr_accessor :switch_agent_reset_message
+      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

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
@@ -51,9 +51,11 @@ module OpenAISwarm
 
       if stream
         return Enumerator.new do |yielder|
+          yielder << { 'parameters' => create_params }
+
           @client.chat(parameters: create_params.merge(
             stream: proc do |chunk, _bytesize|
-              yielder << chunk
+              yielder << { chunk: chunk }
             end
           ))
         end
@@ -198,6 +200,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
@@ -233,7 +240,15 @@ module OpenAISwarm
         )
 
         yield({ delim: "start" }) if block_given?
-        completion.each do |chunk|
+        completion.each do |stream|
+
+          # TODO(Grayson): will refactor it
+          if stream['parameters']
+            yield({ 'parameters' => stream['parameters'] }) if block_given?
+          end
+          next if stream.key?('parameters')
+
+          chunk = stream[:chunk]
           if chunk['error']
             details = {
               'response' =>
@@ -250,7 +265,7 @@ module OpenAISwarm
             delta['sender'] = active_agent.name
           end
 
-          yield delta if block_given?
+          yield({ 'delta' => delta })  if block_given?
 
           delta.delete('role')
           delta.delete('sender')
@@ -290,6 +305,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/repl.rb

@@ -4,21 +4,24 @@ module OpenAISwarm
       def process_and_print_streaming_response(response)
         content = []
         last_sender = ""
-        response.each do |chunk|
-          last_sender = chunk['sender'] if chunk.key?('sender')
+        response.each do |stream|
+          delta = stream['delta']
+          if delta
+            last_sender = delta['sender'] if delta.key?('sender')
 
-          if chunk.key?("content") && !chunk["content"].nil?
-            if content.empty? && !last_sender.empty?
-              puts
-              print "\033[94m#{last_sender}:\033[0m "
-              last_sender = ""
+            if delta.key?("content") && !delta["content"].nil?
+              if content.empty? && !last_sender.empty?
+                puts
+                print "\033[94m#{last_sender}:\033[0m "
+                last_sender = ""
+              end
+              print delta["content"]
+              content << delta["content"]
             end
-            print chunk["content"]
-            content << chunk["content"]
           end
 
-          if chunk.key?("tool_calls") && !chunk["tool_calls"].nil?
-            chunk["tool_calls"].each do |tool_call|
+          if stream.key?("tool_calls") && !stream["tool_calls"].nil?
+            stream["tool_calls"].each do |tool_call|
               f = tool_call["function"]
               name = f["name"]
               next if name.nil?
@@ -26,11 +29,11 @@ module OpenAISwarm
             end
           end
 
-          if chunk.key?("delim") && chunk["delim"] == "end" && !content.empty?
+          if stream.key?("delim") && stream["delim"] == "end" && !content.empty?
             puts
             content = ""
           end
-          return chunk["response"] if chunk.key?("response")
+          return stream["response"] if stream.key?("response")
         end
       end
 

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

@@ -7,7 +7,17 @@ module OpenAISwarm
         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.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai-swarm
 version: !ruby/object:Gem::Version
-  version: 0.3.0.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Grayson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-18 00:00:00.000000000 Z
+date: 2024-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai