ox-ai-workers 0.5.4 → 0.5.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67dfa0fc5c5cb3c3c223615ec1386324b1a71fdc38d90db9b78c6c94f0136add
-  data.tar.gz: 555689bc0e7d83a854f0614d13aed065b2634bdf4501a9aa2025fc40736db398
+  metadata.gz: cd23611eb845a63cc6bd0142480645aff071bd569e748cb5aa394f461e360073
+  data.tar.gz: 1b8049ea7ed0a74ddf350bce0e7f9a7b88e0feb16626e7c6eb8891b55fec3995
 SHA512:
-  metadata.gz: 374c51ea659b98605131b46e1ffbffbfc3ec5d9d6c5718f64952e630e2a14adec56412776eadc4c074ead54c8197fc0195b9590dd76d0737dd7fff347b5ab236
-  data.tar.gz: 21714fc9c30d3159c756ce53840a598c163bca8547e7425e86ffd6ef86c78b5c3563c3a5b5d415420d3141c45d68c87f289d55436796bfa17cc83e4a4b963ab9
+  metadata.gz: b91a2846312a4403eb059f075f76ea39f18a1706b85db6bac1b053841e09a5ba901f11ab4c36397162174b9f696aca51b82ea714644a581409957a8ab5be2bbe
+  data.tar.gz: c725fab2dcfaef342000918d9f4a21feceb2196191de27b7d6bf528af41e6db761ceefd439c7bbd3dbc0bb546fb50016b788c22be802f566e61a8f36d114838f

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.5.5] - 2024-08-02
+
+- Added `only` for Tools
+- Addded `locale` for `Iterator` and `Assistant`
+
+## [0.5.4] - 2024-08-01
+
 - def_except and def_only for `Iterator`
 - Renamed on_pack_history to on_summarize
 - Renamed all "pack_history" to "summarize"

data/README.md

@@ -63,7 +63,7 @@ worker = OxAiWorkers::Request.new(
     temperature: 0.7 )
 
 # Initialize a tool
-my_tool = OxAiWorkers::Tool::Eval.new()
+my_tool = OxAiWorkers::Tool::Eval.new(only: :sh)
 
 # Create an iterator with the worker and tool
 iterator = OxAiWorkers::Iterator.new(
@@ -86,9 +86,9 @@ For a more robust setup, you can configure the gem with your API keys, for examp
 OxAiWorkers.configure do |config|
     config.access_token = ENV.fetch("OPENAI")
     config.model = "gpt-4o"
-    config.max_tokens = 4096
-    config.temperature = 0.7
-    config.auto_execute = true
+    config.max_tokens = 4096 # Default
+    config.temperature = 0.7 # Default
+    config.auto_execute = true # Default
 end
 ```
 
@@ -97,16 +97,27 @@ Then you can create an assistant like this:
 ```ruby
 assistant = OxAiWorkers::Assistant::Sysop.new()
 assistant.task = "Remove all cron jobs."
+# assistant.execute # if auto_execute is false
 
 # Provide a response to the assistant's question
 assistant.add_response("blah-blah-blah")
+# assistant.execute # if auto_execute is false
+```
+
+Besides, you can create assistants with different locales
+
+```ruby
+I18n.with_locale(:en) { @sysop_en = OxAiWorkers::Assistant::Sysop.new() }
+
+# Assign tasks and responses in different languages
+@sysop_en.task = "Remove all cron jobs."
 ```
 
 Or you can create a lower-level iterator for more control:
 
 ```ruby
 my_worker = OxAiWorkers::Request.new
-my_tool = OxAiWorkers::Tool::Eval.new
+my_tool = OxAiWorkers::Tool::Eval.new(only: [:sh])
 
 iterator = OxAiWorkers::Iterator.new(
     worker: my_worker, 
@@ -123,6 +134,12 @@ iterator.add_task("Show files in current directory.")
 iterator.add_task("linux")
 ```
 
+If `auto_execute` is set to false in the configuration, don't forget to manually execute the iterator or assistant.
+
+```ruby
+iterator.execute # if auto_execute is false
+```
+
 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
@@ -135,10 +152,14 @@ steps << 'Step 3. Call the necessary functions one after another until the desir
 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."
 
+# To retain the locale if you have assistants in different languages in your project.
+store_locale # Optional
+
 @iterator = OxAiWorkers::Iterator.new(
   worker: init_worker(delayed: delayed, model: model),
   role: 'You are a software agent inside my computer',
   tools: [MyTool.new],
+  locale: @locale || I18n.locale,
   steps: steps,
   # def_except: [:summarize], # It's except steps with that functions
   # def_only: [:inner_monologue, :outer_voice], # Use it only with your steps

data/exe/start

@@ -17,4 +17,8 @@ end
 
 @assistant = OxAiWorkers::Assistant::Sysop.new
 
+# Anything you want
+
+puts 'Type and Run: @assistant.task = "show files in current directory"'
+
 IRB.start(__FILE__)

data/lib/ox-ai-workers.rb

@@ -11,13 +11,14 @@ require_relative 'oxaiworkers/version'
 require_relative 'oxaiworkers/contextual_logger'
 require_relative 'oxaiworkers/load_i18n'
 require_relative 'oxaiworkers/present_compat'
+require_relative 'oxaiworkers/tool_definition'
+require_relative 'oxaiworkers/dependency_helper'
+
 require_relative 'oxaiworkers/module_request'
 require_relative 'oxaiworkers/state_helper'
 require_relative 'oxaiworkers/state_batch'
 require_relative 'oxaiworkers/state_tools'
-require_relative 'oxaiworkers/tool_definition'
 require_relative 'oxaiworkers/delayed_request'
-require_relative 'oxaiworkers/dependency_helper'
 require_relative 'oxaiworkers/iterator'
 require_relative 'oxaiworkers/request'
 

data/lib/oxaiworkers/assistant/coder.rb

@@ -6,10 +6,12 @@ module OxAiWorkers
       include OxAiWorkers::Assistant::ModuleBase
 
       def initialize(delayed: false, model: nil, language: 'ruby')
+        store_locale
         @iterator = Iterator.new(
           worker: init_worker(delayed: delayed, model: model),
           role: format(I18n.t('oxaiworkers.assistant.coder.role'), language),
           tools: [Tool::Eval.new, Tool::FileSystem.new],
+          locale: @locale,
           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) },

data/lib/oxaiworkers/assistant/localizer.rb

@@ -6,10 +6,12 @@ module OxAiWorkers
       include OxAiWorkers::Assistant::ModuleBase
 
       def initialize(delayed: false, model: nil, language: 'русский', locale: :ru, source: 'english')
+        store_locale
         @iterator = Iterator.new(
           worker: init_worker(delayed: delayed, model: model),
           role: format(I18n.t('oxaiworkers.assistant.localizer.role'), language),
           tools: [Tool::Eval.new, Tool::FileSystem.new],
+          locale: @locale,
           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) },

data/lib/oxaiworkers/assistant/module_base.rb

@@ -3,6 +3,8 @@
 module OxAiWorkers
   module Assistant
     module ModuleBase
+      include OxAiWorkers::LoadI18n
+
       attr_accessor :iterator
 
       def task=(task)

data/lib/oxaiworkers/assistant/sysop.rb

@@ -6,10 +6,12 @@ module OxAiWorkers
       include OxAiWorkers::Assistant::ModuleBase
 
       def initialize(delayed: false, model: nil)
+        store_locale
         @iterator = Iterator.new(
           worker: init_worker(delayed: delayed, model: model),
           role: I18n.t('oxaiworkers.assistant.sysop.role'),
-          tools: [Tool::Eval.new],
+          tools: [Tool::Eval.new(only: :sh), Tool::FileSystem.new(only: %i[read_file write_to_file])],
+          locale: @locale,
           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) },

data/lib/oxaiworkers/iterator.rb

@@ -4,37 +4,45 @@ 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_summarize, :def_except, :def_only
+    include OxAiWorkers::ToolDefinition
+    include OxAiWorkers::LoadI18n
 
-    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
+    attr_accessor :worker, :role, :messages, :context, :result, :tools, :queue, :monologue, :tasks, :milestones,
+                  :on_inner_monologue, :on_outer_voice, :on_action_request, :on_summarize, :def_except, :def_only
 
-    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
+    def initialize(worker:, role: nil, tools: [], on_inner_monologue: nil, on_outer_voice: nil, on_action_request: nil,
+                   on_summarize: nil, steps: nil, def_except: [], def_only: nil, locale: nil)
 
-    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
+      @locale = locale || I18n.locale
 
-    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
+      with_locale 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 :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 :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 :summarize, description: I18n.t('oxaiworkers.iterator.summarize.description') do
+          property :text, type: 'string', description: I18n.t('oxaiworkers.iterator.summarize.text'), required: true
+        end
+
+        @monologue = steps || I18n.t('oxaiworkers.iterator.monologue')
+      end
 
-    def initialize(worker:, role: nil, tools: [], on_inner_monologue: nil, on_outer_voice: nil, on_action_request: nil,
-                   on_summarize: nil, steps: nil, def_except: [], def_only: nil)
       @worker = worker
       @tools = tools
       @role = role
       @context = []
       @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
@@ -82,7 +90,9 @@ module OxAiWorkers
     def summarize(text:)
       @milestones << text.to_s
       @messages = []
-      @queue << { role: :assistant, content: I18n.t('oxaiworkers.iterator.summarize.result') }
+      with_locale do
+        @queue << { role: :assistant, content: I18n.t('oxaiworkers.iterator.summarize.result') }
+      end
       @worker.finish
       rebuild_worker
       complete! if can_complete?
@@ -103,8 +113,16 @@ module OxAiWorkers
       @tasks.each { |task| @worker.append(role: :user, content: task) }
       @milestones.each { |milestone| @worker.append(role: :assistant, content: milestone) }
       @worker.append(messages: @messages)
-      @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?
+      @worker.tools = function_schemas.to_openai_format(only: available_defs)
+      return unless @tools.present?
+
+      @worker.tools += @tools.map do |tool|
+        if tool.respond_to?(:function_schemas)
+          tool.function_schemas.to_openai_format
+        else
+          tool.class.function_schemas.to_openai_format
+        end
+      end.flatten
     end
 
     def available_defs
@@ -138,7 +156,8 @@ module OxAiWorkers
         @queue << { role: :assistant, content: @worker.tool_calls_raw.to_s }
         @worker.tool_calls.each do |external_call|
           tool = ([self] + @tools).select do |t|
-            t.class.tool_name == external_call[:class] && t.respond_to?(external_call[:name])
+            tool_name = t.respond_to?(:tool_name) ? t.tool_name : t.class.tool_name
+            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])

data/lib/oxaiworkers/load_i18n.rb

@@ -2,3 +2,18 @@
 
 require 'i18n'
 I18n.load_path += Dir["#{File.expand_path('../../locales', __dir__)}/*.yml"]
+
+module OxAiWorkers
+  module LoadI18n
+    attr_accessor :locale
+
+    def with_locale(&action)
+      # locale = respond_to?(:locale) ? self.locale : OxAiWorkers.configuration.locale
+      I18n.with_locale(@locale, &action)
+    end
+
+    def store_locale
+      @locale = I18n.locale
+    end
+  end
+end

data/lib/oxaiworkers/tool/database.rb

@@ -10,28 +10,9 @@ module OxAiWorkers
     #     database = OxAiWorkers::Tool::Database.new(connection_string: "postgres://user:password@localhost:5432/db_name")
     #
     class Database
-      extend OxAiWorkers::ToolDefinition
+      include OxAiWorkers::ToolDefinition
       include OxAiWorkers::DependencyHelper
-
-      define_function :list_tables,
-                      description: I18n.t('oxaiworkers.tool.database_tool.list_tables.description')
-
-      define_function :describe_tables,
-                      description: I18n.t('oxaiworkers.tool.database_tool.describe_tables.description') do
-        property :tables, type: 'string',
-                          description: I18n.t('oxaiworkers.tool.database_tool.describe_tables.tables'),
-                          required: true
-      end
-
-      define_function :dump_schema,
-                      description: I18n.t('oxaiworkers.tool.database_tool.dump_schema.description')
-
-      define_function :execute,
-                      description: I18n.t('oxaiworkers.tool.database_tool.execute.description') do
-        property :input, type: 'string',
-                         description: I18n.t('oxaiworkers.tool.database_tool.execute.input'),
-                         required: true
-      end
+      include OxAiWorkers::LoadI18n
 
       attr_reader :db, :requested_tables, :excluded_tables
 
@@ -41,11 +22,35 @@ module OxAiWorkers
       # @param tables [Array<Symbol>] The tables to use. Will use all if empty.
       # @param except_tables [Array<Symbol>] The tables to exclude. Will exclude none if empty.
       # @return [Database] Database object
-      def initialize(connection_string:, tables: [], exclude_tables: [])
+      def initialize(connection_string:, tables: [], exclude_tables: [], only: nil)
         depends_on 'sequel'
 
         raise StandardError, 'connection_string parameter cannot be blank' if connection_string.empty?
 
+        store_locale
+
+        init_white_list_with only
+
+        define_function :list_tables,
+                        description: I18n.t('oxaiworkers.tool.database_tool.list_tables.description')
+
+        define_function :describe_tables,
+                        description: I18n.t('oxaiworkers.tool.database_tool.describe_tables.description') do
+          property :tables, type: 'string',
+                            description: I18n.t('oxaiworkers.tool.database_tool.describe_tables.tables'),
+                            required: true
+        end
+
+        define_function :dump_schema,
+                        description: I18n.t('oxaiworkers.tool.database_tool.dump_schema.description')
+
+        define_function :execute,
+                        description: I18n.t('oxaiworkers.tool.database_tool.execute.description') do
+          property :input, type: 'string',
+                           description: I18n.t('oxaiworkers.tool.database_tool.execute.input'),
+                           required: true
+        end
+
         @db = Sequel.connect(connection_string)
         @requested_tables = tables
         @excluded_tables = exclude_tables

data/lib/oxaiworkers/tool/eval.rb

@@ -5,21 +5,28 @@ require 'open3'
 module OxAiWorkers
   module Tool
     class Eval
-      extend OxAiWorkers::ToolDefinition
+      include OxAiWorkers::ToolDefinition
       include OxAiWorkers::DependencyHelper
+      include OxAiWorkers::LoadI18n
 
-      # define_function :ruby, description: I18n.t('oxaiworkers.tool.eval.ruby.description') do
-      #   property :input, type: 'string', description: I18n.t('oxaiworkers.tool.eval.ruby.input'), required: true
-      # end
+      def initialize(only: nil)
+        store_locale
 
-      define_function :sh, description: I18n.t('oxaiworkers.tool.eval.sh.description') do
-        property :input, type: 'string', description: I18n.t('oxaiworkers.tool.eval.sh.input'), required: true
+        init_white_list_with only
+
+        define_function :ruby, description: I18n.t('oxaiworkers.tool.eval.ruby.description') do
+          property :input, type: 'string', description: I18n.t('oxaiworkers.tool.eval.ruby.input'), required: true
+        end
+
+        define_function :sh, description: I18n.t('oxaiworkers.tool.eval.sh.description') do
+          property :input, type: 'string', description: I18n.t('oxaiworkers.tool.eval.sh.input'), required: true
+        end
       end
 
-      # def ruby(input:)
-      #   puts "Executing ruby: \"#{input}\"".colorize(:red)
-      #   eval(input)
-      # end
+      def ruby(input:)
+        puts "Executing ruby: \"#{input}\"".colorize(:red)
+        eval(input)
+      end
 
       def sh(input:)
         OxAiWorkers.logger.info("Executing sh: \"#{input}\"", for: self.class)

data/lib/oxaiworkers/tool/file_system.rb

@@ -11,30 +11,35 @@ module OxAiWorkers
     #    file_system = OxAiWorkers::Tool::FileSystem.new
     #
     class FileSystem
-      extend OxAiWorkers::ToolDefinition
+      include OxAiWorkers::ToolDefinition
       include OxAiWorkers::DependencyHelper
+      include OxAiWorkers::LoadI18n
 
-      define_function :list_directory,
-                      description: I18n.t('oxaiworkers.tool.file_system.list_directory.description') do
-        property :directory_path, type: 'string',
-                                  description: I18n.t('oxaiworkers.tool.file_system.list_directory.directory_path'),
-                                  required: true
-      end
+      def initialize(only: nil)
+        depends_on 'ptools'
 
-      define_function :read_file, description: I18n.t('oxaiworkers.tool.file_system.read_file.description') do
-        property :file_path, type: 'string', description: I18n.t('oxaiworkers.tool.file_system.read_file.file_path'),
-                             required: true
-      end
+        store_locale
 
-      define_function :write_to_file, description: I18n.t('oxaiworkers.tool.file_system.write_to_file.description') do
-        property :file_path, type: 'string',
-                             description: I18n.t('oxaiworkers.tool.file_system.write_to_file.file_path'), required: true
-        property :content, type: 'string', description: I18n.t('oxaiworkers.tool.file_system.write_to_file.content'),
-                           required: true
-      end
+        init_white_list_with only
 
-      def initialize
-        depends_on 'ptools'
+        define_function :list_directory,
+                        description: I18n.t('oxaiworkers.tool.file_system.list_directory.description') do
+          property :directory_path, type: 'string',
+                                    description: I18n.t('oxaiworkers.tool.file_system.list_directory.directory_path'),
+                                    required: true
+        end
+
+        define_function :read_file, description: I18n.t('oxaiworkers.tool.file_system.read_file.description') do
+          property :file_path, type: 'string', description: I18n.t('oxaiworkers.tool.file_system.read_file.file_path'),
+                               required: true
+        end
+
+        define_function :write_to_file, description: I18n.t('oxaiworkers.tool.file_system.write_to_file.description') do
+          property :file_path, type: 'string',
+                               description: I18n.t('oxaiworkers.tool.file_system.write_to_file.file_path'), required: true
+          property :content, type: 'string', description: I18n.t('oxaiworkers.tool.file_system.write_to_file.content'),
+                             required: true
+        end
       end
 
       def list_directory(directory_path:)
@@ -42,31 +47,31 @@ module OxAiWorkers
         list = Dir.entries(directory_path)
         list.delete_if { |f| f.start_with?('.') }
         if list.present?
-          "Contents of directory \"#{directory_path}\":\n #{list.join("\n")}"
+          with_locale { "Contents of directory \"#{directory_path}\":\n #{list.join("\n")}" }
         else
-          "Directory is empty: #{directory_path}"
+          with_locale { "Directory is empty: #{directory_path}" }
         end
       rescue Errno::ENOENT
-        "No such directory: #{directory_path}"
+        with_locale { "No such directory: #{directory_path}" }
       end
 
       def read_file(file_path:)
         OxAiWorkers.logger.info("Reading file: #{file_path}", for: self.class)
         if File.binary?(file_path)
-          "File is binary: #{file_path}"
+          with_locale { "File is binary: #{file_path}" }
         else
           File.read(file_path).to_s
         end
       rescue Errno::ENOENT
-        "No such file: #{file_path}"
+        with_locale { "No such file: #{file_path}" }
       end
 
       def write_to_file(file_path:, content:)
         OxAiWorkers.logger.info("Writing to file: #{file_path}", for: self.class)
         File.write(file_path, content)
-        "Content was successfully written to the file: #{file_path}"
+        with_locale { "Content was successfully written to the file: #{file_path}" }
       rescue Errno::EACCES
-        "Permission denied: #{file_path}"
+        with_locale { "Permission denied: #{file_path}" }
       end
     end
   end

data/lib/oxaiworkers/tool_definition.rb

@@ -37,13 +37,21 @@ require "json"
 #   end
 #
 module OxAiWorkers::ToolDefinition
+  attr_accessor :white_list
+
+  def init_white_list_with only
+    @white_list = only.is_a?(Array) ? only : [only]
+  end
+
   # Defines a function for the tool
   #
   # @param method_name [Symbol] Name of the method to define
   # @param description [String] Description of the function
   # @yield Block that defines the parameters for the function
   def define_function(method_name, description:, &)
-    function_schemas.add_function(method_name:, description:, &)
+    if @white_list.nil? || @white_list == method_name || @white_list.include?(method_name)
+      function_schemas.add_function(method_name:, description:, &)
+    end
   end
 
   # Returns the FunctionSchemas instance for this tool
@@ -57,7 +65,7 @@ module OxAiWorkers::ToolDefinition
   #
   # @return [String] The snake_case version of the class name
   def tool_name
-    @tool_name ||= name
+    @tool_name ||= (self.respond_to?(:name) ? name : self.class.name)
       .gsub("::", "_")
       .gsub(/(?<=[A-Z])(?=[A-Z][a-z])|(?<=[a-z\d])(?=[A-Z])/, "_")
       .downcase

data/lib/oxaiworkers/version.rb

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

data/template/my_assistant.rb

@@ -15,11 +15,17 @@ class MyAssistant
     # 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."
 
+    # To retain the locale if you have assistants in different languages in your project.
+    # store_locale # Optional
+
     @iterator = OxAiWorkers::Iterator.new(
       worker: init_worker(delayed: delayed, model: model),
       role: 'You are a software agent inside my computer',
       tools: [MyTool.new],
+      # locale: @locale || I18n.locale,
       # 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) },

data/template/start

@@ -20,6 +20,7 @@ puts "OxAiWorkers #{OxAiWorkers::VERSION}"
 OxAiWorkers.configure do |config|
   config.access_token = ENV.fetch('OPENAI')
   config.model = 'gpt-4o-mini'
+  # config.auto_execute = false
 end
 
 # OxAiWorkers.logger.level = :debug
@@ -28,4 +29,7 @@ end
 @assistant = MyAssistant.new
 @assistant.task = '2 + 2 is ?'
 
+# Uncomment this if auto_execute is false
+# @assistant.execute
+
 IRB.start(__FILE__)

data/template/tools/my_tool.rb

@@ -1,13 +1,24 @@
 # frozen_string_literal: true
 
 class MyTool
-  extend OxAiWorkers::ToolDefinition
-  include OxAiWorkers::DependencyHelper
+  extend OxAiWorkers::ToolDefinition # (!) extend
 
   define_function :sh, description: 'Execute a sh command and get the result (stdout + stderr)' do
     property :input, type: 'string', description: 'Source command', required: true
   end
 
+  # Alternative implementation if you need to filter functions during initialization.
+  # include OxAiWorkers::ToolDefinition # (!) include
+  # include OxAiWorkers::LoadI18n # to support multiple languages
+  #
+  # def initialize(only: nil)
+  #   store_locale # To retain the locale if you have MyTool in different languages.
+  #   init_white_list_with only
+  #   define_function :sh, description:  I18n.t('Execute a sh command and get the result (stdout + stderr)') do
+  #     property :input, type: 'string', description:  I18n.t('Source command'), required: true
+  #   end
+  # end
+
   def sh(input:)
     OxAiWorkers.logger.info("Executing sh: \"#{input}\"", for: self.class)
     stdout_and_stderr_s, = Open3.capture2e(input)

metadata

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