ruby-openai-swarm 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7e19b63e6210a63fbec735601f6f8c969db926046910dc545a7a37178b06b5d
-  data.tar.gz: e43680dfddffac87d2953611c2c4d1749efc522fe316eecc5a1750de9c73f4c1
+  metadata.gz: bb75077c1cd68a61448103423fec5401c54963c3341b9c7a11aef564584375d7
+  data.tar.gz: 6950967689f250591671095dd296a0e266d3e218b41e618811a3a0c8c8c48ee2
 SHA512:
-  metadata.gz: bd71a36f8c62cfc621e9d495e030387da1b0320ec2b668322b5dfa02fdd6c5faca2b64956c1419ce955569cffeed5d00dbd432c759a88f536270a67c99cdb030
-  data.tar.gz: 2a39291b7454cbffa4d0679596c272b8324a1c5c9c801d7853b0a88991c03d6f938c562d1d6469aa5ae7ccaece64dbc900ce80d77dd376fee01e1c76632801df
+  metadata.gz: 0caeb42cc055869a3b9bd830e3d52cb63add1a07af767cd1e42abe8b5fb7d98565327af96a1bd36ff72616d775f3be72066eeb9298da37762afe1461ff0cd345
+  data.tar.gz: 0d515f09b04a1229e08ee1957e5958805a512f0fd9a7bb79ddf43c0962d868b9415f27714802468be1450d6d55130df7295f4ee3ed791c6c0230e09d2fa149ac

data/Gemfile.lock

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

data/README.md

@@ -15,6 +15,7 @@ A Ruby-based educational framework adapted from OpenAI’s [Swarm](https://githu
   - [Installation](#installation)
     - [Bundler](#bundler)
     - [Gem install](#gem-install)
+    - [Logger](#logger)
   - [examples](#examples)
   - [Documentation](#documentation)
 
@@ -114,6 +115,18 @@ pp response.messages.last
  :sender=>"Spanish Agent"}
 ```
 
+### Logger
+
+```
+OpenAISwarm.configure do |config|
+  # config.logger = Logger.new(STDOUT)
+  # config.logger = Rails.logger
+  config.log_file = Rails.root.join('log', 'openai_swarm.log')
+  # config.logger = Logger.new(Rails.root.join('log', 'openai_swarm.log'))
+  # config.logger = Rails.configuration.lograge.logger
+end
+```
+
 # Examples
 
 Setting ACCESS_TOKEN for AI Providers in examples

data/examples/airline/main.rb

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

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

@@ -0,0 +1,24 @@
+module OpenAISwarm
+  class Configuration
+    attr_accessor :logger, :log_file
+
+    def initialize
+      @log_file = nil
+      @logger = nil
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

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

@@ -11,13 +11,15 @@ module OpenAISwarm
 
     def initialize(client = nil)
       @client = client || OpenAI::Client.new
+      @logger = OpenAISwarm::Logger.instance.logger
     end
 
     def get_chat_completion(agent, history, context_variables, model_override, stream, debug)
       context_variables = context_variables.dup
       instructions = agent.instructions.respond_to?(:call) ? agent.instructions.call(context_variables) : agent.instructions
       messages = [{ role: 'system', content: instructions }] + history
-      Util.debug_print(debug, "Getting chat completion for...:", messages)
+
+      # Util.debug_print(debug, "Getting chat completion for...:", messages)
 
       tools = agent.functions.map { |f| Util.function_to_json(f) }
       # hide context_variables from model
@@ -40,7 +42,9 @@ module OpenAISwarm
       create_params[:tool_choice] = agent.tool_choice if agent.tool_choice
       create_params[:parallel_tool_calls] = agent.parallel_tool_calls if tools.any?
 
-      Util.debug_print(debug, "Client chat parameters:", create_params)
+      Util.debug_print(debug, "Getting chat completion for...:", create_params)
+      log_message(:info, "Getting chat completion for...:", create_params)
+
       if stream
         return Enumerator.new do |yielder|
           @client.chat(parameters: create_params.merge(
@@ -56,6 +60,7 @@ module OpenAISwarm
       Util.debug_print(debug, "API Response:", response)
       response
     rescue OpenAI::Error => e
+      log_message(:error, "OpenAI API Error: #{e.message}")
       Util.debug_print(true, "OpenAI API Error:", e.message)
       raise
     end
@@ -101,6 +106,7 @@ module OpenAISwarm
         name = tool_call.dig('function', 'name')
         unless function_map.key?(name)
           Util.debug_print(debug, "Tool #{name} not found in function map.")
+          log_message(:error, "Tool #{name} not found in function map.")
           partial_response.messages << {
             'role' => 'tool',
             'tool_call_id' => tool_call['id'],
@@ -112,6 +118,7 @@ module OpenAISwarm
 
         args = JSON.parse(tool_call.dig('function', 'arguments') || '{}')
         Util.debug_print(debug, "Processing tool call: #{name} with arguments #{args}")
+        log_message(:info, "Processing tool call: #{name} with arguments #{args}")
 
         func = function_map[name]
         # pass context_variables to agent functions
@@ -166,11 +173,15 @@ module OpenAISwarm
 
         message = completion.dig('choices', 0, 'message')
         Util.debug_print(debug, "Received completion:", message)
+        log_message(:info, "Received completion:", message)
 
         message['sender'] = active_agent.name
         history << message
 
-        break if !message['tool_calls'] || !execute_tools
+        if !message['tool_calls'] || !execute_tools
+          log_message(:info, "Ending turn.")
+          break
+        end
 
         partial_response = handle_tool_calls(
           message['tool_calls'],
@@ -191,8 +202,6 @@ module OpenAISwarm
       )
     end
 
-    # private
-
     def run_and_stream(agent:, messages:, context_variables: {}, model_override: nil, debug: false, max_turns: Float::INFINITY, execute_tools: true)
       active_agent = agent
       context_variables = context_variables.dup
@@ -239,9 +248,15 @@ module OpenAISwarm
         message['tool_calls'] = message['tool_calls'].values
         message['tool_calls'] = nil if message['tool_calls'].empty?
         Util.debug_print(debug, "Received completion:", message)
+        log_message(:info, "Received completion:", message)
+
         history << message
 
-        break if !message['tool_calls'] || !execute_tools
+
+        if !message['tool_calls'] || !execute_tools
+          log_message(:info, "Ending turn.")
+          break
+        end
 
         # convert tool_calls to objects
         tool_calls = message['tool_calls'].map do |tool_call|
@@ -281,5 +296,16 @@ module OpenAISwarm
                                    context_variables: context_variables)
       ) if block_given?
     end
+
+    private
+
+    def log_message(level, message, data = nil)
+      return unless @logger
+
+      log_text = message
+      log_text += "\n#{data.inspect}" if data
+
+      @logger.send(level, log_text)
+    end
   end
 end

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

@@ -0,0 +1,58 @@
+require 'logger'
+require 'fileutils'
+
+module OpenAISwarm
+  class Logger
+    SEVERITY_COLORS = {
+      'DEBUG' => "\e[36m", # Cyan
+      'INFO'  => "\e[32m", # Green
+      'WARN'  => "\e[33m", # Yellow
+      'ERROR' => "\e[31m", # Red
+      'FATAL' => "\e[35m", # Purple
+      'ANY'   => "\e[0m"   # Reset color
+    }.freeze
+
+    def self.instance
+      @instance ||= new
+    end
+
+    def initialize
+      @loggers = {}
+    end
+
+    def logger(log_path = nil)
+      return OpenAISwarm.configuration.logger if OpenAISwarm.configuration.logger
+      return @loggers[log_path] if @loggers[log_path]
+
+      path = determine_log_path(log_path)
+      ensure_log_directory(path)
+
+      logger = ::Logger.new(path)
+      logger.formatter = proc do |severity, datetime, progname, msg|
+        color = SEVERITY_COLORS[severity] || SEVERITY_COLORS['ANY']
+        reset = SEVERITY_COLORS['ANY']
+        "[#{datetime}] #{color}#{severity}#{reset} OpenAISwarm: #{msg}\n"
+      end
+
+      @loggers[log_path] = logger
+    end
+
+    private
+
+    def determine_log_path(log_path)
+      return log_path if log_path
+      return OpenAISwarm.configuration.log_file if OpenAISwarm.configuration.log_file
+
+      if defined?(Rails)
+        Rails.root.join('log', "#{Rails.env}.log").to_s
+      else
+        'log/openai_swarm.log'
+      end
+    end
+
+    def ensure_log_directory(path)
+      dir = File.dirname(path)
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+    end
+  end
+end

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

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

data/lib/ruby-openai-swarm.rb

@@ -6,6 +6,8 @@ require 'ruby-openai-swarm/util'
 require 'ruby-openai-swarm/core'
 require 'ruby-openai-swarm/function_descriptor'
 require 'ruby-openai-swarm/repl'
+require 'ruby-openai-swarm/configuration'
+require 'ruby-openai-swarm/logger'
 
 module OpenAISwarm
   class Error < StandardError;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai-swarm
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Grayson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2024-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -106,8 +106,10 @@ files:
 - examples/weather_agent/run.rb
 - lib/ruby-openai-swarm.rb
 - lib/ruby-openai-swarm/agent.rb
+- lib/ruby-openai-swarm/configuration.rb
 - lib/ruby-openai-swarm/core.rb
 - lib/ruby-openai-swarm/function_descriptor.rb
+- lib/ruby-openai-swarm/logger.rb
 - lib/ruby-openai-swarm/repl.rb
 - lib/ruby-openai-swarm/response.rb
 - lib/ruby-openai-swarm/result.rb