ruby-openai-swarm 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb75077c1cd68a61448103423fec5401c54963c3341b9c7a11aef564584375d7
-  data.tar.gz: 6950967689f250591671095dd296a0e266d3e218b41e618811a3a0c8c8c48ee2
+  metadata.gz: 161226570a77888c84129d825b862ab7868f1d9f54b233eee7ab13950427678e
+  data.tar.gz: e976c2a6bb9dae417b53fdc8f3f8216d3346a295b7e18838d89d24faff5612ce
 SHA512:
-  metadata.gz: 0caeb42cc055869a3b9bd830e3d52cb63add1a07af767cd1e42abe8b5fb7d98565327af96a1bd36ff72616d775f3be72066eeb9298da37762afe1461ff0cd345
-  data.tar.gz: 0d515f09b04a1229e08ee1957e5958805a512f0fd9a7bb79ddf43c0962d868b9415f27714802468be1450d6d55130df7295f4ee3ed791c6c0230e09d2fa149ac
+  metadata.gz: 65cb09238a9e1ee5fb57d2cd9e73b56d0259bafc3dc19290e449a5db75fefce0d0cf92e65a946f525c5e6571db70e813edaa11a26c436d2a3c28c3baa88bff9f
+  data.tar.gz: d90997ebfbbf64a4d9a815510db0653e07f73f2c7b53e5d5837bcfc760589ecabeca2aba87a799b92f67c1c7c82baa3cd64c44445390e6896bae16d8a5aa67e9

data/.gitignore

@@ -30,3 +30,4 @@ build-iPhoneSimulator/
 
 # rspec failure tracking
 .rspec_status
+log/openai_swarm.log

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai-swarm (0.2.8)
+    ruby-openai-swarm (0.3.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, debug: env_debug)
+OpenAISwarm::Repl.run_demo_loop(triage_agent, context_variables: context_variables, stream: true, debug: env_debug)

data/examples/basic/function_calling.rb

@@ -46,6 +46,7 @@ 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.
@@ -58,4 +59,19 @@ GUIDE_EXAMPLES
 
 puts guide_examples
 
-OpenAISwarm::Repl.run_demo_loop(agent, stream: true, debug: env_debug)
+# 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

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

@@ -3,11 +3,17 @@ module OpenAISwarm
     attr_accessor :name, :model, :instructions,
                   :functions, :tool_choice,
                   :parallel_tool_calls,
+                  :strategy,
+                  :noisy_tool_calls,
+                  :temperature,
                   :resource
     # These attributes can be read and written externally. They include:
     # - name: The name of the agent.
     # - model: The model used, e.g., "gpt-4".
     # - resource: Additional custom parameters or data that the agent might need.
+    # - noisy_tool_calls: is an array that contains the names of tool calls that should be excluded because they are considered "noise".
+    # These tool calls generate irrelevant or unnecessary messages that the agent should not send to OpenAI.
+    # When filtering messages, any message that includes these tool calls will be removed from the list, preventing them from being sent to OpenAI.
 
     def initialize(
       name: "Agent",
@@ -15,16 +21,22 @@ module OpenAISwarm
       instructions: "You are a helpful agent.",
       functions: [],
       tool_choice: nil,
+      temperature: nil,
       parallel_tool_calls: true,
-      resource: nil
+      resource: nil,
+      noisy_tool_calls: [],
+      strategy: {}
     )
       @name = name
       @model = model
       @instructions = instructions
       @functions = functions
       @tool_choice = tool_choice
+      @temperature = temperature
       @parallel_tool_calls = parallel_tool_calls
       @resource = resource
+      @noisy_tool_calls = noisy_tool_calls
+      @strategy = AgentStrategyOptions.new(strategy)
     end
   end
 end

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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,9 @@
+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

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

@@ -14,7 +14,8 @@ module OpenAISwarm
       @logger = OpenAISwarm::Logger.instance.logger
     end
 
-    def get_chat_completion(agent, history, context_variables, model_override, stream, debug)
+    def get_chat_completion(agent_tracker, history, context_variables, model_override, stream, debug)
+      agent = agent_tracker.current_agent
       context_variables = context_variables.dup
       instructions = agent.instructions.respond_to?(:call) ? agent.instructions.call(context_variables) : agent.instructions
       messages = [{ role: 'system', content: instructions }] + history
@@ -29,9 +30,11 @@ module OpenAISwarm
         params[:required]&.delete(CTX_VARS_NAME.to_sym)
       end
 
+      cleaned_messages = OpenAISwarm::Util.clean_message_tools(messages, agent.noisy_tool_calls)
+
       create_params = {
         model: model_override || agent.model,
-        messages: messages,
+        messages: cleaned_messages,
         tools: tools.empty? ? nil : tools,
       }
 
