ox-ai-workers 0.5.2 → 0.5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b0bc20d6b4c721456a19d590a596d989b10b9dd246027ce586404eb4741946a
-  data.tar.gz: 5fd3e688b4898cb976ebc91f2da315fc3efa22b2a347349e3958373a64426213
+  metadata.gz: 34c154dd79d968e939b91f26e410e0f7a4e51c5099347b3577dc05708ab8b341
+  data.tar.gz: 294f14527bb5ef82e885ee5c93e6577d93c1820f844baad1139fbd385cb895c2
 SHA512:
-  metadata.gz: 98d855e5b18762f1acf4233e646733539e29954331e39501ea053c9641cc049ec15c5830523ee6763775e5a2d65123e6dc910d2c7bac41809fef12d9170f4aa3
-  data.tar.gz: cce07e1dc69d769df0830dc175481996a733d71428de65a6632a4aadae129192004a3b795008c370792baa3fc50dc88f89db6d9ea2a9e4459a66b69a07961bcb
+  metadata.gz: 1f2c528093acd8ef4a6214ef65898807f72172f10e211096cbd490589d04e55220ff679c57cc04dd677ab04a211445fe4eb8cfefbc0beb1b453fcb7282dfabd0
+  data.tar.gz: 14f317606790d54f1c735f437145da15243a86af05c28bfcaf63464929c841df1b4de02cc6326b94571ddb0334a3bd13298ffe78078e39e1c24e7314d386fea7

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.5.3] - 2024-07-31
+
+- Fixed summarize state
+- Added `auto_execute` for `Iterator`
+- Added `steps` for `Iterator`
+
 ## [0.5.2] - 2024-07-31
 
 - Added new assistant: `Localizer`

data/README.md

@@ -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
 ```
 
@@ -124,6 +125,28 @@ 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 ox_ai_workers_iterator__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 ox_ai_workers_iterator__pack_history 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) }
+)
+```
+
 ### Worker Options
 
 As a worker, you can use different classes depending on your needs:
@@ -174,46 +197,6 @@ OxAiWorkers.logger.level = :debug
 - **External Tools**: Integrates with external tools and services to complete tasks.
 - **Finite State Machine**: Implements a robust state machine to manage task states and transitions.
 
-## Configuration
-
-OxAiWorkers uses YAML files for configuration. Below is an example configuration:
-
-```yaml
-en:
-  oxaiworkers:
-    iterator:
-      inner_monologue:
-        description: "Use inner monologue to plan the response and articulate main points"
-        speech: "Text"
-      outer_voice:
-        description: "Provide the user with necessary information without expecting a response"
-        text: "Text"
-      action_request:
-        description: "Ask a clarifying question or request an action with a response from the user"
-        action: "Text"
-      pack_history:
-        description: "Save facts, nuances, and actions before clearing messages"
-        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 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 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:
-          description: "Execute Ruby code and return the result of the last expression"
-          input: "Ruby source code"
-        sh:
-          description: "Execute a sh command and get the result (stdout + stderr)"
-          input: "Source command"
-    assistant:
-      sysop:
-        role: "You are a software agent inside my computer"
-```
-
 ## 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).

data/lib/ox-ai-workers.rb

@@ -28,6 +28,7 @@ require_relative 'oxaiworkers/tool/file_system'
 require_relative 'oxaiworkers/assistant/module_base'
 require_relative 'oxaiworkers/assistant/sysop'
 require_relative 'oxaiworkers/assistant/coder'
+require_relative 'oxaiworkers/assistant/localizer'
 
 module OxAiWorkers
   DEFAULT_MODEL = 'gpt-4o-mini'
@@ -38,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/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/iterator.rb

@@ -25,12 +25,12 @@ module OxAiWorkers
     end
 
     def initialize(worker:, role: nil, tools: [], on_inner_monologue: nil, on_outer_voice: nil, on_action_request: nil,
-                   on_pack_history: nil)
+                   on_pack_history: nil, steps: nil)
       @worker = worker
       @tools = [self] + tools
       @role = role
       @context = []
-      @monologue = I18n.t('oxaiworkers.iterator.monologue')
+      @monologue = steps || I18n.t('oxaiworkers.iterator.monologue')
 
       @on_inner_monologue = on_inner_monologue
       @on_outer_voice = on_outer_voice
