ox-ai-workers 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b3d80806db64371193199ae3e0731060a156fd08398628e68fdd0bae2fa459c
-  data.tar.gz: bd70e01c89c093a85b2f32cf62b6de0826fff868378721e4203bfbc732998a63
+  metadata.gz: 5b0bc20d6b4c721456a19d590a596d989b10b9dd246027ce586404eb4741946a
+  data.tar.gz: 5fd3e688b4898cb976ebc91f2da315fc3efa22b2a347349e3958373a64426213
 SHA512:
-  metadata.gz: 796005900f27745768ec4cb9467937aaad3cb2dd2cad6d76e8ae3fa1a0da29a32c596de8456d491b3c7fadfc2db9324369befbf120ceddfc1224bbb53cdba05b
-  data.tar.gz: 8d1fcf58fbaf734dab49276bec6fdd6f8aabddbe187c0a97495fe1ca767e5dfcdd09eb56069bfc3574712941fe3e7d77a1b2420ca7b294ef2a701b4d7deb1e5b
+  metadata.gz: 98d855e5b18762f1acf4233e646733539e29954331e39501ea053c9641cc049ec15c5830523ee6763775e5a2d65123e6dc910d2c7bac41809fef12d9170f4aa3
+  data.tar.gz: cce07e1dc69d769df0830dc175481996a733d71428de65a6632a4aadae129192004a3b795008c370792baa3fc50dc88f89db6d9ea2a9e4459a66b69a07961bcb

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.5.2] - 2024-07-31
+
+- Added new assistant: `Localizer`
+- Added logger
+
 ## [0.5.1] - 2024-07-30
 
 - Improved FileSystem functionality
@@ -27,10 +32,10 @@
 
 ## [0.3.0] - 2024-07-30
 
-- on_inner_monologue: ->(text:) { puts Rainbow("monologue: #{text}").yellow }
-- on_outer_voice: ->(text:) { puts Rainbow("voice: #{text}").green }
-- on_action_request: ->(text:) { puts Rainbow("action: #{text}").red }
-- on_pack_history: ->(text:) { puts Rainbow("summary: #{text}").blue }
+- on_inner_monologue: ->(text:) { puts "monologue: #{text}" }
+- on_outer_voice: ->(text:) { puts "voice: #{text}" }
+- on_action_request: ->(text:) { puts "action: #{text}" }
+- on_pack_history: ->(text:) { puts "summary: #{text}" }
 
 ## [0.2.5] - 2024-07-30
 

data/README.md

@@ -111,10 +111,10 @@ iterator = OxAiWorkers::Iterator.new(
     worker: my_worker, 
     tools: [my_tool],
     role: "You are a software agent inside my computer",
-    on_inner_monologue: ->(text:) { puts Rainbow("monologue: #{text}").yellow },
-    on_outer_voice: ->(text:) { puts Rainbow("voice: #{text}").green },
-    on_action_request: ->(text:) { puts Rainbow("action: #{text}").red },
-    on_pack_history: ->(text:) { puts Rainbow("summary: #{text}").blue } 
+    on_inner_monologue: ->(text:) { puts "monologue: #{text}".colorize(:yellow) },
+    on_outer_voice: ->(text:) { puts "voice: #{text}".colorize(:green) },
+    on_action_request: ->(text:) { puts "action: #{text}".colorize(:red) },
+    on_pack_history: ->(text:) { puts "summary: #{text}".colorize(:blue) }
   )
 
 iterator.add_task("Show files in current directory.")
