ruby-agents 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca0396754afd0be4aac5df2f2c120e72d2898eea74f52df8fdfc8c414a941e70
-  data.tar.gz: 8805783b3594ed85b56658d2a0f8e9386ce6e9cdf1f18c4a9eaa0d12c6f7a7f6
+  metadata.gz: dea36bf15988aaf769096d19041e9358317ff6a8dc277a418514e0d8e957f8f2
+  data.tar.gz: 183361122b78107dde2646db255871746c5b380ff2c7e483b762c22ccb17d21f
 SHA512:
-  metadata.gz: 1b08f556416b78e11f9ab6d13f25c3f7f6b7a5c841c859b70d674fe37c91f62f36a3734ee0a388aea0584a5786e495e38b8ab3eb513265a95bfadc46cb1af8db
-  data.tar.gz: 5dba6e632f9d6cf3c452a796297fbcb191a02296cb0197889bfdc69b28d581f454b74882f47b0a56126ca015b0ce5be2bbb7dd250fa3d316d3af6ca65cd24e47
+  metadata.gz: d8194908ff998e405a9893e6a663e5b58bd82849230ea753ba04da498eca905539f7db5dd91cf8167093aec59f503685e83d8bc262255c18be3c66af7dbcbc12
+  data.tar.gz: 97f6f490797b0e1c488ce7fda4688893eed2702dcc6ab41f66ea1cef942192764c6457e17d8cec8b82191fdcbf2698a27dfc4f9af41a46edd11596a5f2ec4d8f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-agents (0.1.2)
+    ruby-agents (0.2.2)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -7,11 +7,22 @@ A ruby library for building and managing AI agents within your application.
 Gemfile:
 
 ```ruby
-gem 'agents', git: "jeffmcfadden/agents"
+gem 'ruby-agents'
 ```
 
 `bundle install`
 
+### OR
+
+```shell
+$ gem install ruby-agents
+```
+
+```ruby
+require 'agents'
+```
+
+
 ## Usage
 
 ```ruby
@@ -27,6 +38,9 @@ gem 'agents', git: "jeffmcfadden/agents"
 ### Running Actions
 
 
+## Prompt Injection
+At this time there is no built-in protection from prompt injection/jailbreak/etc. 
+
 ## Testing
 
 Use `tldr` to run the tests.

data/agents.gemspec

@@ -1,25 +1,22 @@
 # -*- encoding: utf-8 -*-
 # frozen_string_literal: true
 
-require 'logger'
-require_relative 'lib/version'
+require_relative 'lib/agents/version'
 
 Gem::Specification.new do |s|
-  s.name = "ruby-agents"
+  s.name        = "ruby-agents"
   s.version     = Agents::VERSION
-  s.platform    = Gem::Platform::RUBY
-
   s.authors = ["Jeff McFadden"]
-  s.date = "2023-11-05"
-  s.description = "Put AI to Work."
   s.email = "55709+jeffmcfadden@users.noreply.github.com"
-  s.files = `git ls-files`.split("\n")
 
+  s.summary = "Setup and organize requests between multiple AI agents."
   s.homepage = "https://github.com/jeffmcfadden/agents"
+  s.license = "MIT"
+  s.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  s.files = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
-  s.rubygems_version = Agents::VERSION
-  s.summary = "Setup and organize requests between multiple AI agents."
 
   s.add_development_dependency "tldr", ">= 0.9.5"
   s.add_development_dependency "ruby-openai", ">= 5.1"
-end
+end

data/lib/{actions → agents/actions}/action.rb

@@ -9,18 +9,15 @@ module Agents
     # @param [String] description
     # @param [Array<ActionArgument>] arguments
     # @param [Array<ActionExample>] examples
-    # @param [Block] block
-    def initialize(name:, description: "", arguments: [], examples: [], &block)
+    def initialize(name:, description: "", arguments: [], examples: [])
       @name = name
       @description = description
       @arguments = arguments
       @examples = examples
-      @block = block
     end
 
     # Execute the block with the given arguments.
-    def call(args)
-      @block.call(args)
+    def perform(request:, args:)
     end
 
     def for_prompt

data/lib/agents/actions/ask_for_clarification_action.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Agents
+  module Actions
+    class AskForClarificationAction < Action
+      def initialize
+        super(name: "ask_for_clarification",
+              description: "Ask for clarification if the request is not clear, or you don't know how to help.",
+              arguments: [ActionArgument.new(name: "question", type: "String", description: "The question, clarification, or additional information you need.")],
+        )
+      end
+
+      def perform(request:, args:)
+        args.dig("question")
+      end
+    end
+
+  end
+end

data/lib/agents/actions/delegate_action.rb

@@ -0,0 +1,20 @@
+module Agents
+  module Actions
+    class DelegateAction < Action
+      def initialize(handler:)
+        super(name: "delegate",
+              description: "Delegate to another agent",
+              arguments: [
+                ActionArgument.new(name: "agent", type: "String", description: "The name of the agent to delegate the request to.")
+              ]
+        )
+        @handler = handler
+      end
+
+      def perform(request:, args:)
+        @handler.delegate_request(request: request, args: args)
+      end
+    end
+
+  end
+end

data/lib/agents/agents/agent.rb

@@ -0,0 +1,74 @@
+module Agents
+  class Agent
+    attr_reader :gpt_client
+    attr_reader :name
+    attr_reader :description
+    attr_reader :system_prompt
+    attr_reader :actions
+    attr_reader :children
+
+    DEFAULT_SYSTEM_PROMPT = <<~EOS
+        You are a helpful assistant. You will try your best to help answer or delegate each request you receive. If you need
+        additional information to process a request, please ask for it. If you're not quite sure what to do, please ask for
+        help or clarification.
+
+        For each request, please respond ONLY with a JSON object. The JSON object should have a single (one) top-level key: `actions`. 
+        The `actions` key should be an array of JSON objects, each of which has a `name` key and an `args` key. If you aren't sure what actions 
+        should be taken, or you don't think there's anything relevant, then respond with an empty object for the `actions` key. The `args`
+        key should be a JSON object with the arguments for the action.
+
+EOS
+
+    # @param actions [Array<Actions::Action>]
+    def initialize(gpt_client:, name: "", description: "", system_prompt: DEFAULT_SYSTEM_PROMPT, actions: [Actions::AskForClarificationAction.new], children: [])
+      @gpt_client = gpt_client
+      @name = name
+      @description = description
+      @system_prompt = system_prompt
+      @children = children
+
+      @actions = actions
+      @actions << Actions::DelegateAction.new(handler: self) if children.any?
+    end
+
+    def handle(request:)
+      gpt_response = gpt_client.chat system_prompt: build_prompt, prompt: "#{request.request_text}"
+      results = gpt_response.suggested_actions.map{ |sa|
+        actions.find{ |a| a.name == sa.dig("name") }&.perform(request: request, args: sa.dig("args"))
+      }.compact
+
+      if results.empty?
+        "I'm sorry, I don't know how to handle that request."
+      else
+        results.reduce("", :+)
+      end
+    end
+
+    def build_prompt
+      prompt = system_prompt.dup
+
+      if actions.any?
+        prompt << "The ONLY actions you can take are: #{actions.collect(&:name).join(", ")}. Here are the details on those actions: \n"
+        prompt << actions.collect(&:for_prompt).join("\n\n")
+      end
+
+      if children.any?
+        prompt << <<~EOS
+
+If you don't know how to handle this request, please `delegate` it to another agent. The agents you can `delegate` to are:
+#{children.each.collect{ "  - #{_1.name}: #{_1.description}" }.join("\n")}
+
+If you choose to delegate this request, please be sure to include `agent` as a key in your `args` object.
+
+EOS
+      end
+
+      prompt
+    end
+
+    def delegate_request(request:, args:)
+      children.find{ |c| c.name == args.dig("agent") }&.handle(request: request)
+    end
+
+  end
+end

data/lib/agents/{gpt_agents → agents}/calendar_gpt_agent.rb

@@ -1,5 +1,5 @@
 module Agents
-  class CalendarGptAgent < GptAgent
+  class CalendarGptAgent < Agent
 
     attr_reader :system_prompt
     def initialize(**args)

data/lib/agents/{gpt_agents → agents}/categorizing_gpt_agent.rb

@@ -1,5 +1,5 @@
 module Agents
-  class CategorizingGptAgent < GptAgent
+  class CategorizingGptAgent < Agent
 
     attr_reader :system_prompt
     def initialize(**args)

data/lib/agents/agents/dispatching_gpt_agent.rb

@@ -0,0 +1,46 @@
+module Agents
+  class DispatchingGptAgent < Agent
+
+    attr_reader :agents
+
+    def initialize(agents:[], **args)
+      super(**args)
+      @agents = agents
+    end
+
+    def system_prompt
+      prompt = <<~EOS
+        You are a helpful assistant. You will try your best to help answer or delegate each request you receive. If you need
+        additional information to process a request, please ask for it. If you're not quite sure what to do, please ask for
+        help or clarification.
+
+        For each request, please respond ONLY with a JSON object. The JSON object should have two top-level keys: `response` 
+        and `actions`. The `response` key should be a short message that summarizes the actions to be taken. The `actions` key 
+        should be an array of JSON objects, each of which has a `name` key and an `args` key. If you aren't sure what actions 
+        should be taken, or you don't think there's anything relevant, then respond with an empty array for the `actions` key.
+
+        The actions you can take are:
+
+        `ask_for_clarification`: Ask for help or clarification. The `args` key should be a JSON object with a single key, `request_text`.
+        `delegate`: Delegate the request to another assistant. The `args` key should be a JSON object with a single key, `next_agent`.
+
+        The agents you can delegate to are:
+            - #{agents.each.collect{ "    - #{_1.name}: #{_1.description}" }.join("\n")}
+
+        If you are not sure which Assistant to use, it's okay to ask for more information with the `ask_for_clarification` action.
+      
+      EOS
+    end
+
+    def handle(request:)
+      response = gpt_client.chat system_prompt: system_prompt, prompt: "#{prompt_prefix}#{request.request_text}"
+
+      response.suggested_actions.each do |action|
+        actions.find{ |a| a.name == action["name"] }&.call(action["args"])
+      end
+
+      response
+    end
+
+  end
+end

data/lib/agents/{gpt_agents → agents}/information_retrieval_gpt_agent.rb

@@ -1,5 +1,5 @@
 module Agents
-  class InformationRetrievalGptAgent < GptAgent
+  class InformationRetrievalGptAgent < Agent
 
     attr_reader :system_prompt
     def initialize(**args)

data/lib/agents/{gpt_agents → agents}/promptless_gpt_agent.rb

@@ -1,7 +1,7 @@
 module Agents
   # An agent that does not add a prompt to the request, but simply passes it through.
   # Use if your test _is _the prompt, for example.
-  class PromptlessGptAgent < GptAgent
+  class PromptlessGptAgent < Agent
     def handle(request:)
       Response.new(response_text: gpt_client.chat(prompt: request.request_text))
     end

data/lib/agents/{gpt_agents → agents}/todo_gpt_agent.rb

@@ -1,5 +1,5 @@
 module Agents
-  class TodoGptAgent < GptAgent
+  class TodoGptAgent < Agent
 
     def initialize(**args)
       super(**args)

data/lib/agents/{unhandleable_request_agent.rb → agents/unhandleable_request_agent.rb}

@@ -1,5 +1,5 @@
 module Agents
-  class UnhandleableRequestAgent
+  class UnhandleableRequestAgent < Agent
     def handle(request:)
       return UnhandleableRequestResponse.new(request: request)
     end

data/lib/agents/version.rb

@@ -0,0 +1,3 @@
+module Agents
+  VERSION = "0.2.2"
+end

data/lib/agents.rb

@@ -1,39 +1,33 @@
-require_relative 'logger'
-require_relative 'version'
+require_relative 'agents/logger'
+require_relative 'agents/version'
 
 require 'openai' rescue nil # OpenAI is optional
 
-require_relative 'gpt_clients/gpt_client'
-require_relative 'gpt_clients/echo_gpt_client'
+require_relative 'agents/gpt_clients/gpt_client'
+require_relative 'agents/gpt_clients/echo_gpt_client'
 
 if defined?(::OpenAI::Client)
-  require_relative 'gpt_clients/open_ai_gpt_client'
+  require_relative 'agents/gpt_clients/open_ai_gpt_client'
 end
 
-require_relative 'agents/agent'
-require_relative 'agents/dispatcher'
-require_relative 'agents/echo_agent'
+require_relative 'agents/agents/agent'
+require_relative 'agents/agents/calendar_gpt_agent'
+require_relative 'agents/agents/categorizing_gpt_agent'
+require_relative 'agents/agents/dispatching_gpt_agent'
+require_relative 'agents/agents/information_retrieval_gpt_agent'
+require_relative 'agents/agents/promptless_gpt_agent'
+require_relative 'agents/agents/todo_gpt_agent'
 
-require_relative 'agents/gpt_agents/gpt_agent'
-require_relative 'agents/gpt_agents/calendar_gpt_agent'
-require_relative 'agents/gpt_agents/categorizing_gpt_agent'
-require_relative 'agents/gpt_agents/dispatching_gpt_agent'
-require_relative 'agents/gpt_agents/information_retrieval_gpt_agent'
-require_relative 'agents/gpt_agents/promptless_gpt_agent'
-require_relative 'agents/gpt_agents/todo_gpt_agent'
+require_relative 'agents/agents/unhandleable_request_agent'
 
-require_relative 'agents/unhandleable_request_agent'
+require_relative 'agents/requests/request'
 
-require_relative 'requests/request'
+require_relative 'agents/responses/response'
+require_relative 'agents/responses/gpt_response'
+require_relative 'agents/responses/unhandleable_request_response'
 
-require_relative 'responses/response'
-require_relative 'responses/gpt_response'
-require_relative 'responses/unhandleable_request_response'
-
-require_relative 'actions/action'
-require_relative 'actions/action_argument'
-require_relative 'actions/action_example'
-
-module Agents
-
-end
+require_relative 'agents/actions/action'
+require_relative 'agents/actions/action_argument'
+require_relative 'agents/actions/action_example'
+require_relative 'agents/actions/ask_for_clarification_action'
+require_relative 'agents/actions/delegate_action'

data/test/test_actions.rb

@@ -3,85 +3,40 @@ require 'agents'
 module Agents
   class TestActions < TLDR
 
-    def setup
-      @gpt_client = EchoGptClient.new
-      @dispatcher = DispatchingGptAgent.new(gpt_client: @gpt_client)
-      @agent = TodoGptAgent.new(gpt_client: @gpt_client)
-
-      @dispatcher.register(@agent)
-    end
+    class AddTodoAction < Action
+      def initialize
+        super(name: "add_todo",
+              description: "Add a todo to a list",
+              arguments: [ActionArgument.new(name: "todo_list",  type: "String", description: "The name of the todo list to add the item to"),
+                          ActionArgument.new(name: "item_title", type: "String", description: "The title of the item to add to the list")]
+        )
 
-    def test_dispatching_prompt
-      test_action = Action.new(name: "test_action") do |args|
-        puts "This is a test action"
       end
-
-      @agent.register(action: test_action)
-
-      # This is a JSON payload because the EchoGPTClient will echo this back as the response
-      test_payload = {
-        "response": "I added peanut butter to your grocery list.",
-        "actions": [
-          {
-            "name": "test_action",
-            "args": [
-              {
-                "todo_list": "Grocery",
-                "item_title": "peanut butter"
-              }
-            ]
-          }
-        ]
-      }
-
-      test_request = Request.new(test_payload.to_json)
-
-      response = @agent.handle(request: test_request)
-
-      assert_equal "{\"response\":\"I added peanut butter to your grocery list.\",\"actions\":[{\"name\":\"test_action\",\"args\":[{\"todo_list\":\"Grocery\",\"item_title\":\"peanut butter\"}]}]}", response.raw_text
-      # assert_equal "I added peanut butter to your grocery list.", response.response_text
-      # assert_equal response.suggested_actions.size, 1
-    end
-
-
-    class TestablePerformingAction < Action
-
-      attr_reader :was_performed
-      def initialize(**args)
-        super(**args)
-        @was_performed = false
-      end
-
-      def call(args)
-        super(args)
-        @was_performed = true
+      def perform(request:, args:)
+        "I am the add todo action and I just handled a request."
       end
     end
 
-    class TestActionPerformingGptAgent < GptAgent
+    def setup
+      @test_gpt_client = Agents::EchoGptClient.new
 
+      @todo_agent = Agent.new(gpt_client: @test_gpt_client,
+                              name: "todo_agent",
+                              description: "Handles todo list and reminders actions.",
+                              actions: [AddTodoAction.new]
+      )
     end
 
-    def test_performing_action
-      test_action = TestablePerformingAction.new(name: "test_action") do
-        return "This is a test action"
-      end
-
-      agent = TestActionPerformingGptAgent.new(gpt_client: @gpt_client, system_prompt: "This is a test prompt", description: "This is a test description")
-
-      assert_equal false, test_action.was_performed
-
-      agent.register(action: test_action)
+    def test_action
+      echo_request_data = { actions: [{ name: "add_todo", args: { todo_list: "Grocery", item_title: "Milk" } }] }
 
-      # This is a JSON payload because the EchoGPTClient will echo this back as the response
-      test_payload = { response: "I performed the test action for you", actions: [{ name: "test_action", args: {} }] }
+      response = @todo_agent.handle(request: Request.new(echo_request_data.to_json))
 
-      test_request = Request.new(test_payload.to_json)
-      response = agent.handle(request: test_request)
-
-      assert_equal true, test_action.was_performed
-      assert_equal "I performed the test action for you", response.response_text
+      # We expect this response because the default agent won't know what to do with the request, but it won't have
+      # broken anything either.
+      assert_equal "I am the add todo action and I just handled a request.", response
     end
 
   end
-end
+end
+

data/test/test_openai.rb

@@ -10,56 +10,38 @@ require 'agents'
 
 module Agents
 
-  class ActionPerformingGptAgent < GptAgent
+  class AddTodoAction < Action
+    def initialize
+      super(name: "add_todo",
+            description: "Add a todo to a list",
+            arguments: [ActionArgument.new(name: "todo_list",  type: "String", description: "The name of the todo list to add the item to"),
+                        ActionArgument.new(name: "item_title", type: "String", description: "The title of the item to add to the list")]
+      )
+
+    end
+    def perform(request:, args:)
+      puts "I am the add todo action and I just handled #{args}"
+    end
   end
 
   class TestOpenAi
     def initialize
       @openai_client = OpenAI::Client.new(access_token: ENV['OPENAI_ACCESS_TOKEN'])
       @gpt_client = Agents::OpenAiGptClient.new(open_ai_client: @openai_client)
-    end
-
-    def test_basic_chat
-      puts "-" * 60
-      puts "test_basic_chat:"
-      @agent = Agents::PromptlessGptAgent.new(gpt_client: @gpt_client)
-      response = @agent.handle(request: Request.new("Tell me a joke"))
-      puts response.response_text
-    end
 
-    def test_dispatching_chat
-      puts "-" * 60
-      puts "test_dispatching_chat:"
-      dispatcher = Agents::DispatchingGptAgent.new(gpt_client: @gpt_client)
-      dispatcher.register(Agents::TodoGptAgent.new(gpt_client: @gpt_client))
-      dispatcher.register(Agents::CalendarGptAgent.new(gpt_client: @gpt_client))
-      dispatcher.register(Agents::InformationRetrievalGptAgent.new(gpt_client: @gpt_client))
+      @todo_agent = Agent.new(gpt_client: @gpt_client,
+                              name: "todo_agent",
+                              description: "Handles todo list and reminders actions.",
+                              actions: [AddTodoAction.new]
+      )
 
-      response = dispatcher.handle(request: Request.new("I need to buy break and milk"))
-      puts response
+      @primary_agent = Agent.new(gpt_client: @gpt_client, children: [@todo_agent])
     end
 
-    def test_todo_action
-      puts "-" * 60
-      puts "test_dispatching_chat:"
-
-      todo_agent = Agents::TodoGptAgent.new(gpt_client: @gpt_client)
-
-      add_todo_action = Action.new(name: "add_todo",
-                                   description: "Add a todo to a list",
-                                   arguments: [{name: "todo_list",  description: "The name of the todo list to add the item to"},
-                                               {name: "item_title", description: "The title of the item to add to the list"}]
-      ) do |**args|
-        puts "I added the todo"
-      end
-
-      todo_agent.register(action: add_todo_action)
 
-      dispatcher = Agents::DispatchingGptAgent.new(gpt_client: @gpt_client)
-      dispatcher.register(todo_agent)
-
-      response = dispatcher.handle(request: Request.new("I need to buy break and milk"))
-      puts response.response_text
+    def test_todo_action
+      response = @primary_agent.handle(request: Request.new("I need to buy bread and milk"))
+      puts response
     end
 
   end
@@ -67,7 +49,5 @@ end
 
 # Skip this test if we don't have an access token
 unless ENV['OPENAI_ACCESS_TOKEN'].nil?
-  # Agents::TestOpenAi.new.test_basic_chat
-  # Agents::TestOpenAi.new.test_dispatching_chat
   Agents::TestOpenAi.new.test_todo_action
 end

data/test/test_with_children.rb

@@ -0,0 +1,75 @@
+require 'agents'
+
+module Agents
+  class TestWithChildren < TLDR
+
+    class AddTodoAction < Action
+      def initialize
+        super(name: "add_todo",
+              description: "Add a todo to a list",
+              arguments: [ActionArgument.new(name: "todo_list",  type: "String", description: "The name of the todo list to add the item to"),
+                          ActionArgument.new(name: "item_title", type: "String", description: "The title of the item to add to the list")]
+              )
+
+      end
+      def perform(request:, args:)
+        "I am the add todo action and I just handled a request"
+      end
+    end
+
+    def setup
+      @test_gpt_client = Agents::EchoGptClient.new
+
+      @todo_agent = Agent.new(gpt_client: @test_gpt_client,
+                              name: "todo_agent",
+                              description: "Handles todo list and reminders actions.",
+                              actions: [AddTodoAction.new]
+      )
+
+      @primary_agent = Agent.new(gpt_client: @test_gpt_client, children: [@todo_agent])
+    end
+
+    def test_prompt
+      expected_prompt = <<~EOS
+You are a helpful assistant. You will try your best to help answer or delegate each request you receive. If you need
+additional information to process a request, please ask for it. If you're not quite sure what to do, please ask for
+help or clarification.
+
+For each request, please respond ONLY with a JSON object. The JSON object should have a single (one) top-level key: `actions`. 
+The `actions` key should be an array of JSON objects, each of which has a `name` key and an `args` key. If you aren't sure what actions 
+should be taken, or you don't think there's anything relevant, then respond with an empty object for the `actions` key. The `args`
+key should be a JSON object with the arguments for the action.
+
+The ONLY actions you can take are: ask_for_clarification, delegate. Here are the details on those actions: 
+ask_for_clarification: Ask for clarification if the request is not clear, or you don't know how to help.
+  Arguments:
+    question: The question, clarification, or additional information you need.
+
+
+delegate: Delegate to another agent
+  Arguments:
+    agent: The name of the agent to delegate the request to.
+
+If you don't know how to handle this request, please `delegate` it to another agent. The agents you can `delegate` to are:
+  - todo_agent: Handles todo list and reminders actions.
+
+If you choose to delegate this request, please be sure to include `agent` as a key in your `args` object.
+
+      EOS
+
+      assert_equal expected_prompt, @primary_agent.build_prompt
+    end
+
+    def test_delegating
+      echo_request_data = { actions: [{ name: "delegate", args: { agent: "todo_agent" } }] }
+
+      response = @primary_agent.handle(request: Request.new(echo_request_data.to_json))
+
+      # We expect this response because the default agent won't know what to do with the request, but it won't have
+      # broken anything either.
+      assert_equal "I'm sorry, I don't know how to handle that request.", response
+    end
+
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-agents
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.2
 platform: ruby
 authors:
 - Jeff McFadden
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-05 00:00:00.000000000 Z
+date: 2023-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tldr
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-description: Put AI to Work.
+description:
 email: 55709+jeffmcfadden@users.noreply.github.com
 executables: []
 extensions: []
@@ -50,38 +50,36 @@ files:
 - LICENSE
 - README.md
 - agents.gemspec
-- lib/actions/action.rb
-- lib/actions/action_argument.rb
-- lib/actions/action_example.rb
 - lib/agents.rb
-- lib/agents/agent.rb
-- lib/agents/dispatcher.rb
-- lib/agents/echo_agent.rb
-- lib/agents/gpt_agents/calendar_gpt_agent.rb
-- lib/agents/gpt_agents/categorizing_gpt_agent.rb
-- lib/agents/gpt_agents/dispatching_gpt_agent.rb
-- lib/agents/gpt_agents/echo_gpt_agent.rb
-- lib/agents/gpt_agents/gpt_agent.rb
-- lib/agents/gpt_agents/information_retrieval_gpt_agent.rb
-- lib/agents/gpt_agents/promptless_gpt_agent.rb
-- lib/agents/gpt_agents/todo_gpt_agent.rb
-- lib/agents/unhandleable_request_agent.rb
-- lib/gpt_clients/echo_gpt_client.rb
-- lib/gpt_clients/gpt_client.rb
-- lib/gpt_clients/open_ai_gpt_client.rb
-- lib/logger.rb
-- lib/requests/request.rb
-- lib/responses/gpt_response.rb
-- lib/responses/response.rb
-- lib/responses/unhandleable_request_response.rb
-- lib/version.rb
+- lib/agents/actions/action.rb
+- lib/agents/actions/action_argument.rb
+- lib/agents/actions/action_example.rb
+- lib/agents/actions/ask_for_clarification_action.rb
+- lib/agents/actions/delegate_action.rb
+- lib/agents/agents/agent.rb
+- lib/agents/agents/calendar_gpt_agent.rb
+- lib/agents/agents/categorizing_gpt_agent.rb
+- lib/agents/agents/dispatching_gpt_agent.rb
+- lib/agents/agents/echo_gpt_agent.rb
+- lib/agents/agents/information_retrieval_gpt_agent.rb
+- lib/agents/agents/promptless_gpt_agent.rb
+- lib/agents/agents/todo_gpt_agent.rb
+- lib/agents/agents/unhandleable_request_agent.rb
+- lib/agents/gpt_clients/echo_gpt_client.rb
+- lib/agents/gpt_clients/gpt_client.rb
+- lib/agents/gpt_clients/open_ai_gpt_client.rb
+- lib/agents/logger.rb
+- lib/agents/requests/request.rb
+- lib/agents/responses/gpt_response.rb
+- lib/agents/responses/response.rb
+- lib/agents/responses/unhandleable_request_response.rb
+- lib/agents/version.rb
 - test/test_actions.rb
-- test/test_dispatcher.rb
-- test/test_gpt_dispatcher.rb
 - test/test_openai.rb
-- test/test_todo_gpt_agent.rb
+- test/test_with_children.rb
 homepage: https://github.com/jeffmcfadden/agents
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -91,14 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Setup and organize requests between multiple AI agents.

data/lib/agents/agent.rb

@@ -1,24 +0,0 @@
-module Agents
-  class Agent
-    attr_reader :actions
-
-    def initialize(actions: [])
-      @actions = actions
-    end
-
-    # @param [Request] request
-    # @return [Response] response
-    def handle(request:)
-      Response.new("Sorry, this agent doesn't know how to handle requests.")
-    end
-
-    def register(action:)
-      @actions << action
-    end
-
-    def unregister(action:)
-      @actions.delete(action)
-    end
-
-  end
-end

data/lib/agents/dispatcher.rb

@@ -1,29 +0,0 @@
-module Agents
-  class Dispatcher < Agent
-    attr_reader :agents
-    def initialize(agents: [], **args)
-      super(**args)
-      @agents = agents
-    end
-
-    def register(agent)
-      @agents << agent
-    end
-
-    def unregister(agent)
-      @agents.delete(agent)
-    end
-
-    def handle(request:)
-      agent = agent_for_request(request: request)
-      agent.handle(request: request)
-    end
-
-    # Default behavior is a random agent. Use a subclass to specify behavior.
-    def agent_for_request(request:)
-      return UnhandleableRequestAgent.new if agents.empty?
-
-      @agents.shuffle.first
-    end
-  end
-end

data/lib/agents/echo_agent.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Agents
-    # An agent that echoes back the request text. Useful for testing.
-    class EchoAgent < Agent
-
-      # @param [Request] request
-      def handle(request:)
-        Response.new(request.request_text)
-      end
-    end
-end

data/lib/agents/gpt_agents/dispatching_gpt_agent.rb

@@ -1,27 +0,0 @@
-module Agents
-  class DispatchingGptAgent < Dispatcher
-    attr_reader :gpt_client
-
-    def initialize(gpt_client:, **args)
-      super(**args)
-      @gpt_client = gpt_client
-    end
-    def agent_for_request(request:)
-      categorize_request = Request.new(prompt_for_categorizing_request(request: request))
-
-      response_data = CategorizingGptAgent.new(gpt_client: gpt_client)
-                                          .handle(request: categorize_request).data
-
-      agent_class = response_data["category"]
-      agents.find{ _1.class.name == agent_class } || UnhandleableRequestAgent.new
-    end
-
-    def prompt_for_categorizing_request(request:)
-      prompt = "The following is a list of Assistants and a description of what each can do: \n\n"
-      prompt << agents.collect{ "#{_1.class.name}: #{_1.description}" }.join("\n\n")
-      prompt << "If you are not sure which Assistant to use, it's okay to ask for more information.\n\n"
-      prompt << "Please categorize the request by typing the name of the Assistant that best fits the request.\n\n"
-      prompt << "Request: #{request.request_text}"
-    end
-  end
-end

data/lib/agents/gpt_agents/gpt_agent.rb

@@ -1,29 +0,0 @@
-module Agents
-  class GptAgent < Agent
-    attr_reader :gpt_client
-    attr_reader :description
-    attr_reader :system_prompt
-
-    def initialize(gpt_client:, description: "An AI Chatbot", system_prompt: "", **args)
-      super(**args)
-      @gpt_client = gpt_client
-      @description = description
-      @system_prompt = system_prompt
-    end
-
-    def handle(request:)
-      response = gpt_client.chat system_prompt: system_prompt, prompt: "#{prompt_prefix}#{request.request_text}"
-
-      response.suggested_actions.each do |action|
-        actions.find{ |a| a.name == action["name"] }&.call(action["args"])
-      end
-
-      response
-    end
-
-    def prompt_prefix
-      ""
-    end
-
-  end
-end

data/lib/version.rb

@@ -1,3 +0,0 @@
-module Agents
-  VERSION = "0.1.2"
-end

data/test/test_dispatcher.rb

@@ -1,38 +0,0 @@
-require 'agents'
-
-module Agents
-  class TestDispatcher < TLDR
-
-    def setup
-      @dispatcher = Dispatcher.new
-      @agent1 = Agent.new
-      @agent2 = Agent.new
-
-      @echo_agent = EchoAgent.new
-    end
-
-    def test_registration
-      @dispatcher.register(@agent1)
-      @dispatcher.register(@agent2)
-      assert_equal(@dispatcher.agents, [@agent1, @agent2])
-    end
-
-    def test_unregistration
-      @dispatcher.register(@agent1)
-      @dispatcher.register(@agent2)
-      @dispatcher.unregister(@agent1)
-      assert_equal(@dispatcher.agents, [@agent2])
-    end
-
-    def test_default_handling
-      @dispatcher.register(@echo_agent)
-
-      # Default handling is to select a random agent. In this case we have a single
-      # echoing agent, so we expect the codepath to be exercised, but we know it will
-      # always be that one agent.
-      response = @dispatcher.handle(request: Request.new("Test Request"))
-      assert_equal("Test Request", response.response_text )
-    end
-
-  end
-end

data/test/test_gpt_dispatcher.rb

@@ -1,25 +0,0 @@
-require 'agents'
-
-module Agents
-  class TestGptDispatcher < TLDR
-
-    def setup
-      @gpt_client = EchoGptClient.new
-      @dispatcher = DispatchingGptAgent.new(gpt_client: @gpt_client)
-      @agent1 = TodoGptAgent.new(gpt_client: @gpt_client)
-      @agent2 = CalendarGptAgent.new(gpt_client: @gpt_client)
-
-      @dispatcher.register(@agent1)
-      @dispatcher.register(@agent2)
-    end
-
-    def test_dispatching_prompt
-      request = Request.new("I need to buy some bread")
-
-      expected = "The following is a list of Assistants and a description of what each can do: \n\nAgents::TodoGptAgent: I am an AI Assistant that specializes in Todo List and Reminders Management.\n\nAgents::CalendarGptAgent: I am an AI Assistant that specializes in Calendar and Scheduling Management for Appointments, meetings, etc.Please categorize the request by typing the name of the Assistant that best fits the request.\n\nRequest: I need to buy some bread"
-
-      assert_equal(expected, @dispatcher.prompt_for_categorizing_request(request: request))
-    end
-
-  end
-end

data/test/test_todo_gpt_agent.rb

@@ -1,51 +0,0 @@
-require 'agents'
-
-module Agents
-  class TestTodoGptAgent < TLDR
-
-    def setup
-      @agent = TodoGptAgent.new(gpt_client: EchoGptClient.new)
-
-      add_todo_action = Action.new(name: "add_todo",
-                                   description: "Add a todo to a list",
-                                   arguments: [ActionArgument.new(name: "todo_list",  type: "String", description: "The name of the todo list to add the item to"),
-                                               ActionArgument.new(name: "item_title", type: "String", description: "The title of the item to add to the list")],
-                                   examples: [ActionExample.new(input: "I'm out of milk and bread",
-                                                                output: { response: "I added milk and bread to your grocery list.",
-                                                                          actions: [{name: "add_item", args:[{todo_list: "Grocery", "item_title": "milk"}]},
-                                                                                    {name: "add_item", args:[{todo_list: "Grocery", "item_title": "bread"}]}
-                                                                          ]}.to_json  )]
-      ) do |**args|
-        return "I added the todo"
-      end
-
-      @agent.register(action: add_todo_action)
-    end
-
-    def test_prompt
-      expected_prompt = <<~EOS
-You are a helpful assistant specializing in Todo List and Reminders Management. Please do your best to complete
-any requests you are given. For each request, please respond ONLY with a JSON object. The JSON object should have
-two top-level keys: `response` and `actions`. The `response` key should be a short string that summarizes the actions
-to be taken. The `actions` key should be an array of JSON objects, each of which has a `name` key and an `args` key.
-If you aren't sure what actions should be taken, or you don't think there's anything relevant, then respond with
-an empty array for the `actions` key.
-
-
-The following actions are supported: 
-add_todo: Add a todo to a list
-  Arguments:
-    todo_list: The name of the todo list to add the item to
-    item_title: The title of the item to add to the list
-  For example:
-    Input: I'm out of milk and bread
-    Output: {"response":"I added milk and bread to your grocery list.","actions":[{"name":"add_item","args":[{"todo_list":"Grocery","item_title":"milk"}]},{"name":"add_item","args":[{"todo_list":"Grocery","item_title":"bread"}]}]}
-
-
-EOS
-      assert_equal(expected_prompt, @agent.system_prompt)
-    end
-
-
-  end
-end