ruby_llm-agents 1.3.4 → 2.1.0

data/lib/ruby_llm/agents/core/configuration.rb

@@ -167,15 +167,18 @@ module RubyLLM
       #       enforcement: :soft
       #     }
 
-      # @!attribute [rw] alerts
-      #   Alert configuration for notifications.
-      #   @return [Hash, nil] Alert config with :slack_webhook_url, :webhook_url, :on_events, :custom keys
+      # @!attribute [rw] on_alert
+      #   Alert handler proc called when governance events occur.
+      #   Receives event name and payload hash. Filter events in your proc as needed.
+      #   @return [Proc, nil] Alert handler or nil to disable (default: nil)
       #   @example
-      #     config.alerts = {
-      #       slack_webhook_url: ENV["SLACK_WEBHOOK"],
-      #       webhook_url: ENV["AGENTS_WEBHOOK"],
-      #       on_events: [:budget_soft_cap, :budget_hard_cap, :breaker_open],
-      #       custom: ->(event, payload) { Rails.logger.info("Alert: #{event}") }
+      #     config.on_alert = ->(event, payload) {
+      #       case event
+      #       when :budget_hard_cap
+      #         Slack::Notifier.new(ENV["SLACK_WEBHOOK"]).ping("Budget exceeded")
+      #       when :breaker_open
+      #         PagerDuty.trigger(payload)
+      #       end
       #     }
 
       # @!attribute [rw] persist_prompts
@@ -188,17 +191,6 @@ module RubyLLM
       #   Set to false to reduce storage or for privacy compliance.
       #   @return [Boolean] Enable response persistence (default: true)
 
-      # @!attribute [rw] redaction
-      #   Redaction configuration for PII and sensitive data.
-      #   @return [Hash, nil] Redaction config with :fields, :patterns, :placeholder, :max_value_length keys
-      #   @example
-      #     config.redaction = {
-      #       fields: %w[password api_key email ssn],
-      #       patterns: [/\b\d{3}-\d{2}-\d{4}\b/],
-      #       placeholder: "[REDACTED]",
-      #       max_value_length: 5000
-      #     }
-
       # @!attribute [rw] multi_tenancy_enabled
       #   Whether multi-tenancy features are enabled.
       #   When false, the gem behaves exactly as before (backward compatible).
@@ -274,35 +266,6 @@ module RubyLLM
       #   @example
       #     config.track_embeddings = false
 
-      # @!attribute [rw] default_moderation_model
-      #   The default moderation model identifier for all agents.
-      #   Can be overridden per-agent using the `moderation` DSL method.
-      #   @return [String] Model identifier (default: "omni-moderation-latest")
-      #   @example
-      #     config.default_moderation_model = "text-moderation-007"
-
-      # @!attribute [rw] default_moderation_threshold
-      #   The default threshold for moderation scores.
-      #   Content with scores at or above this threshold will be flagged.
-      #   Set to nil to use the provider's default flagging.
-      #   @return [Float, nil] Threshold (0.0-1.0) or nil for provider default (default: nil)
-      #   @example
-      #     config.default_moderation_threshold = 0.8
-
-      # @!attribute [rw] default_moderation_action
-      #   The default action when content is flagged.
-      #   Can be overridden per-agent using the `moderation` DSL method.
-      #   @return [Symbol] Action (:block, :raise, :warn, :log) (default: :block)
-      #   @example
-      #     config.default_moderation_action = :raise
-
-      # @!attribute [rw] track_moderation
-      #   Whether to track moderation executions in the database.
-      #   When enabled, moderation operations are logged as executions.
-      #   @return [Boolean] Enable moderation tracking (default: true)
-      #   @example
-      #     config.track_moderation = false
-
       # @!attribute [rw] default_transcription_model
       #   The default transcription model identifier for all transcribers.
       #   Can be overridden per-transcriber using the `model` DSL method.
@@ -376,6 +339,57 @@ module RubyLLM
       #   @example
       #     config.tool_result_max_length = 5000
 
+      # @!attribute [rw] redaction
+      #   Configuration for PII and sensitive data redaction.
+      #   When set, sensitive data is redacted before storing in execution records.
+      #   @return [Hash, nil] Redaction config with :fields, :patterns, :placeholder, :max_value_length keys
+      #   @example
+      #     config.redaction = {
+      #       fields: %w[ssn credit_card phone_number email],
+      #       patterns: [/\b\d{3}-\d{2}-\d{4}\b/],
+      #       placeholder: "[REDACTED]",
+      #       max_value_length: 5000
+      #     }
+
+      # API key and provider attributes forwarded to RubyLLM.
+      # These let users configure everything in one place through
+      # RubyLLM::Agents.configure instead of a separate RubyLLM.configure block.
+      FORWARDED_RUBY_LLM_ATTRIBUTES = %i[
+        openai_api_key
+        anthropic_api_key
+        gemini_api_key
+        deepseek_api_key
+        openrouter_api_key
+        bedrock_api_key
+        bedrock_secret_key
+        bedrock_session_token
+        bedrock_region
+        mistral_api_key
+        perplexity_api_key
+        xai_api_key
+        gpustack_api_key
+        openai_api_base
+        openai_organization_id
+        openai_project_id
+        gemini_api_base
+        gpustack_api_base
+        ollama_api_base
+        vertexai_project_id
+        vertexai_location
+        request_timeout
+        max_retries
+      ].freeze
+
+      FORWARDED_RUBY_LLM_ATTRIBUTES.each do |attr|
+        define_method(:"#{attr}=") do |value|
+          RubyLLM.config.public_send(:"#{attr}=", value)
+        end
+
+        define_method(attr) do
+          RubyLLM.config.public_send(attr)
+        end
+      end
+
       # Attributes without validation (simple accessors)
       attr_accessor :default_model,
                     :async_logging,
@@ -389,10 +403,9 @@ module RubyLLM
                     :default_streaming,
                     :default_tools,
                     :default_thinking,
-                    :alerts,
+                    :on_alert,
                     :persist_prompts,
                     :persist_responses,
-                    :redaction,
                     :multi_tenancy_enabled,
                     :persist_messages_summary,
                     :default_retryable_patterns,
@@ -400,10 +413,6 @@ module RubyLLM
                     :default_embedding_dimensions,
                     :default_embedding_batch_size,
                     :track_embeddings,
-                    :default_moderation_model,
-                    :default_moderation_threshold,
-                    :default_moderation_action,
-                    :track_moderation,
                     :default_transcription_model,
                     :track_transcriptions,
                     :default_tts_provider,
@@ -437,7 +446,8 @@ module RubyLLM
                     :default_background_output_format,
                     :root_directory,
                     :root_namespace,
-                    :tool_result_max_length
+                    :tool_result_max_length,
+                    :redaction
 
       # Attributes with validation (readers only, custom setters below)
       attr_reader :default_temperature,
@@ -634,10 +644,9 @@ module RubyLLM
 
         # Governance defaults
         @budgets = nil
-        @alerts = nil
+        @on_alert = nil
         @persist_prompts = true
         @persist_responses = true
-        @redaction = nil
 
         # Multi-tenancy defaults (disabled for backward compatibility)
         @multi_tenancy_enabled = false
@@ -654,12 +663,6 @@ module RubyLLM
         @default_embedding_batch_size = 100
         @track_embeddings = true
 
-        # Moderation defaults
-        @default_moderation_model = "omni-moderation-latest"
-        @default_moderation_threshold = nil
-        @default_moderation_action = :block
-        @track_moderation = true
-
         # Transcription defaults
         @default_transcription_model = "whisper-1"
         @track_transcriptions = true
@@ -715,6 +718,9 @@ module RubyLLM
 
         # Tool tracking defaults
         @tool_result_max_length = 10_000
+
+        # Redaction defaults (disabled by default)
+        @redaction = nil
       end
 
       # Returns the configured cache store, falling back to Rails.cache
@@ -747,55 +753,6 @@ module RubyLLM
         default_retryable_patterns.values.flatten.uniq
       end
 
-      # Returns whether alerts are configured
-      #
-      # @return [Boolean] true if any alert destination is configured
-      def alerts_enabled?
-        return false unless alerts.is_a?(Hash)
-
-        alerts[:slack_webhook_url].present? ||
-          alerts[:webhook_url].present? ||
-          alerts[:custom].present? ||
-          alerts[:email_recipients].present?
-      end
-
-      # Returns the list of events to alert on
-      #
-      # @return [Array<Symbol>] Event names to trigger alerts
-      def alert_events
-        alerts&.dig(:on_events) || []
-      end
-
-      # Returns merged redaction fields (default sensitive keys + configured)
-      #
-      # @return [Array<String>] Field names to redact
-      def redaction_fields
-        default_fields = %w[password token api_key secret credential auth key access_token]
-        configured_fields = redaction&.dig(:fields) || []
-        (default_fields + configured_fields).map(&:downcase).uniq
-      end
-
-      # Returns redaction patterns
-      #
-      # @return [Array<Regexp>] Patterns to match and redact
-      def redaction_patterns
-        redaction&.dig(:patterns) || []
-      end
-
-      # Returns the redaction placeholder string
-      #
-      # @return [String] Placeholder to replace redacted values
-      def redaction_placeholder
-        redaction&.dig(:placeholder) || "[REDACTED]"
-      end
-
-      # Returns the maximum value length before truncation
-      #
-      # @return [Integer, nil] Max length, or nil for no limit
-      def redaction_max_value_length
-        redaction&.dig(:max_value_length)
-      end
-
       # Returns whether multi-tenancy is enabled
       #
       # @return [Boolean] true if multi-tenancy is enabled
@@ -869,8 +826,6 @@ module RubyLLM
         when :images then "images"
         when :audio then "audio"
         when :embedders then "embedders"
-        when :moderators then "moderators"
-        when :workflows then "workflows"
         when :text then "text"
         when :image then "image"
         end
@@ -895,16 +850,41 @@ module RubyLLM
 
         [
           base,
-          "app/workflows",           # Top-level workflows directory
           "#{base}/images",
           "#{base}/audio",
           "#{base}/embedders",
-          "#{base}/moderators",
-          "#{base}/workflows",
           "#{base}/tools"
         ]
       end
 
+      # Returns the redaction fields (parameter names to redact)
+      #
+      # @return [Array<String>] Fields to redact
+      def redaction_fields
+        redaction&.dig(:fields) || []
+      end
+
+      # Returns the redaction regex patterns
+      #
+      # @return [Array<Regexp>] Patterns to match and redact
+      def redaction_patterns
+        redaction&.dig(:patterns) || []
+      end
+
+      # Returns the redaction placeholder string
+      #
+      # @return [String] Placeholder for redacted values (default: "[REDACTED]")
+      def redaction_placeholder
+        redaction&.dig(:placeholder) || "[REDACTED]"
+      end
+
+      # Returns the max value length for redaction
+      #
+      # @return [Integer, nil] Max length before truncation, or nil for no limit
+      def redaction_max_value_length
+        redaction&.dig(:max_value_length)
+      end
+
       private
 
       # Validates that a value is within a range

data/lib/ruby_llm/agents/core/errors.rb

@@ -88,63 +88,5 @@ module RubyLLM
 
     # Raised for configuration issues
     class ConfigurationError < Error; end
-
-    # Raised when content is flagged during moderation
-    #
-    # Contains the full moderation result and the phase where
-    # the content was flagged.
-    #
-    # @example Handling moderation errors
-    #   begin
-    #     result = MyAgent.call(message: user_input)
-    #   rescue RubyLLM::Agents::ModerationError => e
-    #     puts "Content blocked: #{e.flagged_categories.join(', ')}"
-    #     puts "Phase: #{e.phase}"
-    #     puts "Scores: #{e.category_scores}"
-    #   end
-    #
-    # @api public
-    class ModerationError < Error
-      # @return [Object] The raw moderation result from RubyLLM
-      attr_reader :moderation_result
-
-      # @return [Symbol] The phase where content was flagged (:input or :output)
-      attr_reader :phase
-
-      # Creates a new ModerationError
-      #
-      # @param moderation_result [Object] The moderation result from RubyLLM
-      # @param phase [Symbol] The phase where content was flagged
-      def initialize(moderation_result, phase)
-        @moderation_result = moderation_result
-        @phase = phase
-
-        categories = moderation_result.flagged_categories
-        category_list = categories.respond_to?(:join) ? categories.join(", ") : categories.to_s
-
-        super("Content flagged during #{phase} moderation: #{category_list}")
-      end
-
-      # Returns the flagged categories from the moderation result
-      #
-      # @return [Array<String, Symbol>] List of flagged categories
-      def flagged_categories
-        moderation_result.flagged_categories
-      end
-
-      # Returns the category scores from the moderation result
-      #
-      # @return [Hash{String, Symbol => Float}] Category to score mapping
-      def category_scores
-        moderation_result.category_scores
-      end
-
-      # Returns whether the moderation result was flagged
-      #
-      # @return [Boolean] Always true for ModerationError
-      def flagged?
-        true
-      end
-    end
   end
 end