@@ -158,6 +158,15 @@ After this, in the `my_assistant.rb` file, you can find an example of an assista
 .oxaiworkers-local/start
 ```
 
+## Logging
+
+OxAiWorkers uses standard logging mechanisms and defaults to `:warn` level. Most messages are at info level, but we will add debug or warn statements as needed.
+To show all log messages:
+
+```ruby
+OxAiWorkers.logger.level = :debug
+```
+
 ## Features
 
 - **Generative Intelligence**: Leverages OpenAI's capabilities to enhance task execution.

data/lib/ox-ai-workers.rb

@@ -2,12 +2,13 @@
 
 require 'faraday'
 require 'faraday/multipart'
-require 'rainbow'
+require 'colorize'
 require 'openai'
 require 'yaml'
 require 'json'
 
 require_relative 'oxaiworkers/version'
+require_relative 'oxaiworkers/contextual_logger'
 require_relative 'oxaiworkers/load_i18n'
 require_relative 'oxaiworkers/present_compat'
 require_relative 'oxaiworkers/module_request'
@@ -54,8 +55,17 @@ module OxAiWorkers
 
   class << self
     attr_writer :configuration
+    attr_reader :logger
+
+    # @param logger [Logger]
+    # @return [ContextualLogger]
+    def logger=(logger)
+      @logger = ContextualLogger.new(logger)
+    end
   end
 
+  self.logger ||= ::Logger.new($stdout, level: :info)
+
   def self.configuration
     @configuration ||= OxAiWorkers::Configuration.new
   end

data/lib/oxaiworkers/assistant/coder.rb

@@ -10,10 +10,10 @@ module OxAiWorkers
           worker: init_worker(delayed: delayed, model: model),
           role: format(I18n.t('oxaiworkers.assistant.coder.role'), language),
           tools: [Tool::Eval.new, Tool::FileSystem.new],
-          on_inner_monologue: ->(text:) { puts Rainbow("monologue: #{text}").yellow },
-          on_outer_voice: ->(text:) { puts Rainbow("voice: #{text}").green },
-          on_action_request: ->(text:) { puts Rainbow("action: #{text}").red },
-          on_pack_history: ->(text:) { puts Rainbow("summary: #{text}").blue }
+          on_inner_monologue: ->(text:) { puts "monologue: #{text}".colorize(:yellow) },
+          on_outer_voice: ->(text:) { puts "voice: #{text}".colorize(:green) },
+          on_action_request: ->(text:) { puts "action: #{text}".colorize(:red) },
+          on_pack_history: ->(text:) { puts "summary: #{text}".colorize(:blue) }
         )
       end
     end

data/lib/oxaiworkers/assistant/localizer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OxAiWorkers
+  module Assistant
+    class Localizer
+      include OxAiWorkers::Assistant::ModuleBase
+
+      def initialize(delayed: false, model: nil, language: 'русский', locale: :ru, source: 'english')
+        @iterator = Iterator.new(
+          worker: init_worker(delayed: delayed, model: model),
+          role: format(I18n.t('oxaiworkers.assistant.localizer.role'), language),
+          tools: [Tool::Eval.new, Tool::FileSystem.new],
+          on_inner_monologue: ->(text:) { puts "monologue: #{text}".colorize(:yellow) },
+          on_outer_voice: ->(text:) { puts "voice: #{text}".colorize(:green) },
+          on_action_request: ->(text:) { puts "action: #{text}".colorize(:red) },
+          on_pack_history: ->(text:) { puts "summary: #{text}".colorize(:blue) }
+        )
+        @iterator.add_context(format(I18n.t('oxaiworkers.assistant.localizer.source'), source))
+
+        @iterator.add_context(format(I18n.t('oxaiworkers.assistant.localizer.locale'),
+                                     language, locale))
+      end
+    end
+  end
+end

data/lib/oxaiworkers/assistant/sysop.rb

@@ -10,10 +10,10 @@ module OxAiWorkers
           worker: init_worker(delayed: delayed, model: model),
           role: I18n.t('oxaiworkers.assistant.sysop.role'),
           tools: [Tool::Eval.new],
-          on_inner_monologue: ->(text:) { puts Rainbow("monologue: #{text}").yellow },
-          on_outer_voice: ->(text:) { puts Rainbow("voice: #{text}").green },
-          on_action_request: ->(text:) { puts Rainbow("action: #{text}").red },
-          on_pack_history: ->(text:) { puts Rainbow("summary: #{text}").blue }
+          on_inner_monologue: ->(text:) { puts "monologue: #{text}".colorize(:yellow) },
+          on_outer_voice: ->(text:) { puts "voice: #{text}".colorize(:green) },
+          on_action_request: ->(text:) { puts "action: #{text}".colorize(:red) },
+          on_pack_history: ->(text:) { puts "summary: #{text}".colorize(:blue) }
         )
       end
     end

data/lib/oxaiworkers/contextual_logger.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module OxAiWorkers
+  class ContextualLogger
+    MESSAGE_COLOR_OPTIONS = {
+      debug: {
+        color: :white
+      },
+      error: {
+        color: :red
+      },
+      fatal: {
+        color: :red,
+        background: :white,
+        mode: :bold
+      },
+      unknown: {
+        color: :white
+      },
+      info: {
+        color: :magenta
+      },
+      warn: {
+        color: :yellow,
+        mode: :bold
+      }
+    }
+
+    def initialize(logger)
+      @logger = logger
+      @levels = Logger::Severity.constants.map(&:downcase)
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @logger.respond_to?(method, include_private)
+    end
+
+    def method_missing(method, *args, **kwargs, &block)
+      return @logger.send(method, *args, **kwargs, &block) unless @levels.include?(method)
+
+      for_class = kwargs.delete(:for)
+      for_class_name = for_class&.name
+
+      log_line_parts = []
+      log_line_parts << '[OxAiWorkers]' # .colorize(color: :yellow)
+      log_line_parts << if for_class.respond_to?(:logger_options)
+                          "#{"[#{for_class_name}]".colorize(for_class.logger_options)}:"
+                        elsif for_class_name
+                          "[#{for_class_name}]:"
+                        end
+      log_line_parts << args.first.colorize(MESSAGE_COLOR_OPTIONS[method])
+      log_line = log_line_parts.compact.join(' ')
+
+      @logger.send(
+        method,
+        log_line
+      )
+    end
+  end
+end

data/lib/oxaiworkers/delayed_request.rb

@@ -65,7 +65,7 @@ module OxAiWorkers
         @file_id = response['id']
         process_batch!
       rescue OpenAI::Error => e
-        puts e.inspect
+        OxAiWorkers.logger.debug(e.inspect, for: self.class)
         fail_batch!
       end
       file.unlink

data/lib/oxaiworkers/iterator.rb

@@ -26,7 +26,6 @@ module OxAiWorkers
 
     def initialize(worker:, role: nil, tools: [], on_inner_monologue: nil, on_outer_voice: nil, on_action_request: nil,
                    on_pack_history: nil)
-      puts "call: #{__method__}"
       @worker = worker
       @tools = [self] + tools
       @role = role
@@ -86,7 +85,6 @@ module OxAiWorkers
     end
 
     def init
-      puts "call: #{__method__} state: #{state_name}"
       rebuild_worker
       request!
     end
@@ -103,7 +101,6 @@ module OxAiWorkers
     end
 
     def next_iteration
-      puts "call: #{__method__} state: #{state_name}"
       @worker.append(messages: @queue)
       @messages += @queue
       @queue = []
@@ -111,19 +108,16 @@ module OxAiWorkers
     end
 
     def external_request
-      puts "call: #{__method__} state: #{state_name}"
       @worker.request!
       ticker
     end
 
     def ticker
-      puts "call: #{__method__} state: #{state_name}"
       sleep(60) until @worker.completed?
       analyze!
     end
 
     def process_result(_transition)
-      puts "call: #{__method__} state: #{state_name}"
       @result = @worker.result || @worker.errors
       if @worker.tool_calls.present?
         @queue << { role: :assistant, content: @worker.tool_calls_raw.to_s }
@@ -161,17 +155,15 @@ module OxAiWorkers
       execute if auto_execute
     end
 
-    def append_context(text, role: :system)
+    def add_context(text, role: :system)
       @context << { role: role, content: text }
     end
 
     def execute
-      puts "call: #{__method__} state: #{state_name}"
       prepare! if valid?
     end
 
     def cancel
-      puts "call: #{__method__} state: #{state_name}"
       @worker.cancel if @worker.respond_to?(:cancel)
     end
 

data/lib/oxaiworkers/module_request.rb

@@ -6,7 +6,6 @@ module OxAiWorkers
                   :tool_calls_raw, :tool_calls
 
     def initialize_requests(model: nil, max_tokens: nil, temperature: nil)
-      # puts "call: ModuleRequest::#{__method__}"
       @max_tokens = max_tokens || OxAiWorkers.configuration.max_tokens
       @custom_id = SecureRandom.uuid
       @model = model || OxAiWorkers.configuration.model
@@ -23,7 +22,6 @@ module OxAiWorkers
     end
 
     def cleanup
-      # puts "call: ModuleRequest::#{__method__}"
       @client ||= OpenAI::Client.new(
         access_token: OxAiWorkers.configuration.access_token,
         log_errors: true # Highly recommended in development, so you can see what errors OpenAI is returning. Not recommended in production because it could leak private data to your logs.
@@ -61,7 +59,6 @@ module OxAiWorkers
     end
 
     def parse_choices(response)
-      # puts response.inspect
       @tool_calls = []
       @result = response.dig('choices', 0, 'message', 'content')
       @tool_calls_raw = response.dig('choices', 0, 'message', 'tool_calls')

data/lib/oxaiworkers/request.rb

@@ -12,10 +12,8 @@ module OxAiWorkers
     def request!
       response = @client.chat(parameters: params)
       parse_choices(response)
-      # @result = response.dig("choices", 0, "message", "content")
-      # puts response.inspect
     rescue OpenAI::Error => e
-      puts e.inspect
+      OxAiWorkers.logger.debug(e.inspect, for: self.class)
     end
 
     def completed?

data/lib/oxaiworkers/state_batch.rb

@@ -56,10 +56,5 @@ module OxAiWorkers
       @batch_id = nil
       super()
     end
-
-    def initialize
-      puts "call: StateBatch::#{__method__}"
-      super()
-    end
   end
 end

data/lib/oxaiworkers/state_helper.rb

@@ -3,7 +3,7 @@
 module OxAiWorkers
   module StateHelper
     def log_me(transition)
-      # puts "`#{transition.event}` was called to transition from :#{transition.from} to :#{transition.to}"
+      # OxAiWorkers.logger.debug("`#{transition.event}` was called to transition from :#{transition.from} to :#{transition.to}")
     end
   end
 end

data/lib/oxaiworkers/tool/database.rb

@@ -72,7 +72,7 @@ module OxAiWorkers
       #
       # @return [String] Database schema
       def dump_schema
-        puts('Dumping schema tables and keys', for: self.class)
+        OxAiWorkers.logger.debug('Dumping schema tables and keys', for: self.class)
         schema = ''
         db.tables.each do |table|
           describe_table(table, schema)
@@ -108,10 +108,11 @@ module OxAiWorkers
       # @param input [String] SQL query to be executed
       # @return [Array] Results from the SQL query
       def execute(input:)
-        puts("Executing \"#{input}\"", for: self.class)
+        OxAiWorkers.logger.info("Executing \"#{input}\"", for: self.class)
 
         db[input].to_a
       rescue Sequel::DatabaseError => e
+        OxAiWorkers.logger.info(e.message, for: self.class)
         e.message
       end
     end

data/lib/oxaiworkers/tool/eval.rb

@@ -17,18 +17,19 @@ module OxAiWorkers
       end
 
       # def ruby(input:)
-      #   puts Rainbow("Executing ruby: \"#{input}\"").red
+      #   puts "Executing ruby: \"#{input}\"".colorize(:red)
       #   eval(input)
       # end
 
       def sh(input:)
-        puts Rainbow("Executing sh: \"#{input}\"").red
+        OxAiWorkers.logger.info("Executing sh: \"#{input}\"", for: self.class)
         begin
           stdout_and_stderr_s, status = Open3.capture2e(input)
           return stdout_and_stderr_s if stdout_and_stderr_s.present?
 
           status.to_s
         rescue StandardError => e
+          OxAiWorkers.logger.debug(e.message, for: self.class)
           e.message
         end
       end

data/lib/oxaiworkers/tool/file_system.rb

@@ -38,7 +38,7 @@ module OxAiWorkers
       end
 
       def list_directory(directory_path:)
-        puts Rainbow("Listing directory: #{directory_path}").magenta
+        OxAiWorkers.logger.info("Listing directory: #{directory_path}", for: self.class)
         list = Dir.entries(directory_path)
         list.delete_if { |f| f.start_with?('.') }
         if list.present?
@@ -51,7 +51,7 @@ module OxAiWorkers
       end
 
       def read_file(file_path:)
-        puts Rainbow("Reading file: #{file_path}").magenta
+        OxAiWorkers.logger.info("Reading file: #{file_path}", for: self.class)
         if File.binary?(file_path)
           "File is binary: #{file_path}"
         else
@@ -62,7 +62,7 @@ module OxAiWorkers
       end
 
       def write_to_file(file_path:, content:)
-        puts Rainbow("Writing to file: #{file_path}").magenta
+        OxAiWorkers.logger.info("Writing to file: #{file_path}", for: self.class)
         File.write(file_path, content)
         "Content was successfully written to the file: #{file_path}"
       rescue Errno::EACCES

data/lib/oxaiworkers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OxAiWorkers
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