@@ -53,14 +53,14 @@ module OxAiWorkers
 
     def inner_monologue(speach:)
       # @queue.pop
-      @queue << { role: :system, content: speach.to_s }
+      @queue << { role: :assistant, content: speach.to_s }
       @on_inner_monologue&.call(text: speach)
       nil
     end
 
     def outer_voice(text:)
       # @queue.pop
-      @queue << { role: :system, content: text.to_s }
+      @queue << { role: :assistant, content: text.to_s }
       @on_outer_voice&.call(text: text)
       nil
     end
@@ -68,7 +68,7 @@ module OxAiWorkers
     def action_request(action:)
       @result = action
       # @queue.pop
-      @messages << { role: :system, content: action.to_s }
+      @messages << { role: :assistant, content: action.to_s }
       complete! if can_complete?
       @on_action_request&.call(text: action)
       nil
@@ -77,6 +77,7 @@ module OxAiWorkers
     def summarize(text:)
       @milestones << text.to_s
       @messages = []
+      @queue << { role: :assistant, content: I18n.t('oxaiworkers.iterator.pack_history.result') }
       @worker.finish
       rebuild_worker
       # complete! if can_complete?
@@ -91,13 +92,13 @@ module OxAiWorkers
 
     def rebuild_worker
       @worker.messages = []
-      @worker.append(role: :system, content: @role) if !@role.nil? && @role.present?
+      @worker.append(role: :system, content: @role) if @role.present?
       @worker.append(role: :system, content: @monologue.join("\n"))
-      @worker.append(messages: @context) if !@context.nil? and @context.any?
+      @worker.append(messages: @context) if @context.present?
       @tasks.each { |task| @worker.append(role: :user, content: task) }
-      @milestones.each { |milestone| @worker.append(role: :system, content: milestone) }
+      @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.any?
+      @worker.tools = @tools.map { |tool| tool.class.function_schemas.to_openai_format }.flatten if @tools.present?
     end
 
     def next_iteration
@@ -127,18 +128,11 @@ module OxAiWorkers
           end.first
           unless tool.nil?
             out = tool.send(external_call[:name], **external_call[:args])
-            @queue << { role: :system, content: out.to_s } if out.present?
+            @queue << { role: :user, content: out.to_s } if out.present?
           end
         end
         @worker.finish
         iterate! if can_iterate?
-
-        # tool = @tools.select{|t| t.class.tool_name == @worker.external_call[:class] && t.respond_to?(@worker.external_call[:name]) }.first
-        # out = tool.send(@worker.external_call[:name], **@worker.external_call[:args])
-        # if can_iterate?
-        #   @queue << {role: :system, content: out.to_s} if out.present?
-        #   iterate!
-        # end
       elsif @worker.result.present?
         action_request action: @worker.result
       end
@@ -149,10 +143,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/version.rb

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

data/locales/en.iterator.yml

@@ -2,21 +2,21 @@ en:
   oxaiworkers:
     iterator:
       inner_monologue:
-        description: "Use inner monologue to plan the response and articulate main points"
-        speech: "Text"
+        description: A function for internal monologue, allowing the AI to ponder and formulate its thoughts without user involvement. Used for intermediate reflections and recording data that do not require immediate response or action from the user.
+        speach: Text of reflections or conclusions
       outer_voice:
-        description: "Provide the user with necessary information without expecting a response"
-        text: "Text"
+        description: Inform the user of the necessary information without expecting a response.
+        text: Content of the message
       action_request:
-        description: "Ask a clarifying question or request an action with a response from the user"
-        action: "Text"
+        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:
-        description: "Save facts, nuances, and actions before clearing messages"
-        text: "Listing important facts and nuances"
+        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
       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__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__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."
+        - 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 5. When the solution is ready, notify about it and wait for the user's response.

data/locales/ru.assistant.yml

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

data/locales/ru.iterator.yml

@@ -2,21 +2,21 @@ ru:
   oxaiworkers:
     iterator:
       inner_monologue:
-        description: Используй внутренний монолог для планирования ответа и проговаривания основных тезисов
-        speach: Текст
+        description: Функция для внутреннего монолога, позволяющая ИИ обдумывать и формулировать свои мысли без участия пользователя. Используется для промежуточных размышлений и фиксации данных, которые не требуют немедленного ответа или действия от пользователя.
+        speach: Текст размышлений или выводов
       outer_voice:
-        description: Сообщить пользователю необходимую информацию без ожидания ответа
-        text: Текст
+        description: Сообщить пользователю необходимую информацию без ожидания ответа.
+        text: Содержимое сообщения
       action_request:
-        description: Задать уточняющий вопрос или попросить о действии с получением ответа от пользователя
-        action: Текст
+        description: Функция для интерактивного взаимодействия с пользователем. Позволяет задать уточняющий вопрос, запросить выполнение действий или завершить текущий шаг. Функция ожидает ответ пользователя и возвращает его.
+        action: Текст запроса или действия
       pack_history:
-        description: Сохранение фактов, нюансов и действий (в том числе что ответ был дан) перед очисткой сообщений
+        description: Функция сохраняет ключевые факты, нюансы и действия из предыдущих сообщений, включая предоставленный ответ. После вызова этой функции все предыдущие сообщения будут удалены. Используйте её только после завершения всех промежуточных шагов и когда точное содержание предыдущих сообщений больше не имеет значения.
         text: Перечисление важных фактов и нюансов
+        result: Сообщения удалены
       monologue:
-        - Шаг 1. Разработай собственное решение проблемы. Проявляй инициативу и делай предположения. 
-        - Шаг 1.1. Заключи все свои наработки для этого шага в функцию ox_ai_workers_iterator__inner_monologue.
-        - Шаг 2. Соотнеси свое решение с задачей, улучшай его и вызывай необходимые функции шаг за шагом.
-        - Шаг 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.
+        - Шаг 1. Разработай собственное решение проблемы, проявляя инициативу и делая предположения.
+        - Шаг 2. Заключи все свои наработки из предыдущего шага в функцию ox_ai_workers_iterator__inner_monologue.
+        - Шаг 3. Вызывай необходимые функции друг за другом, пока желаемый результат не будет достигнут.
+        - Шаг 4. Когда все промежуточные шаги завершены и точное содержание предыдущих сообщений больше не имеет значения, используй функцию ox_ai_workers_iterator__pack_history.
+        - Шаг 5. Когда решение готово, сообщи об этом и ожидай ответ пользователя.

data/template/my_assistant.rb

@@ -7,10 +7,19 @@ 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 ox_ai_workers_iterator__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 ox_ai_workers_iterator__pack_history 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) },

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ox-ai-workers
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3.1
 platform: ruby
 authors:
 - Denis Smolev
@@ -108,17 +108,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
-description: |2
-      OxAiWorkers (ox-ai-workers) is a Ruby gem that provides a powerful and flexible state machine with
-      integration of generative intelligence using the ruby-openai gem. This gem allows you to create state
-      machines for solving complex tasks, enhancing the final result by leveraging internal logic (state machine)
-      and external tools (OpenAI generative intelligence).
+description: |
+  OxAiWorkers (ox-ai-workers) is a Ruby gem that provides a powerful and flexible state machine with
+  integration of generative intelligence using the ruby-openai gem. This gem allows you to create state
+  machines for solving complex tasks, enhancing the final result by leveraging internal logic (state machine)
+  and external tools (OpenAI generative intelligence).
 
-      Features:
-      - State Machine: Easily create and manage state machines to model various states and transitions in your application.
-      - OpenAI Integration: Utilize the capabilities of generative intelligence to make decisions and perform tasks, improving the quality and accuracy of results.
-      - Flexibility and Extensibility: Customize the behavior of the state machine and OpenAI integration according to your needs.
-      - Ease of Use: Intuitive syntax and documentation make it easy to get started with the gem.
+  Features:
+  - State Machine: Easily create and manage state machines to model various states and transitions in your application.
+  - OpenAI Integration: Utilize the capabilities of generative intelligence to make decisions and perform tasks, improving the quality and accuracy of results.
+  - Flexibility and Extensibility: Customize the behavior of the state machine and OpenAI integration according to your needs.
+  - Ease of Use: Intuitive syntax and documentation make it easy to get started with the gem.
 email:
 - smolev@me.com
 executables: