ruby-openai-swarm 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb75077c1cd68a61448103423fec5401c54963c3341b9c7a11aef564584375d7
-  data.tar.gz: 6950967689f250591671095dd296a0e266d3e218b41e618811a3a0c8c8c48ee2
+  metadata.gz: df40e898023940bd9fa16596e947caf353dc8ce3edeee3d442cb871a8e5bbba0
+  data.tar.gz: c180214e63813c09bea2c986a3c7c1729f458f66a807a2b578d4f71b8b39374b
 SHA512:
-  metadata.gz: 0caeb42cc055869a3b9bd830e3d52cb63add1a07af767cd1e42abe8b5fb7d98565327af96a1bd36ff72616d775f3be72066eeb9298da37762afe1461ff0cd345
-  data.tar.gz: 0d515f09b04a1229e08ee1957e5958805a512f0fd9a7bb79ddf43c0962d868b9415f27714802468be1450d6d55130df7295f4ee3ed791c6c0230e09d2fa149ac
+  metadata.gz: 6e16aa9fa53293212ccdb96dba442da4e48db77dd217b749b9bfd80a4711324ac3adaf6bc11b28e27ea348d0a055921d7e1f98fa70dbecb0c4d17bcd7514473b
+  data.tar.gz: 8450574be9da37c9c5fcd67e25ba564795f5b475fe78df337a69561ca2f8b5f09ea100b01d3547b1a6dcb510c56614db6f2a3148693588d6b6e432386cd6231c

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.2.9)
       ruby-openai (~> 7.3)
 
 GEM

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

@@ -3,11 +3,15 @@ module OpenAISwarm
     attr_accessor :name, :model, :instructions,
                   :functions, :tool_choice,
                   :parallel_tool_calls,
+                  :noisy_tool_calls,
                   :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",
@@ -16,7 +20,8 @@ module OpenAISwarm
       functions: [],
       tool_choice: nil,
       parallel_tool_calls: true,
-      resource: nil
+      resource: nil,
+      noisy_tool_calls: []
     )
       @name = name
       @model = model
@@ -25,6 +30,7 @@ module OpenAISwarm
       @tool_choice = tool_choice
       @parallel_tool_calls = parallel_tool_calls
       @resource = resource
+      @noisy_tool_calls = noisy_tool_calls
     end
   end
 end

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

@@ -29,9 +29,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,
       }
 

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.2.9"
 end

data/lib/ruby-openai-swarm.rb

@@ -1,4 +1,5 @@
 require 'ruby-openai-swarm/version'
+require 'ruby-openai-swarm/core_ext'
 require 'ruby-openai-swarm/agent'
 require 'ruby-openai-swarm/response'
 require 'ruby-openai-swarm/result'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai-swarm
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Grayson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2024-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -108,6 +108,7 @@ files:
 - lib/ruby-openai-swarm/agent.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