data/locales/en.assistant.yml

@@ -4,4 +4,8 @@ en:
       sysop:
         role: "You are a software agent inside my computer"
       coder:
-        role: "You are a professional %s programmer inside my computer"
+        role: "You are a professional %s programmer inside my computer"
+      localizer:
+        role: "You are a professional localizer (translator) to the %s language inside my computer. Your task is to correctly localize files (create new ones in the required language based on the original) provided by the user."
+        source: "Use the %s language as a basis"
+        locale: "For the %s language, the correct locale is :%s"

data/locales/ru.assistant.yml

@@ -5,3 +5,7 @@ ru:
         role: Ты программный агент внутри моего компьютера
       coder:
         role: "Ты профессиональный программист на %s внутри моего компьютера"
+      localizer:
+        role: "Ты профессиональный локализатор (переводчик) на %s язык внутри моего компьютера. Твоя задача корректно локализовать файлы (создать по аналогии новые на нужном языке), которые предоставит пользователь."
+        source: "Возьми за основу %s язык"
+        locale: "Для %s языка верная локаль :%s"

data/template/my_assistant.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rainbow'
+require 'colorize'
 require_relative 'tools/my_tool'
 
 class MyAssistant
@@ -11,10 +11,10 @@ class MyAssistant
       worker: init_worker(delayed: delayed, model: model),
       role: 'You are a software agent inside my computer',
       tools: [MyTool.new],
-      on_inner_monologue: ->(text:) { puts Rainbow("monologue: #{text}").yellow },
-      on_outer_voice: ->(text:) { puts Rainbow("voice: #{text}").green },
-      on_action_request: ->(text:) { puts Rainbow("action: #{text}").red },
-      on_pack_history: ->(text:) { puts Rainbow("summary: #{text}").blue }
+      on_inner_monologue: ->(text:) { puts "monologue: #{text}".colorize(:yellow) },
+      on_outer_voice: ->(text:) { puts "voice: #{text}".colorize(:green) },
+      on_action_request: ->(text:) { puts "action: #{text}".colorize(:red) },
+      on_pack_history: ->(text:) { puts "summary: #{text}".colorize(:blue) }
     )
   end
 end

data/template/start

@@ -22,6 +22,8 @@ OxAiWorkers.configure do |config|
   config.model = 'gpt-4o-mini'
 end
 
+# OxAiWorkers.logger.level = :debug
+
 # Main algorithm
 @assistant = MyAssistant.new
 @assistant.task = '2 + 2 is ?'

data/template/tools/my_tool.rb

@@ -9,7 +9,7 @@ class MyTool
   end
 
   def sh(input:)
-    puts "Executing sh: \"#{input}\""
+    OxAiWorkers.logger.info("Executing sh: \"#{input}\"", for: self.class)
     stdout_and_stderr_s, = Open3.capture2e(input)
     stdout_and_stderr_s
   end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: ox-ai-workers
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Denis Smolev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-30 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: faraday-multipart
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: i18n
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: ptools
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: ptools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
@@ -135,9 +135,11 @@ files:
 - exe/start
 - lib/ox-ai-workers.rb
 - lib/oxaiworkers/assistant/coder.rb
+- lib/oxaiworkers/assistant/localizer.rb
 - lib/oxaiworkers/assistant/module_base.rb
 - lib/oxaiworkers/assistant/sysop.rb
 - lib/oxaiworkers/compatibility.rb
+- lib/oxaiworkers/contextual_logger.rb
 - lib/oxaiworkers/delayed_request.rb
 - lib/oxaiworkers/dependency_helper.rb
 - lib/oxaiworkers/iterator.rb