Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
/tmp/
.rspec_status*
.test_queue_stats
.idea

# Used by dotenv library to load environment variables.
.env
Expand Down
5 changes: 5 additions & 0 deletions docs/_core_features/moderation.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,11 @@ result = RubyLLM.moderate(
provider: "openai",
assume_model_exists: true
)

# Using an image
result = RubyLLM.moderate(
image: "https://upload.wikimedia.org/wikipedia/en/7/7d/Lenna_%28test_image%29.png"
)
```

## Choosing Models
Expand Down
8 changes: 6 additions & 2 deletions lib/ruby_llm/moderation.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,22 @@ def initialize(id:, model:, results:)
@results = results
end

def self.moderate(input,
def self.moderate(input = nil,
model: nil,
image: nil,
provider: nil,
assume_model_exists: false,
context: nil)
raise ArgumentError, 'must provide input text, image, or both' if input.nil? && image.nil?

config = context&.config || RubyLLM.config
model ||= config.default_moderation_model || 'omni-moderation-latest'
model, provider_instance = Models.resolve(model, provider: provider, assume_exists: assume_model_exists,
config: config)
model_id = model.id
image = Attachment.new(image) if image

provider_instance.moderate(input, model: model_id)
provider_instance.moderate(input, model: model_id, image: image)
end

# Convenience method to get content from moderation result
Expand Down
4 changes: 2 additions & 2 deletions lib/ruby_llm/provider.rb
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ def embed(text, model:, dimensions:)
parse_embedding_response(response, model:, text:)
end

def moderate(input, model:)
payload = render_moderation_payload(input, model:)
def moderate(input, model:, image: nil)
payload = render_moderation_payload(input, model:, image:)
response = @connection.post moderation_url, payload
parse_moderation_response(response, model:)
end
Expand Down
16 changes: 11 additions & 5 deletions lib/ruby_llm/providers/openai/moderation.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,17 @@ def moderation_url
'moderations'
end

def render_moderation_payload(input, model:)
{
model: model,
input: input
}
def render_moderation_payload(input, model:, image: nil)
mod_input = if image
parts = []
parts << { type: 'text', text: input } if input
parts << Media.format_image(image)
parts
else
input
end

{ model: model, input: mod_input }
end

def parse_moderation_response(response, model:)
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading