ox-ai-workers 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e742b4a56d2c4f860ef050e318ec3347d4498740a04331dbd7d9c44d261ea3bb
-  data.tar.gz: 044723cd3ecfecdde286d02dd0af3de1137488b8d2ee8a2d98000dc33a4eaaf0
+  metadata.gz: 344c37f9e68f279cdbc7e84247ba973c57e7d3c635de4178c1c6ae48c503cf10
+  data.tar.gz: a1bd748d4d078c9f911549f9a0d02be9dd3ce2c02cdaac13b10eb048fe23881f
 SHA512:
-  metadata.gz: 8b78ca31b18d8447217a12882d9073dc96f77a6f24687332a160bf06c4ad46a05d59ccc0d621f244573074ca26bb726c29e9196c9a84474a4decc64c78ea974c
-  data.tar.gz: a0e7df6d557677f68e30f4c76ba005b86da6224501d130ea5cabef7683b86d3b4bb186b6eeb5819283412ceecdf969c40c3a29bb6a30345245d8b74a6d47ae39
+  metadata.gz: 78703cebb3370c3ca967346e77f5816720a824ebefb9170d304add87aa7e4cbb1f54f7f2904bbf11e8bed5030730f24e6f9b40ea7ff59126968c70d43960ffd1
+  data.tar.gz: 7331e973af417507cc7c2232080b104a4d0e173eb7c1117513089374b648a3f759b31b8cffa2c1f0bb551178f63f169e7a81c2e4134381f50df5c3a95998bd3c

data/CHANGELOG.md

@@ -1,24 +1,35 @@
 ## [Unreleased]
 
+## [0.2.5] - 2024-07-30
+
+- Improved start template
+
+## [0.2.4] - 2024-07-30
+
+- Complete template for initialization: `oxaiworkers init full`
+- Fix missing require_relative
+
 ## [0.2.3] - 2024-07-30
-- start script with configure section
+
+- Added start script with configuration section
 
 ## [0.2.2] - 2024-07-30
-- fix cli
-- better start script (cli: .oxaiworkers-local/start)
-- better init script
+
+- Fixed CLI issues
+- Improved start script (CLI: .oxaiworkers-local/start)
+- Enhanced initialization script
 
 ## [0.2.0] - 2024-07-30
-- fix missing require 'open3'
-- fix Steps
-- cli: oxaiworkers init
+
+- Fixed missing require 'open3'
+- Corrected execution steps
+- CLI: added command `oxaiworkers init`
 
 ## [0.1.1] - 2024-07-29
 
-- Fix Delayed Requests
-- Configurable model, max_tokens, temperature
+- Fixed delayed requests
+- Added configurable parameters for model, max_tokens, temperature
 
 ## [0.1.0] - 2024-07-29
 
-- Initial release
-
+- Initial release

data/README.md

@@ -70,6 +70,9 @@ iterator.role = "You are a software agent inside my computer"
 
 # Add a task to the iterator
 iterator.addTask("Show files in current dir")
+
+# Provide a response to the gpt's question
+iterator.addTask("linux")
 ```
 
 ### With Config
@@ -90,6 +93,9 @@ Then you can create an assistant like this:
 ```ruby
 assistant = OxAiWorkers::Assistant::Sysop.new()
 assistant.setTask("your task")
+
+# Provide a response to the assistant's question
+assistant.addResponse("blah-blah-blah")
 ```
 
 Or you can create a lower-level iterator for more control:
@@ -101,6 +107,8 @@ iterator = OxAiWorkers::Iterator.new(
   role: "You are a software agent inside my computer" )
 
 iterator.addTask("Show files in current directory.")
+# ...
+iterator.addTask("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.
@@ -123,9 +131,17 @@ 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 settings.
+This will create a `.oxaiworkers-local` directory with the necessary initial settings. 
+
+Additionally, you can initialize a more comprehensive example using the command:
+
+```sh
+oxaiworkers init full
+```
+
+After this, in the `my_assistant.rb` file, you can find an example of an assistant that uses a tool from the `tools/my_tool.rb` file. In the `start` file, you will find the algorithm for applying this assistant.
 
-3. Modify the settings as needed and run:
+3. Modify the code as needed and run:
 
 ```sh
 .oxaiworkers-local/start

data/exe/oxaiworkers

@@ -1,20 +1,26 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'fileutils'
 
-if ARGV.first == "init"
-	dir = '.oxaiworkers-local'
-	dest = "#{Dir.pwd}/#{dir}"
-	source = File.expand_path('../../', __FILE__)
+puts 'Welcome to OxAiWorkers!'
 
-	unless Dir.exist? dir
-		FileUtils.mkdir_p dir + "/locales"
-		FileUtils.copy_entry source + "/locales", dest + "/locales"
-		FileUtils.cp(source+"/exe/start", dest)
-		puts "A #{dir} directory was created with the necessary initial settings."
-		puts "Modify the settings as needed and run:"
-		puts "#{dir}/start"
-	else
-		puts "Error: The #{dir} directory already exists."
-	end
-end
+if ARGV.first == 'init'
+  dir = '.oxaiworkers-local'
+  dest = "#{Dir.pwd}/#{dir}"
+  source = File.expand_path('..', __dir__)
+
+  if Dir.exist? dir
+    puts "Error: The #{dir} directory already exists."
+  else
+    FileUtils.mkdir_p "#{dir}/locales"
+    FileUtils.copy_entry "#{source}/locales", "#{dest}/locales"
+    if ARGV.last == 'full'
+      FileUtils.copy_entry "#{source}/template", dest.to_s
+    else
+      FileUtils.cp("#{source}/exe/start", dest)
+    end
+    puts "A #{dir} directory was created with the necessary initial settings."
+    puts "Modify the settings as needed and run: #{dir}/start"
+  end
+end

data/exe/start

@@ -1,20 +1,21 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
-require "i18n"
-I18n.load_path += Dir[File.expand_path(".oxaiworkers-local/locales") + "/*.yml"]
+
+require 'i18n'
+I18n.load_path += Dir["#{File.expand_path('.oxaiworkers-local/locales')}/*.yml"]
 I18n.default_locale = :en
 
 # Start your code here
-require "ox-ai-workers"
-require "irb"
+require 'ox-ai-workers'
+require 'irb'
 
 puts "OxAiWorkers #{OxAiWorkers::VERSION}"
 
 OxAiWorkers.configure do |config|
-    config.access_token = ENV.fetch("OPENAI")
-    config.model = "gpt-4o-mini"
+  config.access_token = ENV.fetch('OPENAI')
+  config.model = 'gpt-4o-mini'
 end
 
-@assistant = OxAiWorkers::Assistant::Sysop.new()
+@assistant = OxAiWorkers::Assistant::Sysop.new
 
 IRB.start(__FILE__)

data/lib/oxaiworkers/assistant/sysop.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module OxAiWorkers
   module Assistant
     class Sysop
       include OxAiWorkers::Assistant::ModuleBase
 
-      def initialize delayed: false, model: nil
+      def initialize(delayed: false, model: nil)
         @iterator = OxAiWorkers::Iterator.new(
-            worker: initWorker(delayed: delayed, model: model),
-            role: I18n.t("oxaiworkers.assistant.sysop.role"),
-            tools: [OxAiWorkers::Tool::Eval.new]
-          )
+          worker: initWorker(delayed: delayed, model: model),
+          role: I18n.t('oxaiworkers.assistant.sysop.role'),
+          tools: [OxAiWorkers::Tool::Eval.new]
+        )
       end
     end
   end
-end
+end

data/lib/oxaiworkers/tool/eval.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'open3'
 
 module OxAiWorkers::Tool
@@ -6,12 +7,12 @@ module OxAiWorkers::Tool
     extend OxAiWorkers::ToolDefinition
     include OxAiWorkers::DependencyHelper
 
-    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
+    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
+    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
 
     def ruby(input:)
@@ -21,8 +22,8 @@ module OxAiWorkers::Tool
 
     def sh(input:)
       puts Rainbow("Executing sh: \"#{input}\"").red
-      stdout_and_stderr_s, _ = Open3.capture2e(input)
-      return stdout_and_stderr_s
+      stdout_and_stderr_s, = Open3.capture2e(input)
+      stdout_and_stderr_s
     end
   end
-end
+end

data/lib/oxaiworkers/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
 module OxAiWorkers
-  VERSION = "0.2.3"
+  VERSION = '0.2.5'
 end
-

data/template/my_assistant.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'tools/my_tool'
+
+class MyAssistant
+  include OxAiWorkers::Assistant::ModuleBase
+
+  def initialize(delayed: false, model: nil)
+    @iterator = OxAiWorkers::Iterator.new(
+      worker: initWorker(delayed: delayed, model: model),
+      role: 'You are a software agent inside my computer',
+      tools: [MyTool.new]
+    )
+  end
+end

data/template/start

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'i18n'
+I18n.load_path += Dir["#{File.expand_path('.oxaiworkers-local/locales')}/*.yml"]
+I18n.default_locale = :en
+
+# Start your code here
+require 'ox-ai-workers'
+require 'irb'
+require_relative 'my_assistant'
+
+puts "OxAiWorkers #{OxAiWorkers::VERSION}"
+
+OxAiWorkers.configure do |config|
+  config.access_token = ENV.fetch('OPENAI')
+  config.model = 'gpt-4o-mini'
+end
+
+@assistant = MyAssistant.new
+
+IRB.start(__FILE__)

data/template/tools/my_tool.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class MyTool
+  extend OxAiWorkers::ToolDefinition
+  include OxAiWorkers::DependencyHelper
+
+  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
+
+  def sh(input:)
+    puts "Executing sh: \"#{input}\""
+    stdout_and_stderr_s, = Open3.capture2e(input)
+    stdout_and_stderr_s
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ox-ai-workers
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Denis Smolev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-29 00:00:00.000000000 Z
+date: 2024-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: state_machine
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,35 +53,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: ruby-openai
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '7'
 - !ruby/object:Gem::Dependency
-  name: i18n
+  name: state_machine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -138,6 +138,9 @@ files:
 - lib/ruby/ox-ai-workers.rb
 - locales/en.system.yml
 - locales/ru.system.yml
+- template/my_assistant.rb
+- template/start
+- template/tools/my_tool.rb
 homepage: https://ai.oxteam.me
 licenses:
 - MIT
@@ -153,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="