ox-ai-workers 0.5.3 → 0.5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b83e9d2c4e62f4e457a1cb4cf041da04bb0af0abb324bc6138ffa528b39a9a0b
-  data.tar.gz: fc6ee779728aebe0507d58a576968f5f8f4c1c57da8863d95d78420fe7616ff8
+  metadata.gz: 34c154dd79d968e939b91f26e410e0f7a4e51c5099347b3577dc05708ab8b341
+  data.tar.gz: 294f14527bb5ef82e885ee5c93e6577d93c1820f844baad1139fbd385cb895c2
 SHA512:
-  metadata.gz: 5a6395486f158fb8a8f1ed302e2fe17484a551426a050448f0112fb851457afcb0c3a11523ec1a6d70f4bf02c2b7b884744d0926b16d2ce4cd53a0b6e74f576f
-  data.tar.gz: cb6532ed38d70d74a5c50526324b00e33514d524ac222921015fc3695c83952b3a219603c5b27890089f71f26f33a65ed0498e2c740fb2357e6abb5701bb0ac4
+  metadata.gz: 1f2c528093acd8ef4a6214ef65898807f72172f10e211096cbd490589d04e55220ff679c57cc04dd677ab04a211445fe4eb8cfefbc0beb1b453fcb7282dfabd0
+  data.tar.gz: 14f317606790d54f1c735f437145da15243a86af05c28bfcaf63464929c841df1b4de02cc6326b94571ddb0334a3bd13298ffe78078e39e1c24e7314d386fea7

data/CHANGELOG.md

@@ -3,6 +3,8 @@
 ## [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

@@ -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:

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/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
@@ -143,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.3'
+  VERSION = '0.5.3.1'
 end

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.3
+  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: