ruby_llm 1.7.0 → 1.8.0

data/lib/ruby_llm/models.rb

@@ -194,15 +194,15 @@ module RubyLLM
     end
 
     def embedding_models
-      self.class.new(all.select { |m| m.type == 'embedding' })
+      self.class.new(all.select { |m| m.type == 'embedding' || m.modalities.output.include?('embeddings') })
     end
 
     def audio_models
-      self.class.new(all.select { |m| m.type == 'audio' })
+      self.class.new(all.select { |m| m.type == 'audio' || m.modalities.output.include?('audio') })
     end
 
     def image_models
-      self.class.new(all.select { |m| m.type == 'image' })
+      self.class.new(all.select { |m| m.type == 'image' || m.modalities.output.include?('image') })
     end
 
     def by_family(family)
@@ -217,6 +217,10 @@ module RubyLLM
       self.class.refresh!(remote_only: remote_only)
     end
 
+    def resolve(model_id, provider: nil, assume_exists: false, config: nil)
+      self.class.resolve(model_id, provider: provider, assume_exists: assume_exists, config: config)
+    end
+
     private
 
     def find_with_provider(model_id, provider)

data/lib/ruby_llm/moderation.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  # Identify potentially harmful content in text.
+  # https://platform.openai.com/docs/guides/moderation
+  class Moderation
+    attr_reader :id, :model, :results
+
+    def initialize(id:, model:, results:)
+      @id = id
+      @model = model
+      @results = results
+    end
+
+    def self.moderate(input,
+                      model: nil,
+                      provider: nil,
+                      assume_model_exists: false,
+                      context: 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
+
+      provider_instance.moderate(input, model: model_id)
+    end
+
+    # Convenience method to get content from moderation result
+    def content
+      results
+    end
+
+    # Check if any content was flagged
+    def flagged?
+      results.any? { |result| result['flagged'] }
+    end
+
+    # Get all flagged categories across all results
+    def flagged_categories
+      results.flat_map do |result|
+        result['categories']&.select { |_category, flagged| flagged }&.keys || []
+      end.uniq
+    end
+
+    # Get category scores for the first result (most common case)
+    def category_scores
+      results.first&.dig('category_scores') || {}
+    end
+
+    # Get categories for the first result (most common case)
+    def categories
+      results.first&.dig('categories') || {}
+    end
+  end
+end

data/lib/ruby_llm/provider.rb

@@ -70,6 +70,12 @@ module RubyLLM
       parse_embedding_response(response, model:, text:)
     end
 
+    def moderate(input, model:)
+      payload = render_moderation_payload(input, model:)
+      response = @connection.post moderation_url, payload
+      parse_moderation_response(response, model:)
+    end
+
     def paint(prompt, model:, size:)
       payload = render_image_payload(prompt, model:, size:)
       response = @connection.post images_url, payload

data/lib/ruby_llm/providers/gemini/capabilities.rb

@@ -52,6 +52,10 @@ module RubyLLM
           model_id.match?(/gemini|flash|pro|imagen/)
         end
 
+        def supports_video?(model_id)
+          model_id.match?(/gemini/)
+        end
+
         def supports_functions?(model_id)
           return false if model_id.match?(/text-embedding|embedding-001|aqa|flash-lite|imagen|gemini-2\.0-flash-lite/)
 
@@ -217,6 +221,7 @@ module RubyLLM
             modalities[:input] << 'pdf'
           end
 
+          modalities[:input] << 'video' if supports_video?(model_id)
           modalities[:input] << 'audio' if model_id.match?(/audio/)
           modalities[:output] << 'embeddings' if model_id.match?(/embedding|gemini-embedding/)
           modalities[:output] = ['image'] if model_id.match?(/imagen/)

data/lib/ruby_llm/providers/openai/moderation.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  module Providers
+    class OpenAI
+      # Moderation methods of the OpenAI API integration
+      module Moderation
+        module_function
+
+        def moderation_url
+          'moderations'
+        end
+
+        def render_moderation_payload(input, model:)
+          {
+            model: model,
+            input: input
+          }
+        end
+
+        def parse_moderation_response(response, model:)
+          data = response.body
+          raise Error.new(response, data.dig('error', 'message')) if data.dig('error', 'message')
+
+          RubyLLM::Moderation.new(
+            id: data['id'],
+            model: model,
+            results: data['results'] || []
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ruby_llm/providers/openai.rb

@@ -7,6 +7,7 @@ module RubyLLM
       include OpenAI::Chat
       include OpenAI::Embeddings
       include OpenAI::Models
+      include OpenAI::Moderation
       include OpenAI::Streaming
       include OpenAI::Tools
       include OpenAI::Images

data/lib/ruby_llm/railtie.rb

@@ -5,7 +5,7 @@ module RubyLLM
   class Railtie < Rails::Railtie
     initializer 'ruby_llm.inflections' do
       ActiveSupport::Inflector.inflections(:en) do |inflect|
-        inflect.acronym 'LLM'
+        inflect.acronym 'RubyLLM'
       end
     end
 

data/lib/ruby_llm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyLLM
-  VERSION = '1.7.0'
+  VERSION = '1.8.0'
 end

data/lib/ruby_llm.rb

@@ -48,6 +48,10 @@ module RubyLLM
       Embedding.embed(...)
     end
 
+    def moderate(...)
+      Moderation.moderate(...)
+    end
+
     def paint(...)
       Image.paint(...)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Carmine Paolino
@@ -152,6 +152,9 @@ files:
 - lib/generators/ruby_llm/chat_ui/templates/views/models/_model.html.erb.tt
 - lib/generators/ruby_llm/chat_ui/templates/views/models/index.html.erb.tt
 - lib/generators/ruby_llm/chat_ui/templates/views/models/show.html.erb.tt
+- lib/generators/ruby_llm/generator_helpers.rb
+- lib/generators/ruby_llm/install/install_generator.rb
+- lib/generators/ruby_llm/install/templates/add_references_to_chats_tool_calls_and_messages_migration.rb.tt
 - lib/generators/ruby_llm/install/templates/chat_model.rb.tt
 - lib/generators/ruby_llm/install/templates/create_chats_migration.rb.tt
 - lib/generators/ruby_llm/install/templates/create_messages_migration.rb.tt
@@ -161,9 +164,8 @@ files:
 - lib/generators/ruby_llm/install/templates/message_model.rb.tt
 - lib/generators/ruby_llm/install/templates/model_model.rb.tt
 - lib/generators/ruby_llm/install/templates/tool_call_model.rb.tt
-- lib/generators/ruby_llm/install_generator.rb
 - lib/generators/ruby_llm/upgrade_to_v1_7/templates/migration.rb.tt
-- lib/generators/ruby_llm/upgrade_to_v1_7_generator.rb
+- lib/generators/ruby_llm/upgrade_to_v1_7/upgrade_to_v1_7_generator.rb
 - lib/ruby_llm.rb
 - lib/ruby_llm/active_record/acts_as.rb
 - lib/ruby_llm/active_record/acts_as_legacy.rb
@@ -193,6 +195,7 @@ files:
 - lib/ruby_llm/models.json
 - lib/ruby_llm/models.rb
 - lib/ruby_llm/models_schema.json
+- lib/ruby_llm/moderation.rb
 - lib/ruby_llm/provider.rb
 - lib/ruby_llm/providers/anthropic.rb
 - lib/ruby_llm/providers/anthropic/capabilities.rb
@@ -246,6 +249,7 @@ files:
 - lib/ruby_llm/providers/openai/images.rb
 - lib/ruby_llm/providers/openai/media.rb
 - lib/ruby_llm/providers/openai/models.rb
+- lib/ruby_llm/providers/openai/moderation.rb
 - lib/ruby_llm/providers/openai/streaming.rb
 - lib/ruby_llm/providers/openai/tools.rb
 - lib/ruby_llm/providers/openrouter.rb

data/lib/generators/ruby_llm/install_generator.rb

@@ -1,217 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators'
-require 'rails/generators/active_record'
-
-module RubyLLM
-  # Generator for RubyLLM Rails models and migrations
-  class InstallGenerator < Rails::Generators::Base
-    include Rails::Generators::Migration
-
-    namespace 'ruby_llm:install'
-
-    source_root File.expand_path('install/templates', __dir__)
-
-    argument :model_mappings, type: :array, default: [], banner: 'chat:ChatName message:MessageName ...'
-
-    class_option :skip_active_storage, type: :boolean, default: false,
-                                       desc: 'Skip ActiveStorage installation and attachment setup'
-
-    desc 'Creates models and migrations for RubyLLM Rails integration\n' \
-         'Usage: rails g ruby_llm:install [chat:ChatName] [message:MessageName] ...'
-
-    def self.next_migration_number(dirname)
-      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
-    end
-
-    def migration_version
-      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-    end
-
-    def postgresql?
-      ::ActiveRecord::Base.connection.adapter_name.downcase.include?('postgresql')
-    rescue StandardError
-      false
-    end
-
-    def parse_model_mappings
-      @model_names = {
-        chat: 'Chat',
-        message: 'Message',
-        tool_call: 'ToolCall',
-        model: 'Model'
-      }
-
-      model_mappings.each do |mapping|
-        if mapping.include?(':')
-          key, value = mapping.split(':', 2)
-          @model_names[key.to_sym] = value.classify
-        end
-      end
-
-      @model_names
-    end
-
-    %i[chat message tool_call model].each do |type|
-      define_method("#{type}_model_name") do
-        @model_names ||= parse_model_mappings
-        @model_names[type]
-      end
-    end
-
-    def acts_as_chat_declaration
-      acts_as_chat_params = []
-      messages_assoc = message_model_name.tableize.to_sym
-      model_assoc = model_model_name.underscore.to_sym
-
-      if messages_assoc != :messages
-        acts_as_chat_params << "messages: :#{messages_assoc}"
-        if message_model_name != messages_assoc.to_s.classify
-          acts_as_chat_params << "message_class: '#{message_model_name}'"
-        end
-      end
-
-      if model_assoc != :model
-        acts_as_chat_params << "model: :#{model_assoc}"
-        acts_as_chat_params << "model_class: '#{model_model_name}'" if model_model_name != model_assoc.to_s.classify
-      end
-
-      if acts_as_chat_params.any?
-        "acts_as_chat #{acts_as_chat_params.join(', ')}"
-      else
-        'acts_as_chat'
-      end
-    end
-
-    def acts_as_message_declaration
-      params = []
-
-      add_message_association_params(params, :chat, chat_model_name)
-      add_message_association_params(params, :tool_calls, tool_call_model_name, tableize: true)
-      add_message_association_params(params, :model, model_model_name)
-
-      params.any? ? "acts_as_message #{params.join(', ')}" : 'acts_as_message'
-    end
-
-    private
-
-    def add_message_association_params(params, default_assoc, model_name, tableize: false)
-      assoc = tableize ? model_name.tableize.to_sym : model_name.underscore.to_sym
-
-      return if assoc == default_assoc
-
-      params << "#{default_assoc}: :#{assoc}"
-      expected_class = assoc.to_s.classify
-      params << "#{default_assoc.to_s.singularize}_class: '#{model_name}'" if model_name != expected_class
-    end
-
-    public
-
-    def acts_as_tool_call_declaration
-      acts_as_tool_call_params = []
-      message_assoc = message_model_name.underscore.to_sym
-
-      if message_assoc != :message
-        acts_as_tool_call_params << "message: :#{message_assoc}"
-        if message_model_name != message_assoc.to_s.classify
-          acts_as_tool_call_params << "message_class: '#{message_model_name}'"
-        end
-      end
-
-      if acts_as_tool_call_params.any?
-        "acts_as_tool_call #{acts_as_tool_call_params.join(', ')}"
-      else
-        'acts_as_tool_call'
-      end
-    end
-
-    def acts_as_model_declaration
-      acts_as_model_params = []
-      chats_assoc = chat_model_name.tableize.to_sym
-
-      if chats_assoc != :chats
-        acts_as_model_params << "chats: :#{chats_assoc}"
-        acts_as_model_params << "chat_class: '#{chat_model_name}'" if chat_model_name != chats_assoc.to_s.classify
-      end
-
-      if acts_as_model_params.any?
-        "acts_as_model #{acts_as_model_params.join(', ')}"
-      else
-        'acts_as_model'
-      end
-    end
-
-    def create_migration_files
-      # Create migrations with timestamps to ensure proper order
-      # First create chats table
-      migration_template 'create_chats_migration.rb.tt',
-                         "db/migrate/create_#{chat_model_name.tableize}.rb"
-
-      # Then create messages table (must come before tool_calls due to foreign key)
-      sleep 1 # Ensure different timestamp
-      migration_template 'create_messages_migration.rb.tt',
-                         "db/migrate/create_#{message_model_name.tableize}.rb"
-
-      # Then create tool_calls table (references messages)
-      sleep 1 # Ensure different timestamp
-      migration_template 'create_tool_calls_migration.rb.tt',
-                         "db/migrate/create_#{tool_call_model_name.tableize}.rb"
-
-      # Create models table
-      sleep 1 # Ensure different timestamp
-      migration_template 'create_models_migration.rb.tt',
-                         "db/migrate/create_#{model_model_name.tableize}.rb"
-    end
-
-    def create_model_files
-      template 'chat_model.rb.tt', "app/models/#{chat_model_name.underscore}.rb"
-      template 'message_model.rb.tt', "app/models/#{message_model_name.underscore}.rb"
-      template 'tool_call_model.rb.tt', "app/models/#{tool_call_model_name.underscore}.rb"
-
-      template 'model_model.rb.tt', "app/models/#{model_model_name.underscore}.rb"
-    end
-
-    def create_initializer
-      template 'initializer.rb.tt', 'config/initializers/ruby_llm.rb'
-    end
-
-    def install_active_storage
-      return if options[:skip_active_storage]
-
-      say '  Installing ActiveStorage for file attachments...', :cyan
-      rails_command 'active_storage:install'
-    end
-
-    def show_install_info
-      say "\n  ✅ RubyLLM installed!", :green
-
-      say '  ✅ ActiveStorage configured for file attachments support', :green unless options[:skip_active_storage]
-
-      say "\n  Next steps:", :yellow
-      say '     1. Run: rails db:migrate'
-      say '     2. Set your API keys in config/initializers/ruby_llm.rb'
-
-      say "     3. Start chatting: #{chat_model_name}.create!(model: 'gpt-4.1-nano').ask('Hello!')"
-
-      say "\n  🚀 Model registry is database-backed!", :cyan
-      say '     Models automatically load from the database'
-      say '     Pass model names as strings - RubyLLM handles the rest!'
-      say "     Specify provider when needed: Chat.create!(model: 'gemini-2.5-flash', provider: 'vertexai')"
-
-      if options[:skip_active_storage]
-        say "\n  📎 Note: ActiveStorage was skipped", :yellow
-        say '     File attachments won\'t work without ActiveStorage.'
-        say '     To enable later:'
-        say '       1. Run: rails active_storage:install && rails db:migrate'
-        say "       2. Add to your #{message_model_name} model: has_many_attached :attachments"
-      end
-
-      say "\n  📚 Documentation: https://rubyllm.com", :cyan
-
-      say "\n  ❤️  Love RubyLLM?", :magenta
-      say '     • ⭐ Star on GitHub: https://github.com/crmne/ruby_llm'
-      say '     • 🐦 Follow for updates: https://x.com/paolino'
-      say "\n"
-    end
-  end
-end

data/lib/generators/ruby_llm/upgrade_to_v1_7_generator.rb

@@ -1,160 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators'
-require 'rails/generators/active_record'
-
-module RubyLLM
-  class UpgradeToV17Generator < Rails::Generators::Base # rubocop:disable Style/Documentation
-    include Rails::Generators::Migration
-
-    namespace 'ruby_llm:upgrade_to_v1_7'
-    source_root File.expand_path('upgrade_to_v1_7/templates', __dir__)
-
-    # Override source_paths to include install templates
-    def self.source_paths
-      [
-        File.expand_path('upgrade_to_v1_7/templates', __dir__),
-        File.expand_path('install/templates', __dir__)
-      ]
-    end
-
-    argument :model_mappings, type: :array, default: [], banner: 'chat:ChatName message:MessageName ...'
-
-    desc 'Upgrades existing RubyLLM apps to v1.7 with new Rails-like API\n' \
-         'Usage: rails g ruby_llm:upgrade_to_v1_7 [chat:ChatName] [message:MessageName] ...'
-
-    def self.next_migration_number(dirname)
-      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
-    end
-
-    def parse_model_mappings
-      @model_names = {
-        chat: 'Chat',
-        message: 'Message',
-        tool_call: 'ToolCall',
-        model: 'Model'
-      }
-
-      model_mappings.each do |mapping|
-        if mapping.include?(':')
-          key, value = mapping.split(':', 2)
-          @model_names[key.to_sym] = value.classify
-        end
-      end
-
-      @model_names
-    end
-
-    %i[chat message tool_call model].each do |type|
-      define_method("#{type}_model_name") do
-        @model_names ||= parse_model_mappings
-        @model_names[type]
-      end
-    end
-
-    def create_migration_file
-      # First check if models table exists, if not create it
-      unless table_exists?(model_model_name.tableize)
-        migration_template 'create_models_migration.rb.tt',
-                           "db/migrate/create_#{model_model_name.tableize}.rb",
-                           migration_version: migration_version,
-                           model_model_name: model_model_name
-
-        sleep 1 # Ensure different timestamp
-      end
-
-      migration_template 'migration.rb.tt',
-                         'db/migrate/migrate_to_ruby_llm_model_references.rb',
-                         migration_version: migration_version,
-                         chat_model_name: chat_model_name,
-                         message_model_name: message_model_name,
-                         tool_call_model_name: tool_call_model_name,
-                         model_model_name: model_model_name
-    end
-
-    def create_model_file
-      # Check if Model file already exists
-      model_path = "app/models/#{model_model_name.underscore}.rb"
-
-      if File.exist?(Rails.root.join(model_path))
-        say_status :skip, model_path, :yellow
-      else
-        create_file model_path do
-          <<~RUBY
-            class #{model_model_name} < ApplicationRecord
-              #{acts_as_model_declaration}
-            end
-          RUBY
-        end
-      end
-    end
-
-    def acts_as_model_declaration
-      acts_as_model_params = []
-      chats_assoc = chat_model_name.tableize.to_sym
-
-      if chats_assoc != :chats
-        acts_as_model_params << "chats: :#{chats_assoc}"
-        acts_as_model_params << "chat_class: '#{chat_model_name}'" if chat_model_name != chats_assoc.to_s.classify
-      end
-
-      if acts_as_model_params.any?
-        "acts_as_model #{acts_as_model_params.join(', ')}"
-      else
-        'acts_as_model'
-      end
-    end
-
-    def update_initializer
-      initializer_content = File.read('config/initializers/ruby_llm.rb')
-
-      unless initializer_content.include?('config.use_new_acts_as')
-        inject_into_file 'config/initializers/ruby_llm.rb', before: /^end/ do
-          lines = ["\n  # Enable the new Rails-like API", '  config.use_new_acts_as = true']
-          lines << "  config.model_registry_class = \"#{model_model_name}\"" if model_model_name != 'Model'
-          lines << "\n"
-          lines.join("\n")
-        end
-      end
-    rescue Errno::ENOENT
-      say_status :error, 'config/initializers/ruby_llm.rb not found', :red
-    end
-
-    def show_next_steps
-      say_status :success, 'Migration created!', :green
-      say <<~INSTRUCTIONS
-
-        Next steps:
-        1. Review the migration: db/migrate/*_migrate_to_ruby_llm_model_references.rb
-        2. Run: rails db:migrate
-        3. Update config/initializers/ruby_llm.rb as shown above
-        4. Test your application thoroughly
-
-        The migration will:
-        - Create the Models table if it doesn't exist
-        - Load all models from models.json
-        - Migrate your existing data to use foreign keys
-        - Preserve all existing data (string columns renamed to model_id_string)
-
-      INSTRUCTIONS
-    end
-
-    private
-
-    def migration_version
-      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-    end
-
-    def table_exists?(table_name)
-      ::ActiveRecord::Base.connection.table_exists?(table_name)
-    rescue StandardError
-      false
-    end
-
-    def postgresql?
-      ::ActiveRecord::Base.connection.adapter_name.downcase.include?('postgresql')
-    rescue StandardError
-      false
-    end
-  end
-end