ruby-openai-swarm 0.4.0.1 → 0.4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455b72e5872a2f9e11dad1509769c5e3037cef23b3a622337fa419f9c8a2ab20
-  data.tar.gz: 8f51f50b6ee3de651073783610d26f1394f2fbdb130aa8926b5184af921cfce0
+  metadata.gz: 75a68f00ed7c7e975dad8438d4642e42e035bbe05d5f3e3ef8f759536a74af97
+  data.tar.gz: 73ec246a79465191f8365064618d7c76832fa3b58148fd60e703f4c3b69b8e11
 SHA512:
-  metadata.gz: fc109240efa4af18db7d9d2d60cf9e22fd55c36a9b9845617aa23a3ea912610001c98e0567cd34abd8dcf5e3f1cb86b85b0d474d356023912add3e2c730ad6cf
-  data.tar.gz: 2d5d5740139edc78c5de1116c41e57397b3fce75f114f0459889c2f49c35846473a38fe35048977a5cecb79cb27d9af7d98c9fce48fa8926666165f6766f1dd3
+  metadata.gz: a7b11e67573db5f5197fc137f239f183b0771f9aec067e5f3ba7c4f734145c82bbd9038bfb3a238b6b9b98f58d96c76f61664ef60b875eea516a4d73884b933e
+  data.tar.gz: 639c4469e468a6819d7ed7bea1ac19a8ca97e3c160c3bbab066aa377087b0854bc13e0dc82044a1fb12f7c85abb2c545d1baec1baa040feca07e1fa4be9bf021

data/.gitignore

@@ -27,7 +27,8 @@ build-iPhoneSimulator/
 .ruby-version
 .ruby-gemset
 /tmp
+Gemfile*.lock
 
 # rspec failure tracking
 .rspec_status
-log/openai_swarm.log
+log/openai_swarm.log

data/README.md

@@ -16,7 +16,7 @@ A Ruby-based educational framework adapted from OpenAI’s [Swarm](https://githu
     - [Bundler](#bundler)
     - [Gem install](#gem-install)
     - [Logger](#logger)
-  - [examples](#examples)
+  - [Quick start](#quick-start)
   - [Documentation](#documentation)
 
 ## quick show
@@ -86,7 +86,7 @@ def spanish_agent
   OpenAISwarm::Agent.new(
     name: "Spanish Agent",
     instructions: "You only speak Spanish.",
-    model: "gpt-4o-mini"
+    model: ENV['SWARM_AGENT_DEFAULT_MODEL']
   )
 end
 
@@ -98,7 +98,7 @@ transfer_to_spanish_agent = OpenAISwarm::FunctionDescriptor.new(
 english_agent = OpenAISwarm::Agent.new(
   name: "English Agent",
   instructions: "You only speak English.",
-  model: "gpt-4o-mini",
+  model: ENV['SWARM_AGENT_DEFAULT_MODEL'],
   functions: [transfer_to_spanish_agent]
 )
 
@@ -127,9 +127,20 @@ OpenAISwarm.configure do |config|
 end
 ```
 
-# Examples
+## Quick Start
 
-Setting ACCESS_TOKEN for AI Providers in examples
+### Choose the default model name
+
+`export SWARM_AGENT_DEFAULT_MODEL=gpt-4o-mini`
+
+or
+
+`export SWARM_AGENT_DEFAULT_MODEL=deepseek-chat`
+
+DeepSeek V3 is 1/10 price of gpt-4o-mini, so try it!
+
+
+### Setting ACCESS_TOKEN for AI Providers in examples
 
 - For OpenRouter:
 
@@ -139,7 +150,11 @@ Setting ACCESS_TOKEN for AI Providers in examples
 
   `OPENAI_ACCESS_TOKEN=cxxxxx` or `export OPENAI_ACCESS_TOKEN=cxxxxx`
 
-Check out `/examples` for inspiration! Learn more about each one in its README.
+- For DeepSeek:
+
+  `DEEPSEEK_ACCESS_TOKEN=cxxxxx` or `export DEEPSEEK_ACCESS_TOKEN=cxxxxx`
+
+### Check out `/examples` for inspiration! Learn more about each one in its README.
 
 - [X] [`basic`](examples/basic): Simple examples of fundamentals like setup, function calling, handoffs, and context variables
   - running: `ruby examples/basic/agent_handoff.rb`

data/examples/airline/configs/agents.rb

@@ -44,7 +44,7 @@ end
 # Define agents
 def triage_agent
   @triage_agent ||= OpenAISwarm::Agent.new(
-    model: "gpt-4o-mini",
+    model: ENV['SWARM_AGENT_DEFAULT_MODEL'],
     name: "Triage Agent",
     instructions: method(:triage_instructions),
     functions: [
@@ -55,7 +55,7 @@ end
 
 def flight_modification
   @flight_modification ||= OpenAISwarm::Agent.new(
-    model: "gpt-4o-mini",
+    model: ENV['SWARM_AGENT_DEFAULT_MODEL'],
     name: "Flight Modification Agent",
     instructions: <<~INSTRUCTIONS,
       You are a Flight Modification Agent for a customer service airlines company.
@@ -70,7 +70,7 @@ end
 
 def flight_cancel
   @flight_cancel ||= OpenAISwarm::Agent.new(
-    model: "gpt-4o-mini",
+    model: ENV['SWARM_AGENT_DEFAULT_MODEL'],
     name: "Flight Cancel Traversal",
     instructions: STARTER_PROMPT + FLIGHT_CANCELLATION_POLICY,
     functions: [
@@ -85,7 +85,7 @@ end
 
 def flight_change
   @flight_change ||= OpenAISwarm::Agent.new(
-    model: "gpt-4o-mini",
+    model: ENV['SWARM_AGENT_DEFAULT_MODEL'],
     name: "Flight Change Traversal",
     instructions: STARTER_PROMPT + FLIGHT_CHANGE_POLICY,
     functions: [
@@ -100,7 +100,7 @@ end
 
 def lost_baggage
   @lost_baggage ||= OpenAISwarm::Agent.new(
-    model: "gpt-4o-mini",
+    model: ENV['SWARM_AGENT_DEFAULT_MODEL'],
     name: "Lost Baggage Traversal",
     instructions: STARTER_PROMPT + LOST_BAGGAGE_POLICY,
     functions: [

data/examples/basic/agent_handoff.rb

@@ -7,7 +7,7 @@ def spanish_agent
   OpenAISwarm::Agent.new(
     name: "Spanish Agent",
     instructions: "You only speak Spanish.",
-    model: "gpt-4o-mini"
+    model: ENV['SWARM_AGENT_DEFAULT_MODEL']
   )
 end
 
@@ -19,7 +19,7 @@ transfer_to_spanish_agent = OpenAISwarm::FunctionDescriptor.new(
 english_agent = OpenAISwarm::Agent.new(
   name: "English Agent",
   instructions: "You only speak English.",
-  model: "gpt-4o-mini",
+  model: ENV['SWARM_AGENT_DEFAULT_MODEL'],
   functions: [transfer_to_spanish_agent]
 )
 

data/examples/basic/bare_minimum.rb

@@ -6,7 +6,7 @@ client = OpenAISwarm.new
 agent = OpenAISwarm::Agent.new(
   name: "Agent",
   instructions: "You are a helpful agent.",
-  model: "gpt-4o-mini"
+  model: ENV['SWARM_AGENT_DEFAULT_MODEL']
 )
 messages = [{"role": "user", "content": "Hi!"}]
 response = client.run(agent: agent, messages: messages)

data/examples/basic/context_variables.rb

@@ -24,7 +24,7 @@ function_instance = OpenAISwarm::FunctionDescriptor.new(
 agent = OpenAISwarm::Agent.new(
   name: "Agent",
   instructions: method(:instructions),
-  model: "gpt-4o-mini",
+  model: ENV['SWARM_AGENT_DEFAULT_MODEL'],
   functions: [function_instance]
 )
 

data/examples/basic/function_calling.rb

@@ -27,7 +27,7 @@ get_weather_instance = OpenAISwarm::FunctionDescriptor.new(
 agent = OpenAISwarm::Agent.new(
   name: "Agent",
   instructions: "You are a helpful agent.",
-  model: "gpt-4o-mini",
+  model: ENV['SWARM_AGENT_DEFAULT_MODEL'],
   functions: [
     get_weather_instance,
     get_news_instance

data/examples/basic/simple_loop_no_helpers.rb

@@ -5,7 +5,7 @@ client = OpenAISwarm.new
 agent = OpenAISwarm::Agent.new(
   name: "Agent",
   instructions: "You are a helpful agent.",
-  model: "gpt-4o-mini",
+  model: ENV['SWARM_AGENT_DEFAULT_MODEL'],
 )
 
 def pretty_print_messages(messages)

data/examples/bootstrap.rb

@@ -6,6 +6,11 @@ def env_debug
 end
 
 # TODO: refactor it
+OpenAI.configure do |config|
+  config.access_token = ENV['DEEPSEEK_ACCESS_TOKEN']
+  config.uri_base = "https://api.deepseek.com"
+end if ENV['DEEPSEEK_ACCESS_TOKEN']
+
 OpenAI.configure do |config|
   config.access_token = ENV['OPEN_ROUTER_ACCESS_TOKEN']
   config.uri_base = "https://openrouter.ai/api/v1"

data/examples/weather_agent/agents.rb

@@ -33,7 +33,7 @@ def weather_agent
   OpenAISwarm::Agent.new(
     name: "Weather Agent",
     instructions: "You are a helpful agent.",
-    model: "gpt-4o-mini",
+    model: ENV['SWARM_AGENT_DEFAULT_MODEL'],
     functions: [
       function_instance_send_email,
       function_instance_get_weather

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

@@ -1,4 +1,5 @@
 require 'ruby/openai'
+require 'ostruct'
 begin
   require 'pry'
 rescue LoadError

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

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

data/ruby-openai-swarm.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
   spec.add_dependency "ruby-openai", "~> 7.3"
+  spec.add_dependency "ostruct"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai-swarm
 version: !ruby/object:Gem::Version
-  version: 0.4.0.1
+  version: 0.4.0.2
 platform: ruby
 authors:
 - Grayson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-26 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.3'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,7 +92,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - assets/logo-swarm.png
@@ -141,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A Ruby implementation of OpenAI function calling swarm

data/Gemfile.lock

@@ -1,56 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ruby-openai-swarm (0.4.0.1)
-      ruby-openai (~> 7.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    base64 (0.2.0)
-    coderay (1.1.3)
-    diff-lcs (1.5.1)
-    event_stream_parser (1.0.0)
-    faraday (2.8.1)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-multipart (1.1.0)
-      multipart-post (~> 2.0)
-    faraday-net_http (3.0.2)
-    method_source (1.1.0)
-    multipart-post (2.4.1)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rake (13.2.1)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    ruby-openai (7.3.1)
-      event_stream_parser (>= 0.3.0, < 2.0.0)
-      faraday (>= 1)
-      faraday-multipart (>= 1)
-    ruby2_keywords (0.0.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  pry
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  ruby-openai-swarm!
-
-BUNDLED WITH
-   2.1.4