Moderation
Identify potentially harmful content in text using AI moderation models before sending to LLMs
Table of contents
- Basic Content Moderation
- Understanding Moderation Results
- Alternative Calling Methods
- Choosing Models
- Integration Patterns
- Error Handling
- Configuration Requirements
- Best Practices
- Rails Integration
After reading this guide, you will know:
- How to moderate text content for harmful material.
- How to interpret moderation results and category scores.
- How to use moderation as a safety layer before LLM requests.
- How to configure moderation models and providers.
- How to integrate moderation into your application workflows.
- Best practices for content safety and user experience.
Basic Content Moderation
The simplest way to moderate content is using the global RubyLLM.moderate method:
result = RubyLLM.moderate("This is a safe message about Ruby programming")
puts result.flagged? # => false
puts "Moderation ID: #{result.id}" # => "modr-ABC123..."
puts "Model used: #{result.model}" # => "omni-moderation-latest"
The moderate method returns a RubyLLM::Moderation object. Its results method holds one RubyLLM::Moderation::Result per moderated input, each with flagged?, categories (the flagged category names), and category_scores:
verdict = result.results.first
verdict.flagged? # => false
verdict.categories # => []
verdict.category_scores # => {"harassment" => 1.19e-05, "violence" => 0.0004, ...}
Understanding Moderation Results
Moderation results include categories and confidence scores for different types of potentially harmful content:
result = RubyLLM.moderate("Some user input text")
if result.flagged?
puts "Content was flagged for: #{result.flagged_categories.join(', ')}"
else
puts "Content appears safe"
end
# Examine category scores (0.0 to 1.0, higher = more likely)
scores = result.category_scores
puts "Sexual content score: #{scores['sexual']}"
puts "Harassment score: #{scores['harassment']}"
puts "Violence score: #{scores['violence']}"
puts "Contains hate speech: #{result.flagged_categories.include?('hate')}"
puts "Contains self-harm content: #{result.flagged_categories.include?('self-harm')}"
flagged?, flagged_categories, and category_scores aggregate across all results: flagged? is true if any input was flagged, flagged_categories is the union of flagged category names, and category_scores keeps the highest score per category.
Moderation Categories
Current moderation models typically check for these categories:
- Sexual: Sexually explicit or suggestive content
- Hate: Content that promotes hate based on identity
- Harassment: Content intended to harass, threaten, or bully
- Self-harm: Content promoting self-harm or suicide
- Sexual/minors: Sexual content involving minors
- Hate/threatening: Hateful content that includes threats
- Violence: Content promoting or glorifying violence
- Violence/graphic: Graphic violent content
- Self-harm/intent: Content expressing intent to self-harm
- Self-harm/instructions: Instructions for self-harm
- Harassment/threatening: Harassing content that includes threats
Alternative Calling Methods
You can also use the class method directly:
result = RubyLLM::Moderation.moderate("Your content here")
result = RubyLLM.moderate(
"User message",
model: "omni-moderation-latest",
provider: "openai"
)
# Using assume_model_exists for custom models
result = RubyLLM.moderate(
"Content to check",
provider: "openai",
assume_model_exists: true
)
# Moderating an image with models that support image moderation
result = RubyLLM.moderate(
"Check this image and caption",
with: "https://example.com/image.png",
model: "omni-moderation-latest",
provider: "openai"
)
result = RubyLLM.moderate(
with: ["screenshot.png", "another-image.png"],
model: "omni-moderation-latest",
provider: "openai"
)
Image moderation accepts image attachments. Other file types raise RubyLLM::UnsupportedAttachmentError.
Choosing Models
By default, RubyLLM uses OpenAI’s omni-moderation-latest, but moderation is not OpenAI-only. Any provider that ships a moderation model works the same way - for example, Mistral’s mistral-moderation-latest:
result = RubyLLM.moderate(
"Content to moderate",
model: "omni-moderation-latest"
)
result = RubyLLM.moderate(
"Content to moderate",
model: "mistral-moderation-latest"
)
RubyLLM.configure do |config|
config.default_moderation_model = "omni-moderation-latest"
end
Refer to the Available Models Reference for details on moderation models and their capabilities.
Integration Patterns
Pre-Chat Moderation
Use moderation as a safety layer before sending user input to LLMs:
def safe_chat_response(user_input)
moderation = RubyLLM.moderate(user_input)
if moderation.flagged?
flagged_categories = moderation.flagged_categories.join(', ')
return {
error: "Content flagged for: #{flagged_categories}",
safe: false
}
end
response = RubyLLM.chat.ask(user_input)
{
content: response.content,
safe: true
}
end
Custom Threshold Handling
You might want to implement custom logic based on category scores:
def assess_content_risk(text)
result = RubyLLM.moderate(text)
scores = result.category_scores
high_risk = scores.any? { |_, score| score > 0.8 }
medium_risk = scores.any? { |_, score| score > 0.5 }
case
when high_risk
{ risk: :high, action: :block, message: "Content blocked" }
when medium_risk
{ risk: :medium, action: :review, message: "Content flagged for review" }
else
{ risk: :low, action: :allow, message: "Content approved" }
end
end
assessment = assess_content_risk("Some user input")
puts "Risk level: #{assessment[:risk]}"
puts "Action: #{assessment[:action]}"
Error Handling
Handle moderation errors gracefully:
begin
result = RubyLLM.moderate("User content")
if result.flagged?
handle_unsafe_content(result)
else
process_safe_content(content)
end
rescue RubyLLM::ConfigurationError => e
# Handle missing API key or configuration
logger.error "Moderation not configured: #{e.message}"
# Fallback: proceed with caution or block all content
rescue RubyLLM::RateLimitError => e
# Handle rate limits
logger.warn "Moderation rate limited: #{e.message}"
# Fallback: temporary approval or queue for later
rescue RubyLLM::Error => e
# Handle other API errors
logger.error "Moderation failed: #{e.message}"
# Fallback: proceed with caution
end
Configuration Requirements
Moderation requires an API key for a provider that offers a moderation model. RubyLLM defaults to OpenAI’s omni-moderation-latest, so configuring an OpenAI key is enough to get started:
RubyLLM.configure do |config|
config.openai_api_key = ENV['OPENAI_API_KEY']
# Optional: set default moderation model
config.default_moderation_model = "omni-moderation-latest"
end
To moderate through Mistral instead, configure its key and set the default model to mistral-moderation-latest:
RubyLLM.configure do |config|
config.mistral_api_key = ENV['MISTRAL_API_KEY']
config.default_moderation_model = "mistral-moderation-latest"
end
For more details about OpenAI’s moderation capabilities and policies, see the OpenAI Moderation Guide.
Moderation API calls are typically less expensive than chat completions and have generous rate limits, making them suitable for screening all user inputs.
Best Practices
Content Safety Strategy
- Always moderate user-generated content before sending to LLMs
- Handle false positives gracefully with human review processes
- Log moderation decisions for auditing and improvement
- Provide clear feedback to users about content policies
Performance Considerations
- Cache moderation results for repeated content (with appropriate TTL)
- Use background jobs for non-blocking moderation of large volumes
- Implement fallbacks for when moderation services are unavailable
User Experience
def user_friendly_moderation(content)
result = RubyLLM.moderate(content)
return { approved: true } unless result.flagged?
categories = result.flagged_categories
message = case
when categories.include?('harassment')
"Please keep interactions respectful and constructive."
when categories.include?('sexual')
"This content appears inappropriate for our platform."
when categories.include?('violence')
"Please avoid content that promotes violence or harm."
else
"This content doesn't meet our community guidelines."
end
{
approved: false,
message: message,
categories: categories
}
end
Rails Integration
When using moderation in Rails applications:
# In a controller or service
class MessageController < ApplicationController
def create
content = params[:message]
moderation_result = RubyLLM.moderate(content)
if moderation_result.flagged?
render json: {
error: "Message not allowed",
categories: moderation_result.flagged_categories
}, status: :unprocessable_entity
else
message = Message.create!(content: content, user: current_user)
render json: message, status: :created
end
end
end
# Background job for batch moderation
class ModerationJob < ApplicationJob
def perform(message_ids)
messages = Message.where(id: message_ids)
messages.each do |message|
result = RubyLLM.moderate(message.content)
message.update!(
moderation_flagged: result.flagged?,
moderation_categories: result.flagged_categories,
moderation_scores: result.category_scores
)
end
end
end
This allows you to build robust content safety systems that protect both your application and your users while maintaining a good user experience.