ox-ai-workers 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e563672ebb8a323e88e6254ba417bdda3f602d133fc99fcc73d366a21065f95
-  data.tar.gz: 74c196334483c2e1d4b4222cb15ce927be00c33361c92c24f599f21cceaaf1c6
+  metadata.gz: 68e329b2bdf72c3b0d75acc50542f1af17bfde774f5e1ad26b4d28ae8b2eb3d4
+  data.tar.gz: 7e233262b802841e7a3c6241864376d5d25668391a9b482f441b47617e556703
 SHA512:
-  metadata.gz: ac84a177aa2fc34a8540938a578cfdd6e72dfb8529e0e2ba1dc85a3761e95f7397bdd7433c0a27b140b0eed5f8a569bde42f454d628788659ec9e8999cbe98d2
-  data.tar.gz: 007e58b6fa9b71959efde9ab05aab150df41d98857b9eb582a0858bd1156df84f05fb4e4b9d2e9c519b8445c04190478621497522bdf259551eadf7b1bc4542d
+  metadata.gz: ed6cb48bbf7ed1069fc29a4e3ca8e288f8c4e7af4fd08cd4ef4cf1a599de3720edb220afe52cb56db3b01f694cff197924b7d66908a7513979a64d818672b7c0
+  data.tar.gz: bceb85175f975cd69100186012a4429f37e78e01f91962921979d7c27bf4e09dd0150dc8fa83d20711a62073ffb6ad58bf99bac756fdb6cf8c34de785bdf2c37

data/CHANGELOG.md

@@ -1,20 +1,31 @@
 ## [Unreleased]
 
+## [0.2.4] - 2024-07-30
+
+- Complete template for initialization: `oxaiworkers init full`
+- Fix missing require_relative
+
+## [0.2.3] - 2024-07-30
+
+- Added start script with configuration section
+
 ## [0.2.2] - 2024-07-30
-- fix cli
-- better start script (cli: .oxaiworkers-local/start)
+
+- 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

@@ -27,28 +27,52 @@ gem install ox-ai-workers
 Here's a basic example of how to use OxAiWorkers:
 
 ```ruby
-I18n.load_path += Dir[File.expand_path("locales") + "/*.yml"] # for pure Ruby
-I18n.default_locale = :en # for pure Ruby
+# Load localization files and set default locale
+I18n.load_path += Dir[File.expand_path("locales") + "/*.yml"] # only for pure Ruby
+I18n.default_locale = :en # only for pure Ruby
+
+# Require the main gem
 require 'ox-ai-workers'
 
 # Initialize the assistant
 sysop = OxAiWorkers::Assistant::Sysop.new(delayed: false, model: "gpt-4o")
 
-# Add a task
+# Add a task to the assistant
 sysop.setTask("Add a cron job to synchronize files daily.")
 
-# Add a response to the assistant's question.
+# Provide a response to the assistant's question
 sysop.addResponse("blah-blah-blah")
 ```
 
+Alternatively, you can use a lower-level approach for more control:
+
 ```ruby
-worker = OxAiWorkers::DelayedRequest.new(model: "gpt-4o-mini", max_tokens: 4096, temperature: 0.7)
-# or
-# worker = OxAiWorkers::Request.new(model: "gpt-4o-mini", max_tokens: 4096, temperature: 0.7)
+# Initialize a worker for delayed requests
+worker = OxAiWorkers::DelayedRequest.new(
+    model: "gpt-4o-mini", 
+    max_tokens: 4096, 
+    temperature: 0.7 )
+
+# Alternatively, initialize a worker for immediate requests
+worker = OxAiWorkers::Request.new(
+    model: "gpt-4o-mini", 
+    max_tokens: 4096, 
+    temperature: 0.7 )
+
+# Initialize a tool
 my_tool = OxAiWorkers::Tool::Eval.new()
-iterator = OxAiWorkers::Iterator.new(worker: worker, tools: [my_tool])
+
+# Create an iterator with the worker and tool
+iterator = OxAiWorkers::Iterator.new(
+    worker: worker, 
+    tools: [my_tool] )
 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
@@ -68,18 +92,35 @@ 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:
+
 ```ruby
 iterator = OxAiWorkers::Iterator.new(
   worker: OxAiWorkers::Request.new, 
   tools: [OxAiWorkers::Tool::Eval.new],
-  role: "You are a software agent inside my computer"
-  )
+  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.
+
+### Worker Options
+
+As a worker, you can use different classes depending on your needs:
+
+- `OxAiWorkers::Request`: This class is used for immediate request execution. It is suitable for operations that require instant responses.
+
+- `OxAiWorkers::DelayedRequest`: This class is used for batch API requests, ideal for operations that do not require immediate execution. Using `DelayedRequest` can save up to 50% on costs as requests are executed when the remote server is less busy, but no later than within 24 hours.
+
 ## Command Line Interface (CLI)
 
 1. Navigate to the required directory.
@@ -90,6 +131,12 @@ iterator.addTask("Show files in current directory.")
 oxaiworkers init
 ```
 
+or 
+
+```sh
+oxaiworkers init full
+```
+
 This will create a `.oxaiworkers-local` directory with the necessary initial settings.
 
 3. Modify the settings as needed and run:

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,15 +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}"
 
-@assistant = OxAiWorkers::Assistant::Sysop.new()
+OxAiWorkers.configure do |config|
+  config.access_token = ENV.fetch('OPENAI')
+  config.model = 'gpt-4o-mini'
+end
+
+@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.2"
+  VERSION = '0.2.4'
 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 helpful assistant',
+      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,14 @@
+# frozen_string_literal: true
+
+class MyTool
+  extend OxAiWorkers::ToolDefinition
+  include OxAiWorkers::DependencyHelper
+
+  define_function :printHello, description: 'Print hello' do
+    property :name, type: 'string', description: 'Your name', required: true
+  end
+
+  def printHello(name:)
+    puts "Hello #{name}"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ox-ai-workers
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 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:
   - - ">="