ox-ai-workers 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e563672ebb8a323e88e6254ba417bdda3f602d133fc99fcc73d366a21065f95
-  data.tar.gz: 74c196334483c2e1d4b4222cb15ce927be00c33361c92c24f599f21cceaaf1c6
+  metadata.gz: e742b4a56d2c4f860ef050e318ec3347d4498740a04331dbd7d9c44d261ea3bb
+  data.tar.gz: 044723cd3ecfecdde286d02dd0af3de1137488b8d2ee8a2d98000dc33a4eaaf0
 SHA512:
-  metadata.gz: ac84a177aa2fc34a8540938a578cfdd6e72dfb8529e0e2ba1dc85a3761e95f7397bdd7433c0a27b140b0eed5f8a569bde42f454d628788659ec9e8999cbe98d2
-  data.tar.gz: 007e58b6fa9b71959efde9ab05aab150df41d98857b9eb582a0858bd1156df84f05fb4e4b9d2e9c519b8445c04190478621497522bdf259551eadf7b1bc4542d
+  metadata.gz: 8b78ca31b18d8447217a12882d9073dc96f77a6f24687332a160bf06c4ad46a05d59ccc0d621f244573074ca26bb726c29e9196c9a84474a4decc64c78ea974c
+  data.tar.gz: a0e7df6d557677f68e30f4c76ba005b86da6224501d130ea5cabef7683b86d3b4bb186b6eeb5819283412ceecdf969c40c3a29bb6a30345245d8b74a6d47ae39

data/CHANGELOG.md

@@ -1,8 +1,12 @@
 ## [Unreleased]
 
+## [0.2.3] - 2024-07-30
+- start script with configure section
+
 ## [0.2.2] - 2024-07-30
 - fix cli
 - better start script (cli: .oxaiworkers-local/start)
+- better init script
 
 ## [0.2.0] - 2024-07-30
 - fix missing require 'open3'

data/README.md

@@ -27,27 +27,48 @@ 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")
 ```
 
@@ -68,18 +89,30 @@ Then you can create an assistant like this:
 
 ```ruby
 assistant = OxAiWorkers::Assistant::Sysop.new()
+assistant.setTask("your task")
 ```
 
+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.")
 ```
 
+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.

data/exe/start

@@ -10,6 +10,11 @@ require "irb"
 
 puts "OxAiWorkers #{OxAiWorkers::VERSION}"
 
+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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ox-ai-workers
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Denis Smolev