@@ -39,6 +42,7 @@ module OpenAISwarm
       # create_params[:functions] = tools unless tools.empty?
       # create_params[:function_call] = agent.tool_choice if agent.tool_choice
 
+      create_params[:temperature] = agent.temperature if agent.temperature
       create_params[:tool_choice] = agent.tool_choice if agent.tool_choice
       create_params[:parallel_tool_calls] = agent.parallel_tool_calls if tools.any?
 
@@ -144,6 +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)
       if stream
         return run_and_stream(
           agent: agent,
@@ -162,8 +167,11 @@ module OpenAISwarm
       init_len = messages.length
 
       while history.length - init_len < max_turns && active_agent
+        agent_tracker.update(active_agent)
+        history = [history.first] if agent_tracker.switch_agent_reset_message?
+
         completion = get_chat_completion(
-          active_agent,
+          agent_tracker,
           history,
           context_variables,
           model_override,
@@ -202,16 +210,21 @@ module OpenAISwarm
       )
     end
 
+    # 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)
       active_agent = agent
       context_variables = context_variables.dup
       history = messages.dup
       init_len = messages.length
 
       while history.length - init_len < max_turns && active_agent
+        agent_tracker.update(active_agent)
+        history = [history.first] if agent_tracker.switch_agent_reset_message?
+
         message = OpenAISwarm::Util.message_template(agent.name)
         completion = get_chat_completion(
-          active_agent,
+          agent_tracker,
           history,
           context_variables,
           model_override,

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

@@ -0,0 +1,16 @@
+# Backport of Array.wrap for Ruby versions prior to 3.0
+# This provides a consistent way to wrap objects as arrays across different Ruby versions
+# link: https://github.com/rails/rails/blob/main/activesupport/lib/active_support/core_ext/array/wrap.rb
+unless Array.respond_to?(:wrap)
+  class Array
+    def self.wrap(object)
+      if object.nil?
+        []
+      elsif object.respond_to?(:to_ary)
+        object.to_ary || [object]
+      else
+        [object]
+      end
+    end
+  end
+end

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

@@ -7,6 +7,50 @@ module OpenAISwarm
       puts "\e[97m[\e[90m#{timestamp}\e[97m]\e[90m #{message}\e[0m"
     end
 
+    def self.symbolize_keys_to_string(obj)
+      case obj
+      when Hash
+        obj.transform_keys(&:to_s).transform_values { |v| symbolize_keys_to_string(v) }
+      when Array
+        obj.map { |v| symbolize_keys_to_string(v) }
+      else
+        obj
+      end
+    end
+
+    def self.clean_message_tools(messages, tool_names)
+      return messages if tool_names.empty?
+      filtered_messages = symbolize_keys_to_string(messages.dup)
+      # Collect tool call IDs to be removed
+      tool_call_ids_to_remove = filtered_messages
+        .select { |msg| msg['tool_calls'] }
+        .flat_map { |msg| msg['tool_calls'] }
+        .select { |tool_call| tool_names.include?(tool_call['function']['name']) }
+        .map { |tool_call| tool_call['id'] }
+
+      # Remove specific messages
+      filtered_messages.reject! do |msg|
+        # Remove tool call messages for specified tool names
+        (msg['role'] == 'assistant' &&
+         msg['tool_calls']&.all? { |tool_call| tool_names.include?(tool_call['function']['name']) }) ||
+        # Remove tool response messages for specified tool calls
+        (msg['role'] == 'tool' && tool_call_ids_to_remove.include?(msg['tool_call_id']))
+      end
+
+      # If assistant message's tool_calls becomes empty, modify that message
+      filtered_messages.map! do |msg|
+        if msg['role'] == 'assistant' && msg['tool_calls']
+          msg['tool_calls'].reject! { |tool_call| tool_names.include?(tool_call['function']['name']) }
+          msg['tool_calls'] = nil if msg['tool_calls'].empty?
+          msg
+        else
+          msg
+        end
+      end
+
+      filtered_messages
+    end
+
     def self.message_template(agent_name)
       {
         "content" => "",

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

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

data/lib/ruby-openai-swarm.rb

@@ -1,5 +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/response'
 require 'ruby-openai-swarm/result'
 require 'ruby-openai-swarm/util'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai-swarm
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Grayson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -106,8 +106,11 @@ 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/configuration.rb
 - lib/ruby-openai-swarm/core.rb
+- lib/ruby-openai-swarm/core_ext.rb
 - lib/ruby-openai-swarm/function_descriptor.rb
 - lib/ruby-openai-swarm/logger.rb
 - lib/ruby-openai-swarm/repl.rb