ox-ai-workers 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c6a4642d2f20a5544eb56eb31b2ecb26a190565711f6257793fc5320f4c46ef
-  data.tar.gz: 480d67e601de4af89a947cb1951aa81ab04be079073cb6d50fc0b353e780300b
+  metadata.gz: e39a685e524452b7b7aa6547817f9e81c522c8fa8f48c35c4745322986e57e5e
+  data.tar.gz: 5f1fd1aaa0c019be6fc06cc607d963909a3e244c371b03ecb74aa5b48c7e507d
 SHA512:
-  metadata.gz: 6dfbee661da05077107165b65130ef4540aec31e9bfd7b94052f6ce0e068de593651bdcedaae6e3cdebec289d4d9011ddc0da3a8445b0ea0bce52d797e2a7041
-  data.tar.gz: e915d590643c6db03154384e66def40bc3e8b8dd91965dade1c6f3706fc3a874bd7d54301a3de4120b25da8f80f363204b08d8172676750fcb9c6cc965d39e49
+  metadata.gz: 1ae293da7bd885026371f173336efaa6de81714c86607c4013bee836222722c0be19f9b77099b3ffab0b064b8e954c60f8de64d65fb9afd99950ac98a5be2053
+  data.tar.gz: b0a9bb36f6b9ec5b123934f698017ac65306212ef9467b9623b1de3fad43cf3e1e4c3a2b78069ba35de72e94d197e0f05cf20bc33c2c1fb902a370b8483b489a

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 ## [Unreleased]
 
+## [0.5.0] - 2024-07-30
+
+- snake_cased function names
+
 ## [0.4.2] - 2024-07-30
 
 - Binary reading is suppressed
 - Command output code is returned if the command output is empty
+- Fixed roles when calling functions.
 
 ## [0.4.0] - 2024-07-30
 

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/ox-ai-workers.svg)](https://rubygems.org/gems/ox-ai-workers)
+
 # OxAiWorkers (ox-ai-workers)
 
 OxAiWorkers is a Ruby gem that implements a finite state machine (using the `state_machine` gem) to solve tasks using generative intelligence (with the `ruby-openai` gem). This approach enhances the final result by utilizing internal monologue and external tools.
@@ -39,10 +41,10 @@ require 'ox-ai-workers'
 sysop = OxAiWorkers::Assistant::Sysop.new(delayed: false, model: "gpt-4o")
 
 # Add a task to the assistant
-sysop.setTask("Add a cron job to synchronize files daily.")
+sysop.task = "Add a cron job to synchronize files daily."
 
 # Provide a response to the assistant's question
-sysop.addResponse("blah-blah-blah")
+sysop.add_response("blah-blah-blah")
 ```
 
 Alternatively, you can use a lower-level approach for more control:
@@ -70,10 +72,10 @@ iterator = OxAiWorkers::Iterator.new(
 iterator.role = "You are a software agent inside my computer"
 
 # Add a task to the iterator
-iterator.addTask("Show files in current dir")
+iterator.add_task("Show files in current dir")
 
 # Provide a response to the gpt's question
-iterator.addTask("linux")
+iterator.add_task("linux")
 ```
 
 ### With Config
@@ -93,10 +95,10 @@ Then you can create an assistant like this:
 
 ```ruby
 assistant = OxAiWorkers::Assistant::Sysop.new()
-assistant.setTask("your task")
+assistant.task = "your task"
 
 # Provide a response to the assistant's question
-assistant.addResponse("blah-blah-blah")
+assistant.add_response("blah-blah-blah")
 ```
 
 Or you can create a lower-level iterator for more control:
@@ -115,9 +117,9 @@ iterator = OxAiWorkers::Iterator.new(
     on_pack_history: ->(text:) { puts Rainbow("summary: #{text}").blue } 
   )
 
-iterator.addTask("Show files in current directory.")
+iterator.add_task("Show files in current directory.")
 # ...
-iterator.addTask("linux")
+iterator.add_task("linux")
 ```
 
 This way, you have the flexibility to choose between a higher-level assistant for simplicity or a lower-level iterator for finer control over the tasks and tools used.
@@ -185,11 +187,11 @@ en:
         text: "Listing important facts and nuances"
       monologue:
         - "Step 1: Develop your own solution to the problem. Take initiative and make assumptions."
-        - "Step 1.1: Wrap all your work for this step in the innerMonologue function."
+        - "Step 1.1: Wrap all your work for this step in the inner_monologue function."
         - "Step 2: Relate your solution to the task, improve it, and call the necessary functions step by step."
-        - "Step 2.1: Interact with the user using the outerVoice and actionRequest functions during the process."
-        - "Step 3: When the solution is ready, report it using the outerVoice function."
-        - "Step 4: Save facts, nuances, and actions using the packHistory function."
+        - "Step 2.1: Interact with the user using the outer_voice and action_request functions during the process."
+        - "Step 3: When the solution is ready, report it using the outer_voice function."
+        - "Step 4: Save facts, nuances, and actions using the summarize function."
     tool:
       eval:
         ruby:

data/exe/start

@@ -5,7 +5,6 @@
 # require 'oxaiworkers/load_i18n'
 # I18n.default_locale = :ru
 
-# Start your code here
 require 'ox-ai-workers'
 require 'irb'
 

data/lib/oxaiworkers/assistant/coder.rb

@@ -7,7 +7,7 @@ module OxAiWorkers
 
       def initialize(delayed: false, model: nil, language: 'ruby')
         @iterator = Iterator.new(
-          worker: initWorker(delayed: delayed, model: model),
+          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 },

data/lib/oxaiworkers/assistant/module_base.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 module OxAiWorkers
   module Assistant
     module ModuleBase
       attr_accessor :iterator
 
-      def setTask(task)
+      def task=(task)
         @iterator.cleanup
-        @iterator.addTask task
+        @iterator.add_task task
       end
 
-      def addResponse(text)
-        @iterator.addTask text
+      def add_response(text)
+        @iterator.add_task text
       end
 
-      def initWorker(delayed:, model:)
+      def init_worker(delayed:, model:)
         worker = delayed ? DelayedRequest.new : Request.new
         worker.model = model || OxAiWorkers.configuration.model
         worker

data/lib/oxaiworkers/assistant/sysop.rb

@@ -7,7 +7,7 @@ module OxAiWorkers
 
       def initialize(delayed: false, model: nil)
         @iterator = Iterator.new(
-          worker: initWorker(delayed: delayed, model: model),
+          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 },

data/lib/oxaiworkers/delayed_request.rb

@@ -3,14 +3,14 @@
 module OxAiWorkers
   class DelayedRequest < OxAiWorkers::StateBatch
     def initialize(batch_id: nil, model: nil, max_tokens: nil, temperature: nil)
-      initializeRequests(model: model, max_tokens: max_tokens, temperature: temperature)
+      initialize_requests(model: model, max_tokens: max_tokens, temperature: temperature)
       @custom_id = nil if batch_id.present?
       @batch_id = batch_id
       @file_id = nil
       super()
     end
 
-    def postBatch
+    def post_batch
       response = @client.batches.create(
         parameters: {
           input_file_id: @file_id,
@@ -21,11 +21,11 @@ module OxAiWorkers
       @batch_id = response['id']
     end
 
-    def cancelBatch
+    def cancel_batch
       not_found_is_ok { @client.batches.cancel(id: @batch_id) }
     end
 
-    def cleanStorage
+    def clean_storage
       if @batch_id.present?
         batch = @client.batches.retrieve(id: @batch_id)
         if !batch['output_file_id'].nil?
@@ -49,7 +49,7 @@ module OxAiWorkers
       end_batch! unless batch_idle?
     end
 
-    def uploadToStorage
+    def upload_to_storage
       item = {
         "custom_id": @custom_id,
         "method": 'POST',
@@ -96,7 +96,7 @@ module OxAiWorkers
         output.each do |line|
           @custom_id = line['custom_id']
           # @result = line.dig("response", "body", "choices", 0, "message", "content")
-          parseChoices(line.dig('response', 'body'))
+          parse_choices(line.dig('response', 'body'))
           complete_batch!
         end
       elsif !batch['error_file_id'].nil?

data/lib/oxaiworkers/iterator.rb

@@ -6,21 +6,21 @@ module OxAiWorkers
     attr_accessor :worker, :role, :messages, :context, :result, :tools, :queue, :monologue, :tasks, :milestones
     attr_accessor :on_inner_monologue, :on_outer_voice, :on_action_request, :on_pack_history
 
-    define_function :innerMonologue, description: I18n.t('oxaiworkers.iterator.inner_monologue.description') do
+    define_function :inner_monologue, description: I18n.t('oxaiworkers.iterator.inner_monologue.description') do
       property :speach, type: 'string', description: I18n.t('oxaiworkers.iterator.inner_monologue.speach'),
                         required: true
     end
 
-    define_function :outerVoice, description: I18n.t('oxaiworkers.iterator.outer_voice.description') do
+    define_function :outer_voice, description: I18n.t('oxaiworkers.iterator.outer_voice.description') do
       property :text, type: 'string', description: I18n.t('oxaiworkers.iterator.outer_voice.text'), required: true
     end
 
-    define_function :actionRequest, description: I18n.t('oxaiworkers.iterator.action_request.description') do
+    define_function :action_request, description: I18n.t('oxaiworkers.iterator.action_request.description') do
       property :action, type: 'string', description: I18n.t('oxaiworkers.iterator.action_request.action'),
                         required: true
     end
 
-    define_function :packHistory, description: I18n.t('oxaiworkers.iterator.pack_history.description') do
+    define_function :summarize, description: I18n.t('oxaiworkers.iterator.pack_history.description') do
       property :text, type: 'string', description: I18n.t('oxaiworkers.iterator.pack_history.text'), required: true
     end
 
@@ -49,24 +49,24 @@ module OxAiWorkers
       @tasks = []
       @milestones = []
       @messages = []
-      completeIteration
+      complete_iteration
     end
 
-    def innerMonologue(speach:)
+    def inner_monologue(speach:)
       # @queue.pop
       @queue << { role: :system, content: speach.to_s }
       @on_inner_monologue&.call(text: speach)
       nil
     end
 
-    def outerVoice(text:)
+    def outer_voice(text:)
       # @queue.pop
       @queue << { role: :system, content: text.to_s }
       @on_outer_voice&.call(text: text)
       nil
     end
 
-    def actionRequest(action:)
+    def action_request(action:)
       @result = action
       # @queue.pop
       @messages << { role: :system, content: action.to_s }
@@ -75,11 +75,11 @@ module OxAiWorkers
       nil
     end
 
-    def packHistory(text:)
+    def summarize(text:)
       @milestones << text.to_s
       @messages = []
       @worker.finish
-      rebuildWorker
+      rebuild_worker
       complete! if can_complete?
       @on_pack_history&.call(text: text)
       nil
@@ -87,11 +87,11 @@ module OxAiWorkers
 
     def init
       puts "call: #{__method__} state: #{state_name}"
-      rebuildWorker
+      rebuild_worker
       request!
     end
 
-    def rebuildWorker
+    def rebuild_worker
       @worker.messages = []
       @worker.append(role: :system, content: @role) if !@role.nil? && @role.present?
       @worker.append(role: :system, content: @monologue.join("\n"))
@@ -102,7 +102,7 @@ module OxAiWorkers
       @worker.tools = @tools.map { |tool| tool.class.function_schemas.to_openai_format }.flatten if @tools.any?
     end
 
-    def nextIteration
+    def next_iteration
       puts "call: #{__method__} state: #{state_name}"
       @worker.append(messages: @queue)
       @messages += @queue
@@ -110,7 +110,7 @@ module OxAiWorkers
       request!
     end
 
-    def externalRequest
+    def external_request
       puts "call: #{__method__} state: #{state_name}"
       @worker.request!
       ticker
@@ -122,7 +122,7 @@ module OxAiWorkers
       analyze!
     end
 
-    def processResult(_transition)
+    def process_result(_transition)
       puts "call: #{__method__} state: #{state_name}"
       @result = @worker.result || @worker.errors
       if @worker.tool_calls.present?
@@ -146,22 +146,22 @@ module OxAiWorkers
         #   iterate!
         # end
       elsif @worker.result.present?
-        actionRequest action: @worker.result
+        action_request action: @worker.result
       end
     end
 
-    def completeIteration
+    def complete_iteration
       @queue = []
       @worker.finish
     end
 
-    def addTask(task, auto_execute: true)
+    def add_task(task, auto_execute: true)
       @tasks << task
       @messages << { role: :user, content: task }
       execute if auto_execute
     end
 
-    def appendContext(text, role: :system)
+    def append_context(text, role: :system)
       @context << { role: role, content: text }
     end
 

data/lib/oxaiworkers/module_request.rb

@@ -5,7 +5,7 @@ module OxAiWorkers
     attr_accessor :result, :client, :messages, :model, :max_tokens, :custom_id, :temperature, :tools, :errors,
                   :tool_calls_raw, :tool_calls
 
-    def initializeRequests(model: nil, max_tokens: nil, temperature: nil)
+    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
@@ -60,7 +60,7 @@ module OxAiWorkers
       nil
     end
 
-    def parseChoices(response)
+    def parse_choices(response)
       # puts response.inspect
       @tool_calls = []
       @result = response.dig('choices', 0, 'message', 'content')

data/lib/oxaiworkers/present_compat.rb

@@ -11,9 +11,9 @@ module OxAiWorkers
     def camelize(first_letter = :upper)
       string = dup
       string = if first_letter == :upper
-                 string.sub(/^[a-z\d]*/) { |match| match.capitalize }
+                 string.sub(/^[a-z\d]*/, &:capitalize)
                else
-                 string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { |match| match.downcase }
+                 string.sub(/^(?:(?=\b|[A-Z_])|\w)/, &:downcase)
                end
       string.gsub(%r{(?:_|(/))([a-z\d]*)}) do
         "#{::Regexp.last_match(1)}#{::Regexp.last_match(2).capitalize}"

data/lib/oxaiworkers/request.rb

@@ -2,7 +2,7 @@
 
 module OxAiWorkers
   class Request < OxAiWorkers::ModuleRequest
-    alias initialize initializeRequests
+    alias initialize initialize_requests
 
     def finish
       @custom_id = SecureRandom.uuid
@@ -11,7 +11,7 @@ module OxAiWorkers
 
     def request!
       response = @client.chat(parameters: params)
-      parseChoices(response)
+      parse_choices(response)
       # @result = response.dig("choices", 0, "message", "content")
       # puts response.inspect
     rescue OpenAI::Error => e

data/lib/oxaiworkers/state_batch.rb

@@ -14,10 +14,10 @@ module OxAiWorkers
       before_transition from: any, do: :log_me
 
       after_transition on: :end, do: :cleanup
-      before_transition on: :process, do: :postBatch
-      after_transition on: :cancel, do: %i[cancelBatch complete_batch!]
-      after_transition on: :complete, do: [:cleanStorage]
-      after_transition on: :prepare, do: :uploadToStorage
+      before_transition on: :process, do: :post_batch
+      after_transition on: :cancel, do: %i[cancel_batch complete_batch!]
+      after_transition on: :complete, do: [:clean_storage]
+      after_transition on: :prepare, do: :upload_to_storage
 
       event :end do
         transition %i[finished canceled] => :idle

data/lib/oxaiworkers/state_tools.rb

@@ -10,11 +10,11 @@ module OxAiWorkers
     state_machine :state, initial: :idle do
       before_transition from: any, do: :log_me
 
-      after_transition on: :iterate, do: :nextIteration
-      after_transition on: :request, do: :externalRequest
+      after_transition on: :iterate, do: :next_iteration
+      after_transition on: :request, do: :external_request
       after_transition on: :prepare, do: :init
-      after_transition on: :analyze, do: :processResult
-      after_transition on: :complete, do: :completeIteration
+      after_transition on: :analyze, do: :process_result
+      after_transition on: :complete, do: :complete_iteration
 
       event :prepare do
         transition %i[idle finished] => :prepared

data/lib/oxaiworkers/version.rb

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

data/locales/en.iterator.yml

@@ -15,8 +15,8 @@ en:
         text: "Listing important facts and nuances"
       monologue:
         - "Step 1: Develop your own solution to the problem. Take initiative and make assumptions."
-        - "Step 1.1: Wrap all your work for this step in the ox_ai_workers_iterator__innerMonologue function."
+        - "Step 1.1: Wrap all your work for this step in the ox_ai_workers_iterator__inner_monologue function."
         - "Step 2: Relate your solution to the task, improve it, and call the necessary functions step by step."
-        - "Step 2.1: Interact with the user using the ox_ai_workers_iterator__outerVoice and ox_ai_workers_iterator__actionRequest functions during the process."
-        - "Step 3: When the solution is ready, report it using the ox_ai_workers_iterator__outerVoice function."
-        - "Step 4: Save facts, nuances, and actions using the ox_ai_workers_iterator__packHistory function."
+        - "Step 2.1: Interact with the user using the ox_ai_workers_iterator__outer_voice and ox_ai_workers_iterator__action_request functions during the process."
+        - "Step 3: When the solution is ready, report it using the ox_ai_workers_iterator__outer_voice function."
+        - "Step 4: Save facts, nuances, and actions using the ox_ai_workers_iterator__summarize function."

data/locales/ru.iterator.yml

@@ -15,8 +15,8 @@ ru:
         text: Перечисление важных фактов и нюансов
       monologue:
         - Шаг 1. Разработай собственное решение проблемы. Проявляй инициативу и делай предположения. 
-        - Шаг 1.1. Заключи все свои наработки для этого шага в функцию ox_ai_workers_iterator__innerMonologue.
+        - Шаг 1.1. Заключи все свои наработки для этого шага в функцию ox_ai_workers_iterator__inner_monologue.
         - Шаг 2. Соотнеси свое решение с задачей, улучшай его и вызывай необходимые функции шаг за шагом.
-        - Шаг 2.1. Во время работы используй функции ox_ai_workers_iterator__outerVoice и ox_ai_workers_iterator__actionRequest.
-        - Шаг 3. Когда решение готово, сообщи о нем с помощью функции ox_ai_workers_iterator__outerVoice
-        - Шаг 4. Сохрани факты, нюансы и действия с помощью функции ox_ai_workers_iterator__packHistory и предложи дальнейшие действия с помощью функции ox_ai_workers_iterator__actionRequest.
+        - Шаг 2.1. Во время работы используй функции ox_ai_workers_iterator__outer_voice и ox_ai_workers_iterator__action_request.
+        - Шаг 3. Когда решение готово, сообщи о нем с помощью функции ox_ai_workers_iterator__outer_voice
+        - Шаг 4. Сохрани факты, нюансы и действия с помощью функции ox_ai_workers_iterator__summarize и предложи дальнейшие действия с помощью функции ox_ai_workers_iterator__action_request.

data/template/my_assistant.rb

@@ -8,7 +8,7 @@ class MyAssistant
 
   def initialize(delayed: false, model: nil)
     @iterator = OxAiWorkers::Iterator.new(
-      worker: initWorker(delayed: delayed, model: model),
+      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 },

data/template/start

@@ -24,5 +24,6 @@ end
 
 # Main algorithm
 @assistant = MyAssistant.new
+@assistant.task = '2 + 2 is ?'
 
 IRB.start(__FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ox-ai-workers
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Denis Smolev
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: ptools
+  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: rainbow
   requirement: !ruby/object:Gem::Requirement