ox-ai-workers 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b83e9d2c4e62f4e457a1cb4cf041da04bb0af0abb324bc6138ffa528b39a9a0b
-  data.tar.gz: fc6ee779728aebe0507d58a576968f5f8f4c1c57da8863d95d78420fe7616ff8
+  metadata.gz: 67dfa0fc5c5cb3c3c223615ec1386324b1a71fdc38d90db9b78c6c94f0136add
+  data.tar.gz: 555689bc0e7d83a854f0614d13aed065b2634bdf4501a9aa2025fc40736db398
 SHA512:
-  metadata.gz: 5a6395486f158fb8a8f1ed302e2fe17484a551426a050448f0112fb851457afcb0c3a11523ec1a6d70f4bf02c2b7b884744d0926b16d2ce4cd53a0b6e74f576f
-  data.tar.gz: cb6532ed38d70d74a5c50526324b00e33514d524ac222921015fc3695c83952b3a219603c5b27890089f71f26f33a65ed0498e2c740fb2357e6abb5701bb0ac4
+  metadata.gz: 374c51ea659b98605131b46e1ffbffbfc3ec5d9d6c5718f64952e630e2a14adec56412776eadc4c074ead54c8197fc0195b9590dd76d0737dd7fff347b5ab236
+  data.tar.gz: 21714fc9c30d3159c756ce53840a598c163bca8547e7425e86ffd6ef86c78b5c3563c3a5b5d415420d3141c45d68c87f289d55436796bfa17cc83e4a4b963ab9

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 ## [Unreleased]
 
+- def_except and def_only for `Iterator`
+- Renamed on_pack_history to on_summarize
+- Renamed all "pack_history" to "summarize"
+
 ## [0.5.3] - 2024-07-31
 
 - Fixed summarize state
+- Added `auto_execute` for `Iterator`
+- Added `steps` for `Iterator`
 
 ## [0.5.2] - 2024-07-31
 

data/README.md

@@ -1,7 +1,7 @@
-[![Gem Version](https://badge.fury.io/rb/ox-ai-workers.svg)](https://rubygems.org/gems/ox-ai-workers)
-
 # OxAiWorkers (ox-ai-workers)
 
+[![Gem Version](https://badge.fury.io/rb/ox-ai-workers.svg)](https://rubygems.org/gems/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.
 
 ## Installation
@@ -88,6 +88,7 @@ OxAiWorkers.configure do |config|
     config.model = "gpt-4o"
     config.max_tokens = 4096
     config.temperature = 0.7
+    config.auto_execute = true
 end
 ```
 
@@ -95,7 +96,7 @@ Then you can create an assistant like this:
 
 ```ruby
 assistant = OxAiWorkers::Assistant::Sysop.new()
-assistant.task = "your task"
+assistant.task = "Remove all cron jobs."
 
 # Provide a response to the assistant's question
 assistant.add_response("blah-blah-blah")
@@ -114,7 +115,7 @@ iterator = OxAiWorkers::Iterator.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) }
+    on_summarize: ->(text:) { puts "summary: #{text}".colorize(:blue) }
   )
 
 iterator.add_task("Show files in current directory.")
@@ -124,6 +125,30 @@ 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.
 
+### Advanced instructions for your Assistant
+
+```ruby
+steps = []
+steps << 'Step 1. Develop your own solution to the problem, taking initiative and making assumptions.'
+steps << "Step 2. Enclose all your developments from the previous step in the #{OxAiWorkers::Iterator.full_function_name(:inner_monologue)} function."
+steps << 'Step 3. Call the necessary functions one after another until the desired result is achieved.'
+steps << "Step 4. When all intermediate steps are completed and the exact content of previous messages is no longer relevant, use the #{OxAiWorkers::Iterator.full_function_name(:summarize)} function."
+steps << "Step 5. When the solution is ready, notify about it and wait for the user's response."
+
+@iterator = OxAiWorkers::Iterator.new(
+  worker: init_worker(delayed: delayed, model: model),
+  role: 'You are a software agent inside my computer',
+  tools: [MyTool.new],
+  steps: steps,
+  # def_except: [:summarize], # It's except steps with that functions
+  # def_only: [:inner_monologue, :outer_voice], # Use it only with your steps
+  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_summarize: ->(text:) { puts "summary: #{text}".colorize(:blue) }
+)
+```
+
 ### Worker Options
 
 As a worker, you can use different classes depending on your needs:
@@ -142,7 +167,7 @@ As a worker, you can use different classes depending on your needs:
 oxaiworkers init
 ```
 
-This will create a `.oxaiworkers-local` directory with the necessary initial source code. 
+This will create a `.oxaiworkers-local` directory with the necessary initial source code.
 
 Additionally, you can initialize a more comprehensive example using the command:
 
@@ -176,7 +201,7 @@ OxAiWorkers.logger.level = :debug
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/neonix20b/ox-ai-workers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/neonix20b/ox-ai-workers/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/neonix20b/ox-ai-workers>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/neonix20b/ox-ai-workers/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -184,4 +209,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the OxAiWorkers project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/neonix20b/ox-ai-workers/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the OxAiWorkers project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/neonix20b/ox-ai-workers/blob/main/CODE_OF_CONDUCT.md).

data/lib/ox-ai-workers.rb

@@ -39,13 +39,14 @@ module OxAiWorkers
   class ConfigurationError < Error; end
 
   class Configuration
-    attr_accessor :model, :max_tokens, :temperature, :access_token
+    attr_accessor :model, :max_tokens, :temperature, :access_token, :auto_execute
 
     def initialize
       @access_token = nil
       @model = DEFAULT_MODEL
       @max_tokens = DEFAULT_MAX_TOKEN
       @temperature = DEFAULT_TEMPERATURE
+      @auto_execute = true
 
       [Array, NilClass, String, Symbol, Hash].each do |c|
         c.send(:include, OxAiWorkers::PresentCompat) unless c.method_defined?(:present?)

data/lib/oxaiworkers/assistant/coder.rb

@@ -13,7 +13,7 @@ module OxAiWorkers
           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) }
+          on_summarize: ->(text:) { puts "summary: #{text}".colorize(:blue) }
         )
       end
     end

data/lib/oxaiworkers/assistant/localizer.rb

@@ -13,7 +13,7 @@ module OxAiWorkers
           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) }
+          on_summarize: ->(text:) { puts "summary: #{text}".colorize(:blue) }
         )
         @iterator.add_context(format(I18n.t('oxaiworkers.assistant.localizer.source'), source))
 

data/lib/oxaiworkers/assistant/module_base.rb

@@ -14,6 +14,10 @@ module OxAiWorkers
         @iterator.add_task text
       end
 
+      def execute
+        @iterator.execute
+      end
+
       def init_worker(delayed:, model:)
         worker = delayed ? DelayedRequest.new : Request.new
         worker.model = model || OxAiWorkers.configuration.model

data/lib/oxaiworkers/assistant/sysop.rb

@@ -13,7 +13,7 @@ module OxAiWorkers
           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) }
+          on_summarize: ->(text:) { puts "summary: #{text}".colorize(:blue) }
         )
       end
     end

data/lib/oxaiworkers/iterator.rb

@@ -2,9 +2,11 @@
 
 module OxAiWorkers
   class Iterator < OxAiWorkers::StateTools
+    ITERATOR_FUNCTIONS = %i[inner_monologue outer_voice action_request summarize].freeze
+
     extend OxAiWorkers::ToolDefinition
     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
+    attr_accessor :on_inner_monologue, :on_outer_voice, :on_action_request, :on_summarize, :def_except, :def_only
 
     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'),
@@ -20,22 +22,24 @@ module OxAiWorkers
                         required: true
     end
 
-    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
+    define_function :summarize, description: I18n.t('oxaiworkers.iterator.summarize.description') do
+      property :text, type: 'string', description: I18n.t('oxaiworkers.iterator.summarize.text'), required: true
     end
 
     def initialize(worker:, role: nil, tools: [], on_inner_monologue: nil, on_outer_voice: nil, on_action_request: nil,
-                   on_pack_history: nil)
+                   on_summarize: nil, steps: nil, def_except: [], def_only: nil)
       @worker = worker
-      @tools = [self] + tools
+      @tools = tools
       @role = role
       @context = []
-      @monologue = I18n.t('oxaiworkers.iterator.monologue')
+      @def_only = def_only || ITERATOR_FUNCTIONS
+      @def_except = def_except
+      @monologue = steps || I18n.t('oxaiworkers.iterator.monologue')
 
       @on_inner_monologue = on_inner_monologue
       @on_outer_voice = on_outer_voice
       @on_action_request = on_action_request
-      @on_pack_history = on_pack_history
+      @on_summarize = on_summarize
 
       cleanup
 
@@ -61,6 +65,7 @@ module OxAiWorkers
     def outer_voice(text:)
       # @queue.pop
       @queue << { role: :assistant, content: text.to_s }
+      complete! unless available_defs.include?(:action_request)
       @on_outer_voice&.call(text: text)
       nil
     end
@@ -77,11 +82,11 @@ module OxAiWorkers
     def summarize(text:)
       @milestones << text.to_s
       @messages = []
-      @queue << { role: :assistant, content: I18n.t('oxaiworkers.iterator.pack_history.result') }
+      @queue << { role: :assistant, content: I18n.t('oxaiworkers.iterator.summarize.result') }
       @worker.finish
       rebuild_worker
-      # complete! if can_complete?
-      @on_pack_history&.call(text: text)
+      complete! if can_complete?
+      @on_summarize&.call(text: text)
       nil
     end
 
@@ -93,12 +98,21 @@ module OxAiWorkers
     def rebuild_worker
       @worker.messages = []
       @worker.append(role: :system, content: @role) if @role.present?
-      @worker.append(role: :system, content: @monologue.join("\n"))
+      @worker.append(role: :system, content: valid_monologue.join("\n"))
       @worker.append(messages: @context) if @context.present?
       @tasks.each { |task| @worker.append(role: :user, content: task) }
       @milestones.each { |milestone| @worker.append(role: :assistant, content: milestone) }
       @worker.append(messages: @messages)
-      @worker.tools = @tools.map { |tool| tool.class.function_schemas.to_openai_format }.flatten if @tools.present?
+      @worker.tools = self.class.function_schemas.to_openai_format(only: available_defs)
+      @worker.tools += @tools.map { |tool| tool.class.function_schemas.to_openai_format }.flatten if @tools.present?
+    end
+
+    def available_defs
+      @def_only - @def_except
+    end
+
+    def valid_monologue
+      @monologue.reject { |item| @def_except.any? { |fun| item.include?(self.class.full_function_name(fun)) } }
     end
 
     def next_iteration
@@ -123,12 +137,12 @@ module OxAiWorkers
       if @worker.tool_calls.present?
         @queue << { role: :assistant, content: @worker.tool_calls_raw.to_s }
         @worker.tool_calls.each do |external_call|
-          tool = @tools.select do |t|
+          tool = ([self] + @tools).select do |t|
             t.class.tool_name == external_call[:class] && t.respond_to?(external_call[:name])
           end.first
           unless tool.nil?
             out = tool.send(external_call[:name], **external_call[:args])
-            @queue << { role: :user, content: out.to_s } if out.present?
+            @queue << { role: :system, content: out.to_s } if out.present?
           end
         end
         @worker.finish
@@ -143,10 +157,10 @@ module OxAiWorkers
       @worker.finish
     end
 
-    def add_task(task, auto_execute: true)
+    def add_task(task)
       @tasks << task
       @messages << { role: :user, content: task }
-      execute if auto_execute
+      execute if OxAiWorkers.configuration.auto_execute
     end
 
     def add_context(text, role: :system)

data/lib/oxaiworkers/tool_definition.rb

@@ -63,6 +63,10 @@ module OxAiWorkers::ToolDefinition
       .downcase
   end
 
+  def full_function_name(fun)
+    function_schemas.function_name(fun)
+  end
+
   # Manages schemas for functions
   class FunctionSchemas
     def initialize(tool_name)
@@ -70,6 +74,10 @@ module OxAiWorkers::ToolDefinition
       @tool_name = tool_name
     end
 
+    def function_name method_name
+      "#{@tool_name}__#{method_name}"
+    end
+
     # Adds a function to the schemas
     #
     # @param method_name [Symbol] Name of the method to add
@@ -77,7 +85,7 @@ module OxAiWorkers::ToolDefinition
     # @yield Block that defines the parameters for the function
     # @raise [ArgumentError] If a block is defined and no parameters are specified for the function
     def add_function(method_name:, description:, &)
-      name = "#{@tool_name}__#{method_name}"
+      name = function_name(method_name)
 
       if block_given?
         parameters = ParameterBuilder.new(parent_type: "object").build(&)
@@ -96,15 +104,23 @@ module OxAiWorkers::ToolDefinition
     # Converts schemas to OpenAI-compatible format
     #
     # @return [String] JSON string of schemas in OpenAI format
-    def to_openai_format
-      @schemas.values#.map { |schema| schema[:function] }
+    def to_openai_format(only: nil)
+      valid_schemas(only: only).values
+    end
+
+    def valid_schemas(only: nil)
+      if only.nil?
+        @schemas
+      else
+        @schemas.select { |name, schema| only.include?(name) }
+      end
     end
 
     # Converts schemas to Anthropic-compatible format
     #
     # @return [String] JSON string of schemas in Anthropic format
-    def to_anthropic_format
-      @schemas.values.map do |schema|
+    def to_anthropic_format(only: nil)
+      valid_schemas(only: only).values.map do |schema|
         schema[:function].transform_keys("parameters" => "input_schema")
       end
     end
@@ -112,8 +128,8 @@ module OxAiWorkers::ToolDefinition
     # Converts schemas to Google Gemini-compatible format
     #
     # @return [String] JSON string of schemas in Google Gemini format
-    def to_google_gemini_format
-      @schemas.values.map { |schema| schema[:function] }
+    def to_google_gemini_format(only: nil)
+      valid_schemas(only: only).values.map { |schema| schema[:function] }
     end
   end
 

data/lib/oxaiworkers/version.rb

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

data/locales/en.iterator.yml

@@ -10,7 +10,7 @@ en:
       action_request:
         description: A function for interactive interaction with the user. Allows you to ask a clarifying question, request actions, or complete the current step. The function waits for the user's response and returns it.
         action: Text of the request or action
-      pack_history:
+      summarize:
         description: The function saves key facts, nuances, and actions from previous messages, including the provided response. After calling this function, all previous messages will be deleted. Use it only after all intermediate steps are completed and when the exact content of previous messages is no longer relevant.
         text: Enumeration of important facts and nuances
         result: Messages deleted
@@ -18,5 +18,5 @@ en:
         - Step 1. Develop your own solution to the problem, taking initiative and making assumptions.
         - Step 2. Enclose all your developments from the previous step in the ox_ai_workers_iterator__inner_monologue function.
         - Step 3. Call the necessary functions one after another until the desired result is achieved.
-        - Step 4. When all intermediate steps are completed and the exact content of previous messages is no longer relevant, use the ox_ai_workers_iterator__pack_history function.
+        - Step 4. When all intermediate steps are completed and the exact content of previous messages is no longer relevant, use the ox_ai_workers_iterator__summarize function.
         - Step 5. When the solution is ready, notify about it and wait for the user's response.

data/locales/ru.iterator.yml

@@ -10,7 +10,7 @@ ru:
       action_request:
         description: Функция для интерактивного взаимодействия с пользователем. Позволяет задать уточняющий вопрос, запросить выполнение действий или завершить текущий шаг. Функция ожидает ответ пользователя и возвращает его.
         action: Текст запроса или действия
-      pack_history:
+      summarize:
         description: Функция сохраняет ключевые факты, нюансы и действия из предыдущих сообщений, включая предоставленный ответ. После вызова этой функции все предыдущие сообщения будут удалены. Используйте её только после завершения всех промежуточных шагов и когда точное содержание предыдущих сообщений больше не имеет значения.
         text: Перечисление важных фактов и нюансов
         result: Сообщения удалены
@@ -18,5 +18,5 @@ ru:
         - Шаг 1. Разработай собственное решение проблемы, проявляя инициативу и делая предположения.
         - Шаг 2. Заключи все свои наработки из предыдущего шага в функцию ox_ai_workers_iterator__inner_monologue.
         - Шаг 3. Вызывай необходимые функции друг за другом, пока желаемый результат не будет достигнут.
-        - Шаг 4. Когда все промежуточные шаги завершены и точное содержание предыдущих сообщений больше не имеет значения, используй функцию ox_ai_workers_iterator__pack_history.
+        - Шаг 4. Когда все промежуточные шаги завершены и точное содержание предыдущих сообщений больше не имеет значения, используй функцию ox_ai_workers_iterator__summarize.
         - Шаг 5. Когда решение готово, сообщи об этом и ожидай ответ пользователя.

data/template/my_assistant.rb

@@ -7,14 +7,23 @@ class MyAssistant
   include OxAiWorkers::Assistant::ModuleBase
 
   def initialize(delayed: false, model: nil)
+    # Optional instructions
+    # steps = []
+    # steps << 'Step 1. Develop your own solution to the problem, taking initiative and making assumptions.'
+    # steps << "Step 2. Enclose all your developments from the previous step in the #{OxAiWorkers::Iterator.full_function_name(:inner_monologue)} function."
+    # steps << 'Step 3. Call the necessary functions one after another until the desired result is achieved.'
+    # steps << "Step 4. When all intermediate steps are completed and the exact content of previous messages is no longer relevant, use the #{OxAiWorkers::Iterator.full_function_name(:summarize)} function."
+    # steps << "Step 5. When the solution is ready, notify about it and wait for the user's response."
+
     @iterator = OxAiWorkers::Iterator.new(
       worker: init_worker(delayed: delayed, model: model),
       role: 'You are a software agent inside my computer',
       tools: [MyTool.new],
+      # steps: steps,
       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) }
+      on_summarize: ->(text:) { puts "summary: #{text}".colorize(:blue) }
     )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ox-ai-workers
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Denis Smolev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-31 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize