superagi 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1109bc83d866891b9a49c0f029536824dd65895a64941e24a3b6c00e2e15f1d
-  data.tar.gz: 815b50f3d3c237354c64b46da34f61fafec6252bcdae843d5989ba1198f10040
+  metadata.gz: a210eeb7bb52e127cb2b9ab235b3a483eb779dbf16bed7802fadb5eae17bc0c5
+  data.tar.gz: b3287833b9493ccf4d34ff90e95e47d0e11623da94d568c956ebdd26cf1d92c1
 SHA512:
-  metadata.gz: e9a06e3bb7db1570373e08767485484b4052df9f0731a8b8f44e6bbf67528a8d217d1c0f96e6be158167f0aad9255a3c004ca3b8db405a4ca725910d4cd28a04
-  data.tar.gz: c84e0b997d14bbe4466a8a71431d0ff400e415f6d110a88143c0f1fe64e611fa80922f95a89c8494c12f43e016435c4d2505eb3f92f3f0d9c8156b995911a02e
+  metadata.gz: a5e3d55aec92a571d6b88a28cc14b82beae6ddc5a44d10216e4e54d863f2141ca59aad221c6bdcc8aeea044c2acd84c1187acd1e25bd0b57ac183744252f83c8
+  data.tar.gz: 9cd0bab2daff3d82a80495c12fa2e2bb83b777cf7a23f76065715980486e1269c29baa48ba5b644fa906150fb18ae2c96a89dede4ac15a586ecba50fb7902c3b

data/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2023-10-30
+
+### Added
+
+- Add SuperAGI::Agent#pause and Agent#resume to pause and resume an agent run.
+- Add SuperAGI::Agent#resources to get the output of an agent run.
+
+## [0.2.0] - 2023-10-28
+
+### Added
+
+- Add SuperAGI::Agent#update to create a new agent.
+- Add SuperAGI::Agent#run to run an agent.
+- Add SuperAGI::Agent#status to get the status of an agent run.
+
 ## [0.1.0] - 2023-10-25
 
 ### Added

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 gem "byebug", "~> 11.1.3"
 gem "dotenv", "~> 2.8.1"
-gem "rake", "~> 13.0"
+gem "rake", "~> 13.1"
 gem "rspec", "~> 3.12"
 gem "rubocop", "~> 1.50.2"
 gem "vcr", "~> 6.1.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    superagi (0.1.0)
+    superagi (0.3.0)
       faraday (>= 1)
       faraday-multipart (>= 1)
 
@@ -32,7 +32,7 @@ GEM
       ast (~> 2.4.1)
     public_suffix (5.0.3)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.1.0)
     regexp_parser (2.8.0)
     rexml (3.2.6)
     rspec (3.12.0)
@@ -75,7 +75,7 @@ PLATFORMS
 DEPENDENCIES
   byebug (~> 11.1.3)
   dotenv (~> 2.8.1)
-  rake (~> 13.0)
+  rake (~> 13.1)
   rspec (~> 3.12)
   rubocop (~> 1.50.2)
   superagi!

data/README.md

@@ -4,7 +4,7 @@
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/alexrudall/superagi/blob/main/LICENSE.txt)
 [![CircleCI Build Status](https://circleci.com/gh/alexrudall/superagi.svg?style=shield)](https://circleci.com/gh/alexrudall/superagi)
 
-Use the [SuperAGI API](https://superagi.com/blog/superagi-api/) with Ruby! 🦄❤️
+Use the [SuperAGI API](https://superagi.com/docs/) with Ruby! 🦄❤️
 
 Create and Manage Agents in your Ruby app...
 
@@ -77,18 +77,15 @@ client = SuperAGI::Client.new(secret_key: "secret_key_goes_here")
 
 #### Custom timeout or base URI
 
-The default timeout for any request using this library is 120 seconds. You can change that by passing a number of seconds to the `request_timeout` when initializing the client. You can also change the base URI used for all requests.
+The default timeout for any request using this library is 120 seconds. You can change that by passing a number of seconds to the `request_timeout` when initializing the client. You can also change the base URI used for all requests, eg. if you're running SuperAGI locally with the default `docker-compose` setup you can use `http://superagi-backend-1:8001/`.
 
 ```ruby
 client = SuperAGI::Client.new(
     secret_key: "secret_key_goes_here",
-    uri_base: "https://app.alternativeapi.com/",
+    uri_base: "http://superagi-backend-1:8001/",
     request_timeout: 240,
     extra_headers: {
-      "X-Proxy-TTL" => "43200", # For https://github.com/6/superagi-caching-proxy-worker#specifying-a-cache-ttl
-      "X-Proxy-Refresh": "true", # For https://github.com/6/superagi-caching-proxy-worker#refreshing-the-cache
-      "Helicone-Auth": "Bearer HELICONE_API_KEY", # For https://docs.helicone.ai/getting-started/integration-method/superagi-proxy
-      "helicone-stream-force-format" => "true", # Use this with Helicone otherwise streaming drops chunks # https://github.com/alexrudall/superagi/issues/251
+      "Extra-Header" => "43200",
     }
 )
 ```
@@ -98,7 +95,7 @@ or when configuring the gem:
 ```ruby
 SuperAGI.configure do |config|
     config.secret_key = ENV.fetch("SUPERAGI_SECRET_KEY")
-    config.uri_base = "https://app.alternativeapi.com/" # Optional
+    config.uri_base = "http://superagi-backend-1:8001/" # Optional
     config.request_timeout = 240 # Optional
     config.extra_headers = {
       "abc" => "123",
@@ -107,6 +104,94 @@ SuperAGI.configure do |config|
 end
 ```
 
+### Create Agent
+
+An agent is the primary entity in SuperAGI that carries out tasks. To create one:
+
+```ruby
+response = client.agent.create(
+    parameters: {
+      name: "Motivational Quote Generator",
+      description: "Generates motivational quotes",
+      goal: ["I need a motivational quote"],
+      instruction: ["Write a new motivational quote"],
+      iteration_interval: 500,
+      max_iterations: 2,
+      constraints: [],
+      tools: []
+    })
+puts response
+# => {"agent_id"=>15312}
+```
+
+### Update Agent
+
+To update an agent, pass the ID and 1 or more of the parameters you want to update:
+
+```ruby
+response = client.agent.update(
+    id: 15312,
+    parameters: {
+      name: "Updated name",
+    })
+puts response
+# => {"agent_id"=>15312}
+```
+
+### Run Agent
+
+To run an agent:
+
+```ruby
+response = client.agent.run(id: 15312)
+puts response
+# => {"run_id"=>29970}
+```
+
+### Pause Agent
+
+To pause an agent:
+
+```ruby
+client.agent.run(id: 15312)
+response = client.agent.pause(id: 15312)
+puts response
+# => {"result"=>"success"}
+```
+
+### Resume Agent
+
+To resume an agent:
+
+```ruby
+client.agent.run(id: 15312)
+client.agent.pause(id: 15312)
+response = client.agent.resume(id: 15312)
+puts response
+# => {"result"=>"success"}
+```
+
+### Agent Status
+
+To get the status of Agent runs:
+
+```ruby
+response = client.agent.status(id: 15312)
+puts response
+# => [{"run_id"=>29970,"status"=>"CREATED"}]
+```
+
+### Agent Resources
+
+To get the resources output by Agent runs:
+
+```ruby
+  run_id = client.agent.run(id: 15312)["run_id"]
+  response = client.agent.resources(parameters: { run_ids: [run_id] })
+  puts response
+  # => {}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/superagi/agent.rb

@@ -1,74 +1,40 @@
 module SuperAGI
   class Agent
-    # '{"loc":["body","constraints"],"msg":"field
-    #     required","type":"value_error.missing"},{"loc":["body","tools"],"msg":"field
-    #     required","type":"value_error.missing"},{"loc":["body","iteration_interval"],"msg":"field
-    #     required","type":"value_error.missing"},{"loc":["body","max_iterations"],"msg":"field
-    #     required","type":"value_error.missing"}]}'
+    include SuperAGI::AgentValidation
 
     def initialize(client:)
       @client = client
     end
 
     def create(parameters:)
-      parameters = valid_parameters(parameters: parameters)
+      parameters = valid_parameters(method: :create, parameters: parameters)
       @client.json_post(path: "/agent", parameters: parameters)
     end
 
-    # def update(id:, parameters: {})
-    # end
-
-    # def pause(id:)
-    # end
-
-    # def resume(id:)
-    # end
-
-    # def delete(id:)
-    # end
-
-    # def status(id:)
-    # end
-
-    # def resources(id:)
-    # end
+    def update(id:, parameters:)
+      parameters = valid_parameters(method: :update, parameters: parameters)
+      @client.json_put(path: "/agent/#{id}", parameters: parameters)
+    end
 
-    private
+    def run(id:)
+      @client.json_post(path: "/agent/#{id}/run", parameters: {})
+    end
 
-    DEFAULT_PARAMETERS = {
-      agent_workflow: "Goal Based Workflow",
-      model: "gpt-4"
-    }.freeze
-    ARRAY_PARAMETERS = %w[
-      constraints
-      goal
-      tools
-    ].freeze
-    REQUIRED_PARAMETERS = (%w[
-      description
-      instruction
-      iteration_interval
-      max_iterations
-      name
-    ] + ARRAY_PARAMETERS + DEFAULT_PARAMETERS.keys).freeze
+    def pause(id:)
+      @client.json_post(path: "/agent/#{id}/pause", parameters: {})
+    end
 
-    def valid_parameters(parameters:)
-      parameters = DEFAULT_PARAMETERS.merge(parameters)
-      validate_presence(parameters: parameters)
-      validate_arrays(parameters: parameters)
-      parameters
+    def resume(id:)
+      @client.json_post(path: "/agent/#{id}/resume", parameters: {})
     end
 
-    def validate_presence(parameters:)
-      REQUIRED_PARAMETERS.each do |key|
-        raise ArgumentError, "#{key} is required" unless parameters[key.to_sym]
-      end
+    def status(id:)
+      @client.json_post(path: "/agent/#{id}/run-status", parameters: {})
     end
 
-    def validate_arrays(parameters:)
-      ARRAY_PARAMETERS.each do |key|
-        raise ArgumentError, "#{key} must be an array" unless parameters[key.to_sym].is_a?(Array)
-      end
+    def resources(parameters:)
+      parameters = valid_parameters(method: :resources, parameters: parameters)
+      @client.json_post(path: "/agent/resources/output", parameters: parameters)
     end
   end
 end

data/lib/superagi/agent_validation.rb

@@ -0,0 +1,70 @@
+module SuperAGI
+  module AgentValidation
+    private
+
+    ARRAY_CREATE_PARAMETERS = %w[
+      constraints
+      goal
+      tools
+    ].freeze
+
+    DEFAULT_CREATE_PARAMETERS = {
+      agent_workflow: "Goal Based Workflow",
+      model: "gpt-4"
+    }.freeze
+    REQUIRED_CREATE_PARAMETERS = (%w[
+      description
+      instruction
+      iteration_interval
+      max_iterations
+      name
+    ] + ARRAY_CREATE_PARAMETERS + DEFAULT_CREATE_PARAMETERS.keys).freeze
+
+    # Update parameters need to always include any List types, even if they are empty,
+    # otherwise the API will return a NoneType error.
+    DEFAULT_UPDATE_PARAMETERS = {
+      constraints: [],
+      goal: [],
+      tools: []
+    }.freeze
+    REQUIRED_UPDATE_PARAMETERS = DEFAULT_UPDATE_PARAMETERS.keys.freeze
+
+    REQUIRED_RESOURCES_PARAMETERS = %w[run_ids].freeze
+
+    def valid_parameters(method:, parameters:)
+      parameters = default_parameters(method: method, parameters: parameters)
+      validate_presence(method: method, parameters: parameters)
+      validate_arrays(method: method, parameters: parameters)
+      parameters
+    end
+
+    def default_parameters(method:, parameters:)
+      case method
+      when :create then DEFAULT_CREATE_PARAMETERS.merge(parameters)
+      when :update then DEFAULT_UPDATE_PARAMETERS.merge(parameters)
+      else parameters
+      end
+    end
+
+    def validate_presence(method:, parameters:)
+      required_parameters = case method
+                            when :create then REQUIRED_CREATE_PARAMETERS
+                            when :update then REQUIRED_UPDATE_PARAMETERS
+                            when :resources then REQUIRED_RESOURCES_PARAMETERS
+                            end
+      required_parameters.each do |key|
+        raise ArgumentError, "#{key} is required" unless parameters[key.to_sym]
+      end
+    end
+
+    def validate_arrays(method:, parameters:)
+      array_parameters = case method
+                         when :create, :update then ARRAY_CREATE_PARAMETERS
+                         when :resources then REQUIRED_RESOURCES_PARAMETERS
+                         end
+      array_parameters.each do |key|
+        raise ArgumentError, "#{key} must be an array" unless parameters[key.to_sym].is_a?(Array)
+      end
+    end
+  end
+end

data/lib/superagi/http.rb

@@ -13,6 +13,13 @@ module SuperAGI
       end&.body)
     end
 
+    def json_put(path:, parameters:)
+      to_json(conn.put(uri(path: path)) do |req|
+        req.headers = headers
+        req.body = parameters.to_json
+      end&.body)
+    end
+
     def delete(path:)
       to_json(conn.delete(uri(path: path)) do |req|
         req.headers = headers

data/lib/superagi/version.rb

@@ -1,3 +1,3 @@
 module SuperAGI
-  VERSION = "0.1.0".freeze
+  VERSION = "0.3.0".freeze
 end

data/lib/superagi.rb

@@ -3,6 +3,7 @@ require "faraday/multipart"
 
 require_relative "superagi/http"
 require_relative "superagi/client"
+require_relative "superagi/agent_validation"
 require_relative "superagi/agent"
 
 module SuperAGI

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superagi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2023-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -69,6 +69,7 @@ files:
 - lib/ruby/superagi.rb
 - lib/superagi.rb
 - lib/superagi/agent.rb
+- lib/superagi/agent_validation.rb
 - lib/superagi/client.rb
 - lib/superagi/compatibility.rb
 - lib/superagi/http.rb