ruby-openai-swarm 0.4.0.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75a68f00ed7c7e975dad8438d4642e42e035bbe05d5f3e3ef8f759536a74af97
-  data.tar.gz: 73ec246a79465191f8365064618d7c76832fa3b58148fd60e703f4c3b69b8e11
+  metadata.gz: 326dc0fd2fb1f748c48c67f3f610e7dd3d14911f712e4016ab8cd13a19d6fd6e
+  data.tar.gz: 4d12edacb8d5daa6fe863daa72a06b1f3cad8ded0c01a2c882995ac8b23e1561
 SHA512:
-  metadata.gz: a7b11e67573db5f5197fc137f239f183b0771f9aec067e5f3ba7c4f734145c82bbd9038bfb3a238b6b9b98f58d96c76f61664ef60b875eea516a4d73884b933e
-  data.tar.gz: 639c4469e468a6819d7ed7bea1ac19a8ca97e3c160c3bbab066aa377087b0854bc13e0dc82044a1fb12f7c85abb2c545d1baec1baa040feca07e1fa4be9bf021
+  metadata.gz: 584b8772071a78dfdf43eb33f1e3d31c7c0b47618ffe4d766d07bfdd305781975655a8a1c7b9e9dc4f0e6dee8766881ce3e921ac063bff7a2eb6c7f4dbc1e1bf
+  data.tar.gz: 99c9ff59009c4822397299566a19b0ac07d02d81b47ad03c1449dd7700ca3e9ed5ea62ec1d75223fb1f6ef1c27d44efe93d02717d587527c30c7b41541f2e8b5

data/.github/workflows/rspec.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Run tests
       run: bundle exec rspec
     - name: Upload test results
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       if: failure()
       with:
         name: rspec-results

data/README.md

@@ -165,7 +165,7 @@ DeepSeek V3 is 1/10 price of gpt-4o-mini, so try it!
 - [X] [`triage_agent`](examples/triage_agent): Simple example of setting up a basic triage step to hand off to the right agent
   - running: `ruby examples/triage_agent/main.rb`
 - [X] [`weather_agent`](examples/weather_agent): Simple example of function calling
-  - running: `ruby examples/weather_agent/agents.rb`
+  - running: `ruby examples/weather_agent/run.rb`
 - [X] [`airline`](examples/airline): A multi-agent setup for handling different customer service requests in an airline context.
   - running: `DEBUG=1 ruby examples/airline/main.rb`
 - [ ] [`support_bot`](examples/support_bot): A customer service bot which includes a user interface agent and a help center agent with several tools

data/examples/memory/memory_save.rb

@@ -0,0 +1,71 @@
+require_relative "../bootstrap"
+
+client = OpenAISwarm.new
+model = ENV['SWARM_AGENT_DEFAULT_MODEL'] || "gpt-4o-mini"
+
+memory = OpenAISwarm::Memory.new(memory_fields: ["language", "grade", "name", "sex"])
+memory.function
+
+def get_weather(location:)
+  puts "tool call: get_weather"
+  "{'temp':67, 'unit':'F'}"
+end
+
+def get_news(category:)
+  puts "tool call: get_news"
+  [
+    "Tech Company A Acquires Startup B",
+    "New AI Model Revolutionizes Industry",
+    "Breakthrough in Quantum Computing"
+  ].sample
+end
+
+get_news_instance = OpenAISwarm::FunctionDescriptor.new(
+  target_method: :get_news,
+  description: 'Get the latest news headlines. The category of news, e.g., world, business, sports.'
+)
+
+get_weather_instance = OpenAISwarm::FunctionDescriptor.new(
+  target_method: :get_weather,
+  description: 'Simulate fetching weather data'
+)
+
+
+system_prompt = "You are a helpful teaching assistant. Remember to save important information about the student using the core_memory_save function. Always greet the student by name if you know it."
+
+chatbot_agent = OpenAISwarm::Agent.new(
+  name: "teaching_assistant",
+  instructions: system_prompt,
+  model: model,
+  functions: [
+    get_weather_instance,
+    get_news_instance
+  ],
+  memory: memory
+)
+
+messages1 = [
+  {
+    "role": "user",
+    "content": "Hi, I'm John. I speak Chinese and I'm in Senior Year. Get the current weather in a given location. Location MUST be a city."
+  }
+]
+
+puts "first call, set memory"
+puts "messages: #{messages1}"
+
+response1 = client.run(agent: chatbot_agent, messages: messages1, debug: env_debug)
+puts "memory data: #{memory.entity_store.data}"
+puts response1.messages.last['content']
+
+puts ""
+messages2 = [
+  {"role": "user", "content": "what is my name"},
+]
+puts "2nd call, get memory"
+puts "memory data: #{memory.entity_store.data}"
+puts "messages: #{messages2}"
+
+response2 = client.run(agent: chatbot_agent, messages: messages2, debug: env_debug)
+
+puts response2.messages.last['content']

data/lib/ruby-openai-swarm/agent.rb

@@ -7,7 +7,8 @@ module OpenAISwarm
                   :noisy_tool_calls,
                   :temperature,
                   :current_tool_name,
-                  :resource
+                  :resource,
+                  :memory
     # These attributes can be read and written externally. They include:
     # - name: The name of the agent.
     # - model: The model used, e.g., "gpt-4".
@@ -27,7 +28,8 @@ module OpenAISwarm
       resource: nil,
       noisy_tool_calls: [],
       strategy: {},
-      current_tool_name: nil
+      current_tool_name: nil,
+      memory: nil
     )
       @name = name
       @model = model
@@ -40,6 +42,13 @@ module OpenAISwarm
       @noisy_tool_calls = noisy_tool_calls
       @strategy = Agents::StrategyOptions.new(strategy)
       @current_tool_name = current_tool_name.nil? ? nil : current_tool_name.to_s
+      @memory = memory
+    end
+
+    def functions
+      return @functions if memory&.function.nil?
+
+      @functions.push(memory.function)
     end
   end
 end

data/lib/ruby-openai-swarm/core.rb

@@ -15,11 +15,28 @@ module OpenAISwarm
       @logger = OpenAISwarm::Logger.instance.logger
     end
 
+    # TODO(Grayson)
+    # def create_agent(name:, model:, instructions:, **options)
+    #   memory = Memory.new(@memory_fields)
+    #   Agent.new(
+    #     name: name,
+    #     model: model,
+    #     instructions: instructions,
+    #     memory: memory,
+    #     functions: functions,
+    #     **options
+    #   )
+    # end
+
     def get_chat_completion(agent_tracker, history, context_variables, model_override, stream, debug)
       agent = agent_tracker.current_agent
       context_variables = context_variables.dup
       instructions = agent.instructions.respond_to?(:call) ? agent.instructions.call(context_variables) : agent.instructions
-      messages = [{ role: 'system', content: instructions }] + history
+
+      # Build a message history, including memories
+      messages = [{ role: 'system', content: instructions }]
+      messages << { role: 'system', content: agent.memory.prompt_content } unless agent&.memory&.prompt_content.nil?
+      messages += history
 
       # Util.debug_print(debug, "Getting chat completion for...:", messages)
 
@@ -66,9 +83,10 @@ module OpenAISwarm
 
       Util.debug_print(debug, "API Response:", response)
       response
-    rescue OpenAI::Error => e
-      log_message(:error, "OpenAI API Error: #{e.message}")
-      Util.debug_print(true, "OpenAI API Error:", e.message)
+    rescue OpenAI::Error, Faraday::BadRequestError => e
+      error_message = (e.response || {}).dig(:body) || e.inspect
+      log_message(:error, "OpenAI API Error: #{error_message}")
+      Util.debug_print(true, "OpenAI API Error:", error_message)
       raise
     end
 
@@ -182,11 +200,11 @@ module OpenAISwarm
           debug
         )
 
-        message = completion.dig('choices', 0, 'message')
+        message = completion.dig('choices', 0, 'message') || {}
         Util.debug_print(debug, "Received completion:", message)
         log_message(:info, "Received completion:", message)
 
-        message['sender'] = active_agent.name
+        message['sender'] = active_agent&.name
         history << message
 
         if !message['tool_calls'] || !execute_tools

data/lib/ruby-openai-swarm/memories/core_memory_function.rb

@@ -0,0 +1,27 @@
+module OpenAISwarm
+  module Memories
+    class CoreMemoryFunction
+      def self.definition(memory_fields = [])
+        properties = {}
+
+        memory_fields.each do |memory_field|
+          field = memory_field.field
+          description = "The #{field} to remember." + memory_field&.tool_call_description.to_s
+          properties[field] = { type: "string", description: description }
+        end
+
+        {
+          type: "function",
+          function: {
+            name: "core_memory_save",
+            description: "Save important information about you, the agent or the human you are chatting with.",
+            parameters: {
+              type: "object",
+              properties: properties,
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/ruby-openai-swarm/memories/entity_store.rb

@@ -0,0 +1,54 @@
+module OpenAISwarm
+  module Memories
+    class EntityStore
+      attr_accessor :entity_store,
+                    :data
+
+      def initialize(entity_store = nil)
+        @entity_store = entity_store
+        @data = entity_store&.data || {}
+      end
+
+      def entity_store_save
+        return unless entity_store.respond_to?(:update)
+
+        entity_store.update(data: data)
+      end
+
+      def add_entities(entities)
+        entities.each { |key, value| @data[key.to_sym] = value }
+        entity_store_save
+      end
+
+      def memories
+        data&.to_json
+      end
+
+      # def add(key, value)
+      #   @data[key] = value
+      #    entity_store_save
+      #   @data
+      # end
+
+      # def get(key)
+      #   @data[key]
+      # end
+
+      # def exists?(key)
+      #   @data.key?(key)
+      # end
+
+      # def remove(key)
+      #   @data.delete(key)
+      # end
+
+      # def clear
+      #   @data = {}
+      # end
+
+      # def all
+      #   @data
+      # end
+    end
+  end
+end

data/lib/ruby-openai-swarm/memories/field.rb

@@ -0,0 +1,39 @@
+module OpenAISwarm
+  module Memories
+    class Field
+      attr_accessor :field,
+                    :tool_call_description
+
+      VALID_MEMORY_FIELDS = [:field, :tool_call_description].freeze
+
+      def initialize(memory_field)
+        memory_field.is_a?(Hash) ? parse_hash(memory_field) : parse_string(memory_field)
+      end
+
+      def parse_hash(memory_field)
+        validate_memory_field!(memory_field)
+
+        @field = memory_field[:field]
+        @tool_call_description = memory_field[:tool_call_description]
+      end
+
+      def parse_string(memory_field)
+        @field = memory_field
+      end
+
+      private
+
+      def validate_memory_field!(memory_field)
+        unless memory_field.include?(:field)
+          raise ArgumentError, "memory_field must include :field"
+        end
+
+        invalid_fields = memory_field.keys - VALID_MEMORY_FIELDS
+
+        unless invalid_fields.empty?
+          raise ArgumentError, "Invalid memory fields: #{invalid_fields.join(', ')}. Valid fields are: #{VALID_MEMORY_FIELDS.join(', ')}"
+        end
+      end
+    end
+  end
+end

data/lib/ruby-openai-swarm/memory.rb

@@ -0,0 +1,49 @@
+module OpenAISwarm
+  class Memory
+    attr_reader :memories,
+                :entity_store
+
+    def initialize(memory_fields: [], entity_store: nil)
+      @memory_fields = normalize_memory_fields(memory_fields)
+      @entity_store = Memories::EntityStore.new(entity_store)
+    end
+
+    def normalize_memory_fields(memory_fields)
+      return [] if memory_fields.empty?
+
+      memory_fields.map { |memory_field| Memories::Field.new(memory_field) }
+    end
+
+    def core_memory_save(entities)
+      entity_store.add_entities(entities)
+    end
+
+    def prompt_content
+      return nil if get_memories_data.nil?
+
+      fields = @memory_fields.map(&:field).join(", ")
+      "You have a section of your context called [MEMORY] " \
+      "that contains the following information: #{fields}. " \
+      "Here are the relevant details: [MEMORY]\n" \
+      "#{get_memories_data}"
+    end
+
+    def function
+      return nil if @memory_fields.empty?
+
+      OpenAISwarm::FunctionDescriptor.new(
+        target_method: method(:core_memory_save),
+        description: core_memory_save_metadata[:function][:description],
+        parameters: core_memory_save_metadata[:function][:parameters]
+      )
+    end
+
+    def core_memory_save_metadata
+      @core_memory_save_metadata ||= Memories::CoreMemoryFunction.definition(@memory_fields)
+    end
+
+    def get_memories_data
+      entity_store&.memories
+    end
+  end
+end

data/lib/ruby-openai-swarm/version.rb

@@ -1,3 +1,3 @@
 module OpenAISwarm
-  VERSION = "0.4.0.2"
+  VERSION = "0.5.1"
 end

data/lib/ruby-openai-swarm.rb

@@ -11,6 +11,11 @@ require 'ruby-openai-swarm/function_descriptor'
 require 'ruby-openai-swarm/repl'
 require 'ruby-openai-swarm/configuration'
 require 'ruby-openai-swarm/logger'
+require 'ruby-openai-swarm/memory'
+require 'ruby-openai-swarm/memories/entity_store'
+require 'ruby-openai-swarm/memories/core_memory_function'
+require 'ruby-openai-swarm/memories/field'
+
 
 module OpenAISwarm
   class Error < StandardError;

data/ruby-openai-swarm.gemspec

@@ -3,12 +3,12 @@ require_relative 'lib/ruby-openai-swarm/version'
 Gem::Specification.new do |spec|
   spec.name          = "ruby-openai-swarm"
   spec.version       = OpenAISwarm::VERSION
-  spec.authors       = ["Grayson"]
+  spec.authors       = ["Grayson Chen"]
   spec.email         = ["cgg5207@gmail.com"]
 
   spec.summary       = " A Ruby implementation of OpenAI function calling swarm"
   spec.description   = "Allows for creating swarms of AI agents that can call functions and interact with each other"
-  spec.homepage      = "https://github.com/grayson/ruby-openai-swarm"
+  spec.homepage      = "https://github.com/graysonchen/ruby-openai-swarm"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai-swarm
 version: !ruby/object:Gem::Version
-  version: 0.4.0.2
+  version: 0.5.1
 platform: ruby
 authors:
-- Grayson
+- Grayson Chen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -111,6 +111,7 @@ files:
 - examples/basic/function_calling.rb
 - examples/basic/simple_loop_no_helpers.rb
 - examples/bootstrap.rb
+- examples/memory/memory_save.rb
 - examples/triage_agent/README.md
 - examples/triage_agent/agents.rb
 - examples/triage_agent/main.rb
@@ -126,19 +127,23 @@ files:
 - lib/ruby-openai-swarm/core_ext.rb
 - lib/ruby-openai-swarm/function_descriptor.rb
 - lib/ruby-openai-swarm/logger.rb
+- lib/ruby-openai-swarm/memories/core_memory_function.rb
+- lib/ruby-openai-swarm/memories/entity_store.rb
+- lib/ruby-openai-swarm/memories/field.rb
+- lib/ruby-openai-swarm/memory.rb
 - lib/ruby-openai-swarm/repl.rb
 - lib/ruby-openai-swarm/response.rb
 - lib/ruby-openai-swarm/result.rb
 - lib/ruby-openai-swarm/util.rb
 - lib/ruby-openai-swarm/version.rb
 - ruby-openai-swarm.gemspec
-homepage: https://github.com/grayson/ruby-openai-swarm
+homepage: https://github.com/graysonchen/ruby-openai-swarm
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/grayson/ruby-openai-swarm
-  source_code_uri: https://github.com/grayson/ruby-openai-swarm
-  changelog_uri: https://github.com/grayson/ruby-openai-swarm/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/graysonchen/ruby-openai-swarm
+  source_code_uri: https://github.com/graysonchen/ruby-openai-swarm
+  changelog_uri: https://github.com/graysonchen/ruby-openai-swarm/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: