ruby_llm-agents 1.0.0 → 1.2.0

data/lib/generators/ruby_llm_agents/templates/application_image_pipeline.rb.tt

@@ -1,139 +1,137 @@
 # frozen_string_literal: true
 
-module <%= @root_namespace %>
-  module Image
-    # ApplicationImagePipeline - Base class for all image pipelines in this application
-    #
-    # All image pipelines inherit from this class. Configure shared settings here
-    # that apply to all pipelines, or override them per-pipeline as needed.
-    #
-    # ============================================================================
-    # IMAGE PIPELINE DSL REFERENCE
-    # ============================================================================
-    #
-    # STEP DEFINITION:
-    # ----------------
-    #   step :name, generator: MyGenerator      # Text-to-image generation
-    #   step :name, upscaler: MyUpscaler        # Resolution enhancement
-    #   step :name, transformer: MyTransformer  # Style transfer / img2img
-    #   step :name, editor: MyEditor            # Inpainting / editing
-    #   step :name, variator: MyVariator        # Generate variations
-    #   step :name, analyzer: MyAnalyzer        # Image analysis (non-image output)
-    #   step :name, remover: MyRemover          # Background removal
-    #
-    # CONDITIONAL STEPS:
-    # ------------------
-    #   step :upscale, upscaler: MyUpscaler, if: ->(ctx) { ctx[:high_quality] }
-    #   step :remove_bg, remover: MyRemover, unless: ->(ctx) { ctx[:keep_background] }
-    #
-    # STEP OPTIONS:
-    # -------------
-    #   step :upscale, upscaler: PhotoUpscaler, scale: 4
-    #   step :transform, transformer: StyleTransformer, strength: 0.8
-    #
-    # CALLBACKS:
-    # ----------
-    #   before_pipeline :validate_inputs
-    #   after_pipeline :add_watermark
-    #   after_pipeline { |result| notify_completion(result) }
-    #
-    # ERROR HANDLING:
-    # ---------------
-    #   stop_on_error true         # Stop pipeline on first error (default)
-    #   stop_on_error false        # Continue even if a step fails
-    #
-    # CACHING:
-    # --------
-    #   cache_for 1.hour           # Cache pipeline results
-    #
-    # METADATA:
-    # ---------
-    #   version "1.0"              # Version identifier (affects cache key)
-    #   description "My pipeline"  # Human-readable description
-    #
-    # ============================================================================
-    # USAGE EXAMPLES
-    # ============================================================================
-    #
-    #   # Simple pipeline
-    #   class ProductPipeline < ApplicationImagePipeline
-    #     step :generate, generator: ProductGenerator
-    #     step :upscale, upscaler: PhotoUpscaler, scale: 2
-    #   end
-    #
-    #   result = ProductPipeline.call(prompt: "Laptop on desk")
-    #   result.final_image    # => URL or data of processed image
-    #   result.total_cost     # => Combined cost of all steps
-    #
-    #   # Pipeline with analysis
-    #   class AnalysisPipeline < ApplicationImagePipeline
-    #     step :generate, generator: ProductGenerator
-    #     step :analyze, analyzer: ContentAnalyzer
-    #   end
-    #
-    #   result = AnalysisPipeline.call(prompt: "Product photo")
-    #   result.analysis       # => ImageAnalysisResult
-    #
-    #   # Conditional pipeline
-    #   class SmartPipeline < ApplicationImagePipeline
-    #     step :generate, generator: ProductGenerator
-    #     step :upscale, upscaler: PhotoUpscaler, if: ->(ctx) { ctx[:hd] }
-    #     step :remove_background, remover: BackgroundRemover, if: ->(ctx) { ctx[:transparent] }
-    #   end
-    #
-    #   result = SmartPipeline.call(prompt: "...", hd: true, transparent: false)
-    #
-    # ============================================================================
-    # RESULT ACCESS
-    # ============================================================================
-    #
-    #   result.success?              # All steps succeeded
-    #   result.partial?              # Some steps succeeded, some failed
-    #   result.error?                # Pipeline failed
-    #
-    #   result.step(:generate)       # Access specific step result
-    #   result.steps                 # Array of all step results
-    #   result.step_count            # Total number of steps
-    #
-    #   result.final_image           # Final processed image (URL or data)
-    #   result.url                   # Final image URL
-    #   result.to_blob               # Final image binary data
-    #   result.save("output.png")    # Save final image to file
-    #
-    #   result.total_cost            # Combined cost of all steps
-    #   result.duration_ms           # Total pipeline duration
-    #
-    class ApplicationImagePipeline < RubyLLM::Agents::ImagePipeline
-      # ============================================
-      # Shared Pipeline Configuration
-      # ============================================
-      # These settings are inherited by all pipelines
+module Images
+  # ApplicationImagePipeline - Base class for all image pipelines in this application
+  #
+  # All image pipelines inherit from this class. Configure shared settings here
+  # that apply to all pipelines, or override them per-pipeline as needed.
+  #
+  # ============================================================================
+  # IMAGE PIPELINE DSL REFERENCE
+  # ============================================================================
+  #
+  # STEP DEFINITION:
+  # ----------------
+  #   step :name, generator: MyGenerator      # Text-to-image generation
+  #   step :name, upscaler: MyUpscaler        # Resolution enhancement
+  #   step :name, transformer: MyTransformer  # Style transfer / img2img
+  #   step :name, editor: MyEditor            # Inpainting / editing
+  #   step :name, variator: MyVariator        # Generate variations
+  #   step :name, analyzer: MyAnalyzer        # Image analysis (non-image output)
+  #   step :name, remover: MyRemover          # Background removal
+  #
+  # CONDITIONAL STEPS:
+  # ------------------
+  #   step :upscale, upscaler: MyUpscaler, if: ->(ctx) { ctx[:high_quality] }
+  #   step :remove_bg, remover: MyRemover, unless: ->(ctx) { ctx[:keep_background] }
+  #
+  # STEP OPTIONS:
+  # -------------
+  #   step :upscale, upscaler: PhotoUpscaler, scale: 4
+  #   step :transform, transformer: StyleTransformer, strength: 0.8
+  #
+  # CALLBACKS:
+  # ----------
+  #   before_pipeline :validate_inputs
+  #   after_pipeline :add_watermark
+  #   after_pipeline { |result| notify_completion(result) }
+  #
+  # ERROR HANDLING:
+  # ---------------
+  #   stop_on_error true         # Stop pipeline on first error (default)
+  #   stop_on_error false        # Continue even if a step fails
+  #
+  # CACHING:
+  # --------
+  #   cache_for 1.hour           # Cache pipeline results
+  #
+  # METADATA:
+  # ---------
+  #   version "1.0"              # Version identifier (affects cache key)
+  #   description "My pipeline"  # Human-readable description
+  #
+  # ============================================================================
+  # USAGE EXAMPLES
+  # ============================================================================
+  #
+  #   # Simple pipeline
+  #   class ProductPipeline < ApplicationImagePipeline
+  #     step :generate, generator: ProductGenerator
+  #     step :upscale, upscaler: PhotoUpscaler, scale: 2
+  #   end
+  #
+  #   result = ProductPipeline.call(prompt: "Laptop on desk")
+  #   result.final_image    # => URL or data of processed image
+  #   result.total_cost     # => Combined cost of all steps
+  #
+  #   # Pipeline with analysis
+  #   class AnalysisPipeline < ApplicationImagePipeline
+  #     step :generate, generator: ProductGenerator
+  #     step :analyze, analyzer: ContentAnalyzer
+  #   end
+  #
+  #   result = AnalysisPipeline.call(prompt: "Product photo")
+  #   result.analysis       # => ImageAnalysisResult
+  #
+  #   # Conditional pipeline
+  #   class SmartPipeline < ApplicationImagePipeline
+  #     step :generate, generator: ProductGenerator
+  #     step :upscale, upscaler: PhotoUpscaler, if: ->(ctx) { ctx[:hd] }
+  #     step :remove_background, remover: BackgroundRemover, if: ->(ctx) { ctx[:transparent] }
+  #   end
+  #
+  #   result = SmartPipeline.call(prompt: "...", hd: true, transparent: false)
+  #
+  # ============================================================================
+  # RESULT ACCESS
+  # ============================================================================
+  #
+  #   result.success?              # All steps succeeded
+  #   result.partial?              # Some steps succeeded, some failed
+  #   result.error?                # Pipeline failed
+  #
+  #   result.step(:generate)       # Access specific step result
+  #   result.steps                 # Array of all step results
+  #   result.step_count            # Total number of steps
+  #
+  #   result.final_image           # Final processed image (URL or data)
+  #   result.url                   # Final image URL
+  #   result.to_blob               # Final image binary data
+  #   result.save("output.png")    # Save final image to file
+  #
+  #   result.total_cost            # Combined cost of all steps
+  #   result.duration_ms           # Total pipeline duration
+  #
+  class ApplicationImagePipeline < RubyLLM::Agents::ImagePipeline
+    # ============================================
+    # Shared Pipeline Configuration
+    # ============================================
+    # These settings are inherited by all pipelines
 
-      # stop_on_error true  # Stop on first step failure
+    # stop_on_error true  # Stop on first step failure
 
-      # ============================================
-      # Shared Caching
-      # ============================================
+    # ============================================
+    # Shared Caching
+    # ============================================
 
-      # cache_for 30.minutes  # Enable caching for all pipelines
+    # cache_for 30.minutes  # Enable caching for all pipelines
 
-      # ============================================
-      # Shared Callbacks
-      # ============================================
-      # Define methods here that can be used by all pipelines
+    # ============================================
+    # Shared Callbacks
+    # ============================================
+    # Define methods here that can be used by all pipelines
 
-      # before_pipeline :validate_tenant
-      # after_pipeline :log_completion
+    # before_pipeline :validate_tenant
+    # after_pipeline :log_completion
 
-      # private
+    # private
 
-      # def validate_tenant
-      #   raise ArgumentError, "Tenant required" unless context[:tenant]
-      # end
+    # def validate_tenant
+    #   raise ArgumentError, "Tenant required" unless context[:tenant]
+    # end
 
-      # def log_completion(result)
-      #   Rails.logger.info("Pipeline completed: #{result.success?}")
-      # end
-    end
+    # def log_completion(result)
+    #   Rails.logger.info("Pipeline completed: #{result.success?}")
+    # end
   end
 end

data/lib/generators/ruby_llm_agents/templates/application_image_transformer.rb.tt

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 
-# Base class for all image transformers in the application
-#
-# Inherits from RubyLLM::Agents::ImageTransformer and provides a common
-# foundation for custom image transformation classes.
-#
-# @example Creating a custom transformer
-#   class AnimeTransformer < ApplicationImageTransformer
-#     model "sdxl"
-#     strength 0.8
-#     template "anime style, studio ghibli, {prompt}"
-#   end
-#
-class ApplicationImageTransformer < RubyLLM::Agents::ImageTransformer
-  # Default configuration (can be overridden in subclasses)
-  # model "sdxl"
-  # size "1024x1024"
-  # strength 0.75
-  # preserve_composition true
+module Images
+  # Base class for all image transformers in the application
+  #
+  # Inherits from RubyLLM::Agents::ImageTransformer and provides a common
+  # foundation for custom image transformation classes.
+  #
+  # @example Creating a custom transformer
+  #   class AnimeTransformer < ApplicationImageTransformer
+  #     model "sdxl"
+  #     strength 0.8
+  #     template "anime style, studio ghibli, {prompt}"
+  #   end
+  #
+  class ApplicationImageTransformer < RubyLLM::Agents::ImageTransformer
+    # Default configuration (can be overridden in subclasses)
+    # model "sdxl"
+    # size "1024x1024"
+    # strength 0.75
+    # preserve_composition true
+  end
 end

data/lib/generators/ruby_llm_agents/templates/application_image_upscaler.rb.tt

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
-# Base class for all image upscalers in the application
-#
-# Inherits from RubyLLM::Agents::ImageUpscaler and provides a common
-# foundation for custom image upscaling classes.
-#
-# @example Creating a custom upscaler
-#   class PhotoUpscaler < ApplicationImageUpscaler
-#     model "real-esrgan"
-#     scale 4
-#     face_enhance true
-#   end
-#
-class ApplicationImageUpscaler < RubyLLM::Agents::ImageUpscaler
-  # Default configuration (can be overridden in subclasses)
-  # model "real-esrgan"
-  # scale 4
-  # face_enhance false
+module Images
+  # Base class for all image upscalers in the application
+  #
+  # Inherits from RubyLLM::Agents::ImageUpscaler and provides a common
+  # foundation for custom image upscaling classes.
+  #
+  # @example Creating a custom upscaler
+  #   class PhotoUpscaler < ApplicationImageUpscaler
+  #     model "real-esrgan"
+  #     scale 4
+  #     face_enhance true
+  #   end
+  #
+  class ApplicationImageUpscaler < RubyLLM::Agents::ImageUpscaler
+    # Default configuration (can be overridden in subclasses)
+    # model "real-esrgan"
+    # scale 4
+    # face_enhance false
+  end
 end

data/lib/generators/ruby_llm_agents/templates/application_image_variator.rb.tt

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
-# Base class for all image variators in the application
-#
-# Inherits from RubyLLM::Agents::ImageVariator and provides a common
-# foundation for custom image variation classes.
-#
-# @example Creating a custom variator
-#   class LogoVariator < ApplicationImageVariator
-#     model "gpt-image-1"
-#     size "1024x1024"
-#     variation_strength 0.3
-#   end
-#
-class ApplicationImageVariator < RubyLLM::Agents::ImageVariator
-  # Default configuration (can be overridden in subclasses)
-  # model "gpt-image-1"
-  # size "1024x1024"
-  # variation_strength 0.5
+module Images
+  # Base class for all image variators in the application
+  #
+  # Inherits from RubyLLM::Agents::ImageVariator and provides a common
+  # foundation for custom image variation classes.
+  #
+  # @example Creating a custom variator
+  #   class LogoVariator < ApplicationImageVariator
+  #     model "gpt-image-1"
+  #     size "1024x1024"
+  #     variation_strength 0.3
+  #   end
+  #
+  class ApplicationImageVariator < RubyLLM::Agents::ImageVariator
+    # Default configuration (can be overridden in subclasses)
+    # model "gpt-image-1"
+    # size "1024x1024"
+    # variation_strength 0.5
+  end
 end

data/lib/generators/ruby_llm_agents/templates/application_speaker.rb.tt

@@ -1,49 +1,47 @@
 # frozen_string_literal: true
 
-module <%= @root_namespace %>
-  module Audio
-    # ApplicationSpeaker - Base class for all speakers in this application
-    #
-    # All speakers inherit from this class. Configure shared settings here
-    # that apply to all speakers, or override them per-speaker as needed.
-    #
-    # Example:
-    #   class NarratorSpeaker < ApplicationSpeaker
-    #     voice "nova"
-    #     speed 1.1
-    #   end
-    #
-    # Usage:
-    #   <%= @root_namespace %>::Audio::NarratorSpeaker.call(text: "Hello world")
-    #
-    class ApplicationSpeaker < RubyLLM::Agents::Speaker
-      # ============================================
-      # Shared Provider Configuration
-      # ============================================
-      # These settings are inherited by all speakers
+module Audio
+  # ApplicationSpeaker - Base class for all speakers in this application
+  #
+  # All speakers inherit from this class. Configure shared settings here
+  # that apply to all speakers, or override them per-speaker as needed.
+  #
+  # Example:
+  #   class NarratorSpeaker < ApplicationSpeaker
+  #     voice "nova"
+  #     speed 1.1
+  #   end
+  #
+  # Usage:
+  #   Audio::NarratorSpeaker.call(text: "Hello world")
+  #
+  class ApplicationSpeaker < RubyLLM::Agents::Speaker
+    # ============================================
+    # Shared Provider Configuration
+    # ============================================
+    # These settings are inherited by all speakers
 
-      # provider :openai              # TTS provider (:openai, :elevenlabs)
-      # model "tts-1"                 # TTS model
-      # voice "nova"                  # Default voice
-      # speed 1.0                     # Speech speed (0.25-4.0 for OpenAI)
-      # output_format :mp3            # Output format (:mp3, :wav, :ogg, :flac)
+    # provider :openai              # TTS provider (:openai, :elevenlabs)
+    # model "tts-1"                 # TTS model
+    # voice "nova"                  # Default voice
+    # speed 1.0                     # Speech speed (0.25-4.0 for OpenAI)
+    # output_format :mp3            # Output format (:mp3, :wav, :ogg, :flac)
 
-      # ============================================
-      # Shared Caching
-      # ============================================
-      # Same text with same settings produces same audio, so caching is effective
+    # ============================================
+    # Shared Caching
+    # ============================================
+    # Same text with same settings produces same audio, so caching is effective
 
-      # cache_for 7.days  # Cache generated audio for a week
+    # cache_for 7.days  # Cache generated audio for a week
 
-      # ============================================
-      # Shared Pronunciation Lexicon
-      # ============================================
-      # Define custom pronunciations for technical terms
+    # ============================================
+    # Shared Pronunciation Lexicon
+    # ============================================
+    # Define custom pronunciations for technical terms
 
-      # lexicon do
-      #   pronounce 'RubyLLM', 'ruby L L M'
-      #   pronounce 'PostgreSQL', 'post-gres-Q-L'
-      # end
-    end
+    # lexicon do
+    #   pronounce 'RubyLLM', 'ruby L L M'
+    #   pronounce 'PostgreSQL', 'post-gres-Q-L'
+    # end
   end
 end

data/lib/generators/ruby_llm_agents/templates/application_transcriber.rb.tt

@@ -1,53 +1,51 @@
 # frozen_string_literal: true
 
-module <%= @root_namespace %>
-  module Audio
-    # ApplicationTranscriber - Base class for all transcribers in this application
-    #
-    # All transcribers inherit from this class. Configure shared settings here
-    # that apply to all transcribers, or override them per-transcriber as needed.
-    #
-    # Example:
-    #   class MeetingTranscriber < ApplicationTranscriber
-    #     language "en"
-    #
-    #     def prompt
-    #       "Business meeting discussion about quarterly results"
-    #     end
-    #   end
-    #
-    # Usage:
-    #   <%= @root_namespace %>::Audio::MeetingTranscriber.call(audio: "meeting.mp3")
-    #
-    class ApplicationTranscriber < RubyLLM::Agents::Transcriber
-      # ============================================
-      # Shared Model Configuration
-      # ============================================
-      # These settings are inherited by all transcribers
+module Audio
+  # ApplicationTranscriber - Base class for all transcribers in this application
+  #
+  # All transcribers inherit from this class. Configure shared settings here
+  # that apply to all transcribers, or override them per-transcriber as needed.
+  #
+  # Example:
+  #   class MeetingTranscriber < ApplicationTranscriber
+  #     language "en"
+  #
+  #     def prompt
+  #       "Business meeting discussion about quarterly results"
+  #     end
+  #   end
+  #
+  # Usage:
+  #   Audio::MeetingTranscriber.call(audio: "meeting.mp3")
+  #
+  class ApplicationTranscriber < RubyLLM::Agents::Transcriber
+    # ============================================
+    # Shared Model Configuration
+    # ============================================
+    # These settings are inherited by all transcribers
 
-      # model "whisper-1"           # Default transcription model
-      # language "en"               # Default language (nil = auto-detect)
-      # output_format :text         # Output format (:text, :srt, :vtt, :json)
-      # include_timestamps :segment # Timestamp granularity (:none, :segment, :word)
+    # model "whisper-1"           # Default transcription model
+    # language "en"               # Default language (nil = auto-detect)
+    # output_format :text         # Output format (:text, :srt, :vtt, :json)
+    # include_timestamps :segment # Timestamp granularity (:none, :segment, :word)
 
-      # ============================================
-      # Shared Caching
-      # ============================================
-      # Same audio always produces same transcription, so caching is effective
+    # ============================================
+    # Shared Caching
+    # ============================================
+    # Same audio always produces same transcription, so caching is effective
 
-      # cache_for 30.days  # Cache transcriptions for 30 days
+    # cache_for 30.days  # Cache transcriptions for 30 days
 
-      # ============================================
-      # Shared Post-processing
-      # ============================================
-      # Override in subclass for custom text cleanup
+    # ============================================
+    # Shared Post-processing
+    # ============================================
+    # Override in subclass for custom text cleanup
 
-      # def postprocess_text(text)
-      #   text
-      #     .gsub(/\bum\b/i, '')     # Remove filler words
-      #     .gsub(/\buh\b/i, '')
-      #     .squeeze(' ')             # Remove extra spaces
-      # end
-    end
+    # def postprocess_text(text)
+    #   text
+    #     .gsub(/\bum\b/i, '')     # Remove filler words
+    #     .gsub(/\buh\b/i, '')
+    #     .squeeze(' ')             # Remove extra spaces
+    # end
   end
 end

data/lib/generators/ruby_llm_agents/templates/application_workflow.rb.tt

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# ApplicationWorkflow - Base class for all workflows in this application
+#
+# All workflows inherit from this class. Configure shared settings here
+# that apply to all workflows, or override them per-workflow as needed.
+#
+# Workflows compose multiple agents into pipelines, parallel executions,
+# or conditional routing flows.
+#
+# Example:
+#   class ContentPipelineWorkflow < ApplicationWorkflow
+#     description "Process and publish content"
+#
+#     step :moderate, agent: Moderators::ContentModerator
+#     step :generate_image, agent: Images::ProductGenerator
+#     step :embed, agent: Embedders::SemanticEmbedder
+#   end
+#
+# Usage:
+#   ContentPipelineWorkflow.call(content: "...")
+#
+class ApplicationWorkflow < RubyLLM::Agents::Workflow::Orchestrator
+  # ============================================
+  # Shared Workflow Configuration
+  # ============================================
+
+  # Default timeout for entire workflow
+  # total_timeout 120
+
+  # Budget tracking
+  # budget_limit 1.0  # Maximum spend in dollars
+
+  # ============================================
+  # Shared Helper Methods
+  # ============================================
+
+  # Example: Common error handling
+  # def on_step_error(step_name, error)
+  #   Rails.logger.error "Workflow step #{step_name} failed: #{error.message}"
+  #   # Optionally notify monitoring
+  # end
+
+  # Example: Common success callback
+  # def on_complete(result)
+  #   Rails.logger.info "Workflow completed successfully"
+  # end
+end