ox-ai-workers 0.7.2 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acc49f031b04f7f46a59bbeb85fbaf8ec6ede063d6c18c62f07318f00c34da0c
-  data.tar.gz: 3de498797605eacfc2cd5a0c22883d0c7f1be83261e60588284ce197a8008615
+  metadata.gz: 9a6d42d123d2331ff4ebe6fde17c6cd64759933f64940dcf453eca6dc5efb402
+  data.tar.gz: 19bfa6c66009d2856ecb983d7375beceb40a9d1edf0cf7cd304cfa61529450e4
 SHA512:
-  metadata.gz: 395735eb349fa0683f7b78bee1404bb63499945c0eb7e83a34cc293447bf7ea35c05ca196f220b0d793d4406611ad8e4eb25bf58435ca5fc0fbede29344a8e13
-  data.tar.gz: 3e726089eeea1ab240da574bbfab8cdf3d6377a2c695f47ae97f344e9f37a0f7df73fbc6d544f10e7204b001abde17691a289ce20475ef0905d8ab4795995ec4
+  metadata.gz: 638dea1186324159ebbcacd5f3714aa302ba2e6b5a8a4883cda35feb06ae327f96a0e783ff7c007be090de99f157cf2e35b0d0287f228719c278f1dd8cf9c616
+  data.tar.gz: 0713c7d9f42db7873d70023cabafc4b7e0647e2fe59f76f0d469de530d405d67c8677a989d967bad0317891de9a609293995ab5d68ea7382f39d92aaaa739f4d

data/.cursorrules

@@ -0,0 +1,69 @@
+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.
+
+## Architecture Principles
+- The library is built on the finite state machine (FSM) pattern using the 'state_machine' gem
+- Integration with generative models is implemented using the 'ruby-openai' gem
+- DRY (Don't Repeat Yourself) principle is applied throughout all components
+- Modular structure with clear separation of responsibilities between classes
+- Encapsulation of states and transitions in separate classes
+- Implementation of the "Composition" pattern for flexible tool integration
+
+## Core Components
+- `Request` and `DelayedRequest` - classes for executing API requests (immediate and delayed)
+- `Iterator` - main class for iterative task execution with tools
+- `Assistant` - high-level wrappers over Iterator (Sysop, Coder, Localizer, etc.)
+- `Tool` - tools that can be used during task execution (Eval, FileSystem, Database)
+- `ToolDefinition` - module for declaring functions and methods for tools
+- `StateTools` - base class for managing states and transitions
+- `ContextualLogger` - logging system with contextual information support
+
+## Code Conventions
+- Use `snake_case` for method and variable names
+- Functions for generative models should also be in `snake_case` (inner_monologue, outer_voice, etc.)
+- All public methods must have documentation with usage examples
+- Tests are mandatory for all new functions
+- All code comments, CHANGELOG, README, and other documentation must be written in English
+- Use YARD-style documentation for all public methods
+- Maintain a unified code formatting style (Rubocop is recommended)
+- Follow the "Fail fast" principle for early error detection
+
+## Interaction Patterns
+- The system uses internal monologue (inner_monologue) for planning actions
+- External voice (outer_voice) is used for communication with the user
+- Actions (action_request) are executed through tools
+- Summary (summarize) is used to compress dialog history
+- Execution flow management through finite state machine
+- Implementation of callback mechanisms for flexible event handling
+- Isolation of error handling functions at the tool level
+
+## Integration
+- CLI interface through `oxaiworkers init` and `oxaiworkers run` commands
+- Rails support via ActiveRecord for storing delayed requests
+- Configuration through the `OxAiWorkers.configure` block
+- Multilingual support via standard I18n
+- Integration with external APIs through request client templates
+- Delayed execution mechanism via DelayedRequest
+- Support for various language models (OpenAI, Anthropic, Gemini)
+
+## Best Practices
+- Use callbacks to handle various states (on_inner_monologue, on_outer_voice)
+- Handle errors at the tool level, preventing them from interrupting the main execution flow
+- When creating new assistants, inherit from the base Assistant class
+- Use the white_list mechanism to restrict available functions
+- Separate language model requests from result processing logic
+- Practice dependency injection to improve code testability
+- Use localization mechanisms for multilingual support
+
+## Tools Architecture
+- Each tool should be a self-contained module
+- Tools are registered through the `define_function` interface
+- All tools should handle their own errors and return readable messages
+- Use parameter validation at the function definition level
+- Maintain a unified format for return values
+
+## Performance and Scaling
+- Cache API request results when possible
+- Use asynchronous processing for long operations
+- Apply backoff strategies for repeated requests
+- Break large tasks into atomic operations
+- Provide monitoring and profiling mechanisms

data/.ruby-version

@@ -1 +1 @@
-3.3.4
+3.4.1

data/CHANGELOG.md

@@ -1,18 +1,31 @@
-## [0.7.1] - 2024-08-024
+## [0.7.5] - 2024-08-26
+
+- Improved handling of truncated responses in Iterator
+- Updated dependencies
+
+## [0.7.4] - 2024-08-25
+
+- Fixed `finish_it` for `Iterator`
+
+## [0.7.2] - 2024-08-25
+
+- Fixed tool calls in `Iterator`
+
+## [0.7.1] - 2024-08-24
 
 - Added retry for `Iterator`
 
-## [0.7.0] - 2024-08-024
+## [0.7.0] - 2024-08-24
 
 - Added `finish` for `Iterator`
 - Added `after_finish` for `Iterator`
 
-## [0.6.3] - 2024-08-024
+## [0.6.3] - 2024-08-24
 
 - Added `add_raw_context` for `Iterator`
 - Fixed `requested?`
 
-## [0.6.2] - 2024-08-024
+## [0.6.2] - 2024-08-24
 
 - Rails ActiveRecord support
 

data/app/models/task.rb

@@ -0,0 +1,10 @@
+class Task < ApplicationRecord
+  validates :title, presence: true
+  belongs_to :user, optional: true
+
+  enum status: {
+    pending: 0,
+    in_progress: 1,
+    completed: 2
+  }
+end

data/config/locales/en.oxaiworkers.iterator.yml

@@ -14,10 +14,12 @@ en:
         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
+      finish_it:
+        description: Function to complete steps
       monologue:
         - Step %d. Develop your own solution to the problem, taking initiative and making assumptions.
         - Step %d. Enclose all your developments from the previous step in the ox_ai_workers_iterator__inner_monologue function.
         - Step %d. Call the necessary functions one after another until the desired result is achieved.
         - Step %d. 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 %d. When the solution is ready, notify about it and wait for the user's response.
-        - Step %d. In the end, call the ox_ai_workers_iterator__finish function.
+        - Step %d. In the end, call the ox_ai_workers_iterator__finish_it function.

data/config/locales/ru.oxaiworkers.iterator.yml

@@ -14,12 +14,12 @@ ru:
         description: Функция сохраняет ключевые факты, нюансы и действия из предыдущих сообщений, включая предоставленный ответ. После вызова этой функции все предыдущие сообщения будут удалены. Используйте её только после завершения всех промежуточных шагов и когда точное содержание предыдущих сообщений больше не имеет значения.
         text: Перечисление важных фактов и нюансов
         result: Сообщения удалены
-      finish:
-        description: Функция для завершения шагов.
+      finish_it:
+        description: Функция для завершения шагов
       monologue:
         - Шаг %d. Разработай собственное решение проблемы, проявляй инициативу и делай предположения.
         - Шаг %d. Заключи все свои наработки из предыдущего шага в функцию ox_ai_workers_iterator__inner_monologue.
-        - Шаг %d. Вызывай необходимые функции друг за другом, пока желаемый результат не будет достигнут.
+        - Шаг %d. Вызывай необходимые функции друг за другом, пока результат не будет достигнут.
         - Шаг %d. Когда все промежуточные шаги завершены и точное содержание предыдущих сообщений больше не имеет значения, используй функцию ox_ai_workers_iterator__summarize.
         - Шаг %d. Когда решение готово, сообщи об этом с помощью функции ox_ai_workers_iterator__action_request и ожидай ответ пользователя.
-        - Шаг %d. В конце вызови функцию ox_ai_workers_iterator__finish.
+        - Шаг %d. В конце вызови функцию ox_ai_workers_iterator__finish_it.

data/lib/oxaiworkers/delayed_request.rb

@@ -97,12 +97,17 @@ module OxAiWorkers
           @custom_id = line['custom_id']
           # @result = line.dig("response", "body", "choices", 0, "message", "content")
           parse_choices(line.dig('response', 'body'))
-          complete_batch!
+          # Don't complete the batch if the response is truncated due to max_tokens
+          complete_batch! unless @is_truncated
         end
       elsif !batch['error_file_id'].nil?
         @errors = @client.files.content(id: batch['error_file_id'])
         fail_batch!
       end
+
+      # Truncated response is not considered complete
+      return false if @is_truncated
+
       true
     end
   end

data/lib/oxaiworkers/iterator.rb

@@ -2,7 +2,7 @@
 
 module OxAiWorkers
   class Iterator < OxAiWorkers::StateTools
-    ITERATOR_FUNCTIONS = %i[inner_monologue outer_voice action_request summarize].freeze
+    ITERATOR_FUNCTIONS = %i[inner_monologue outer_voice action_request summarize finish_it].freeze
 
     include OxAiWorkers::ToolDefinition
     include OxAiWorkers::LoadI18n
@@ -34,7 +34,7 @@ module OxAiWorkers
           property :text, type: 'string', description: I18n.t('oxaiworkers.iterator.summarize.text'), required: true
         end
 
-        define_function :finish, description: I18n.t('oxaiworkers.iterator.finish.description')
+        define_function :finish_it, description: I18n.t('oxaiworkers.iterator.finish_it.description')
 
         @monologue = steps || I18n.t('oxaiworkers.iterator.monologue')
       end
@@ -102,7 +102,7 @@ module OxAiWorkers
       nil
     end
 
-    def finish
+    def finish_it
       complete! if can_complete?
       @after_finish&.call
       nil
@@ -185,12 +185,6 @@ module OxAiWorkers
       OxAiWorkers.logger.warn "Iterator::ServerError #{e.message}. Waiting 10 seconds..."
       sleep(10)
       external_request
-      # rescue Faraday::ForbiddenError => e
-      #   OxAiWorkers.logger.error "Iterator::ForbiddenError #{e.inspect}", for: self.class
-      # rescue StandardError => e
-      #   OxAiWorkers.logger.error "Iterator::StandardError #{e.inspect}", for: self.class
-      # rescue OpenAI::Error => e
-      #   OxAiWorkers.logger.error "Iterator::OpenAI::Error #{e.inspect}", for: self.class
     end
 
     def tick_or_wait
@@ -212,10 +206,21 @@ module OxAiWorkers
       return unless requested?
 
       sleep(60) unless ticker
-      analyze!
     end
 
     def process_result(_transition)
+      # If the response is truncated due to max_tokens, repeat the request
+      if @worker.is_truncated && @worker.result.present?
+        # Save the partial response and continue the dialogue with AI
+        OxAiWorkers.logger.info(
+          "Truncated response detected (finish_reason: #{@worker.finish_reason}). Repeating request to get complete response.", for: self.class
+        )
+        @queue << { role: :assistant, content: @worker.result }
+        # Request continuation
+        next_iteration
+        return
+      end
+
       @result = @worker.result || @worker.errors
       if @worker.tool_calls.present?
         @queue << { role: :assistant, content: @worker.tool_calls_raw.to_s }

data/lib/oxaiworkers/module_request.rb

@@ -3,7 +3,7 @@
 module OxAiWorkers
   class ModuleRequest
     attr_accessor :result, :client, :messages, :model, :max_tokens, :custom_id, :temperature, :tools, :errors,
-                  :tool_calls_raw, :tool_calls
+                  :tool_calls_raw, :tool_calls, :is_truncated, :finish_reason
 
     def initialize_requests(model: nil, max_tokens: nil, temperature: nil)
       @max_tokens = max_tokens || OxAiWorkers.configuration.max_tokens
@@ -11,6 +11,8 @@ module OxAiWorkers
       @model = model || OxAiWorkers.configuration.model
       @temperature = temperature || OxAiWorkers.configuration.temperature
       @client = nil
+      @is_truncated = false
+      @finish_reason = nil
 
       OxAiWorkers.configuration.access_token ||= ENV['OPENAI']
       if OxAiWorkers.configuration.access_token.nil?
@@ -31,6 +33,8 @@ module OxAiWorkers
       @messages = []
       @tool_calls = nil
       @tool_calls_raw = nil
+      @is_truncated = false
+      @finish_reason = nil
     end
 
     def append(role: nil, content: nil, messages: nil)
@@ -62,6 +66,10 @@ module OxAiWorkers
       @tool_calls = []
       @result = response.dig('choices', 0, 'message', 'content')
       @tool_calls_raw = response.dig('choices', 0, 'message', 'tool_calls')
+      @finish_reason = response.dig('choices', 0, 'finish_reason')
+      @is_truncated = @finish_reason == 'length'
+
+      return @tool_calls if @tool_calls_raw.nil?
 
       @tool_calls_raw.each do |tool|
         function = tool['function']

data/lib/oxaiworkers/request.rb

@@ -19,6 +19,10 @@ module OxAiWorkers
     end
 
     def completed?
+      # Truncated response is not considered complete,
+      # so the iterator continues processing
+      return false if @is_truncated
+
       @result.present? or @errors.present? or @tool_calls.present?
     end
   end

data/lib/oxaiworkers/state_helper.rb

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

data/lib/oxaiworkers/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ox-ai-workers
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.5
 platform: ruby
 authors:
 - Denis Smolev
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-25 00:00:00.000000000 Z
+date: 2025-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -124,12 +123,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".cursorrules"
 - ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE
 - README.md
 - Rakefile
+- app/models/task.rb
 - config/locales/en.oxaiworkers.assistant.yml
 - config/locales/en.oxaiworkers.iterator.yml
 - config/locales/en.oxaiworkers.tool.yml
@@ -173,7 +174,6 @@ metadata:
   homepage_uri: https://ai.oxteam.me
   source_code_uri: https://github.com/neonix20b/ox-ai-workers
   changelog_uri: https://github.com/neonix20b/ox-ai-workers/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -188,8 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A powerful state machine with OpenAI generative intelligence integration
 test_files: []