ruby_llm 1.7.1 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceecb8e7cd289f58ac1f76648306f61b54482a9b6f845a2f08b3303ee746a634
-  data.tar.gz: 3c075c03ccd1d7b841b99b58a1a4cda9289370b8dea039070cd78ede2d18a41c
+  metadata.gz: c8662c9b8b38e5941ea7e66882d59e8583989135285bc4b7eaaf5b83c8c2326e
+  data.tar.gz: 33c168dc4d68d4cffb18bb0761adc42da51288a43aee78633d30f669bffaa47f
 SHA512:
-  metadata.gz: 16ac70cc9787c0d845b5ad4c62171cb225752f160506864b07fdb0b2c1b27adc147e9799a1f13e9d7a5169595d247e5b6bc0c1083dc523647aa13e750b1d6f9d
-  data.tar.gz: 80543faec7119044c345f6751059e05e4cf76457ad3b288da38ea7c4e1338570fcbca1c8ad8e9dad84fb7ac5983998fd1ceba481b2e244d3542f59481a4d0e7f
+  metadata.gz: 6f94e7adcf5b6f50aca97718c615d8dfa681a483da841ca8214f3970ca918a2a8e384f07a494dad9db83da269068a502ab8caf14a441a2ecb86909617e06fdf9
+  data.tar.gz: 8342ae03bb413eb4b65b55c73629b1729b319e96e6976172fcaaa8ed19231280b5773eb8acccf4f563d63c801a78a03b20be5552189f86a4a7e435fb426c354f

data/README.md

@@ -9,7 +9,7 @@
 
 Battle tested at [<picture><source media="(prefers-color-scheme: dark)" srcset="https://chatwithwork.com/logotype-dark.svg"><img src="https://chatwithwork.com/logotype.svg" alt="Chat with Work" height="30" align="absmiddle"></picture>](https://chatwithwork.com) — *Claude Code for your documents*
 
-[![Gem Version](https://badge.fury.io/rb/ruby_llm.svg?a=8)](https://badge.fury.io/rb/ruby_llm)
+[![Gem Version](https://badge.fury.io/rb/ruby_llm.svg?a=10)](https://badge.fury.io/rb/ruby_llm)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 [![Gem Downloads](https://img.shields.io/gem/dt/ruby_llm)](https://rubygems.org/gems/ruby_llm)
 [![codecov](https://codecov.io/gh/crmne/ruby_llm/branch/main/graph/badge.svg?a=2)](https://codecov.io/gh/crmne/ruby_llm)
@@ -41,6 +41,7 @@ chat.ask "What's the best way to learn Ruby?"
 ```ruby
 # Analyze any file type
 chat.ask "What's in this image?", with: "ruby_conf.jpg"
+chat.ask "What's happening in this video?", with: "video.mp4"
 chat.ask "Describe this meeting", with: "meeting.wav"
 chat.ask "Summarize this document", with: "contract.pdf"
 chat.ask "Explain this code", with: "app.rb"
@@ -68,6 +69,11 @@ RubyLLM.paint "a sunset over mountains in watercolor style"
 RubyLLM.embed "Ruby is elegant and expressive"
 ```
 
+```ruby
+# Moderate content for safety
+RubyLLM.moderate("Check if this text is safe").flagged? # => false
+```
+
 ```ruby
 # Let AI use your code
 class Weather < RubyLLM::Tool
@@ -100,11 +106,12 @@ response = chat.with_schema(ProductSchema).ask "Analyze this product", with: "pr
 ## Features
 
 * **Chat:** Conversational AI with `RubyLLM.chat`
-* **Vision:** Analyze images and screenshots
+* **Vision:** Analyze images and videos
 * **Audio:** Transcribe and understand speech
 * **Documents:** Extract from PDFs, CSVs, JSON, any file type
 * **Image generation:** Create images with `RubyLLM.paint`
 * **Embeddings:** Vector search with `RubyLLM.embed`
+* **Moderation:** Content safety with `RubyLLM.moderate`
 * **Tools:** Let AI call your Ruby methods
 * **Structured output:** JSON schemas that just work
 * **Streaming:** Real-time responses with blocks
@@ -132,7 +139,11 @@ end
 ## Rails
 
 ```bash
+# Install database models
 rails generate ruby_llm:install
+
+# Add chat UI (optional)
+rails generate ruby_llm:chat_ui
 ```
 
 ```ruby
@@ -140,10 +151,12 @@ class Chat < ApplicationRecord
   acts_as_chat
 end
 
-chat = Chat.create! model_id: "claude-sonnet-4"
+chat = Chat.create! model: "claude-sonnet-4"
 chat.ask "What's in this file?", with: "report.pdf"
 ```
 
+Visit `http://localhost:3000/chats` for a ready-to-use chat interface!
+
 ## Documentation
 
 [rubyllm.com](https://rubyllm.com)

data/lib/generators/ruby_llm/chat_ui/chat_ui_generator.rb

@@ -56,6 +56,7 @@ module RubyLLM
         # Message views
         template 'views/messages/_message.html.erb',
                  "app/views/#{message_table_name}/_#{message_model_name.underscore}.html.erb"
+        template 'views/messages/_content.html.erb', "app/views/#{message_table_name}/_content.html.erb"
         template 'views/messages/_form.html.erb', "app/views/#{message_table_name}/_form.html.erb"
         template 'views/messages/create.turbo_stream.erb',
                  "app/views/#{message_table_name}/create.turbo_stream.erb"
@@ -99,12 +100,23 @@ module RubyLLM
         chat_var = chat_model_name.underscore
         broadcasting_code = "broadcasts_to ->(#{msg_var}) { \"#{chat_var}_\#{#{msg_var}.#{chat_var}_id}\" }"
 
-        inject_into_class "app/models/#{msg_var}.rb", message_model_name do
-          "\n  #{broadcasting_code}\n"
+        broadcast_append_chunk_method = <<-RUBY
+
+  def broadcast_append_chunk(content)
+    broadcast_append_to "#{chat_var}_\#{#{chat_var}_id}",
+      target: "#{msg_var}_\#{id}_content",
+      partial: "#{message_table_name}/content",
+      locals: { content: content }
+  end
+        RUBY
+
+        inject_into_file "app/models/#{msg_var}.rb", before: "end\n" do
+          "  #{broadcasting_code}\n#{broadcast_append_chunk_method}"
         end
       rescue Errno::ENOENT
         say "#{message_model_name} model not found. Add broadcasting code to your model.", :yellow
         say "  #{broadcasting_code}", :yellow
+        say broadcast_append_chunk_method, :yellow
       end
 
       def display_post_install_message

data/lib/generators/ruby_llm/chat_ui/templates/jobs/chat_response_job.rb.tt

@@ -5,7 +5,7 @@ class <%= chat_model_name %>ResponseJob < ApplicationJob
     <%= chat_model_name.underscore %>.ask(content) do |chunk|
       if chunk.content && !chunk.content.blank?
         <%= message_model_name.underscore %> = <%= chat_model_name.underscore %>.<%= message_model_name.tableize %>.last
-        <%= message_model_name.underscore %>.update!(content: <%= message_model_name.underscore %>.content + chunk.content)
+        <%= message_model_name.underscore %>.broadcast_append_chunk(chunk.content)
       end
     end
   end

data/lib/generators/ruby_llm/chat_ui/templates/views/messages/_content.html.erb.tt

@@ -0,0 +1 @@
+<%%= content %>

data/lib/generators/ruby_llm/chat_ui/templates/views/messages/_message.html.erb.tt

@@ -3,7 +3,7 @@
   <div style="font-weight: bold; margin-bottom: 5px;">
     <%%= <%= message_model_name.underscore %>.role&.capitalize %>
   </div>
-  <div style="white-space: pre-wrap;"><%%= <%= message_model_name.underscore %>.content %></div>
+  <div id="<%%= dom_id(<%= message_model_name.underscore %>) %>_content" style="white-space: pre-wrap;"><%%= <%= message_model_name.underscore %>.content %></div>
   <div style="font-size: 0.85em; color: #666; margin-top: 5px;">
     <%%= <%= message_model_name.underscore %>.created_at&.strftime("%I:%M %p") %>
   </div>

data/lib/generators/ruby_llm/install/install_generator.rb

@@ -32,12 +32,12 @@ module RubyLLM
       migration_template 'create_chats_migration.rb.tt',
                          "db/migrate/create_#{chat_table_name}.rb"
 
-      # Then create messages table (must come before tool_calls due to foreign key)
+      # Then create messages table
       sleep 1 # Ensure different timestamp
       migration_template 'create_messages_migration.rb.tt',
                          "db/migrate/create_#{message_table_name}.rb"
 
-      # Then create tool_calls table (references messages)
+      # Then create tool_calls table
       sleep 1 # Ensure different timestamp
       migration_template 'create_tool_calls_migration.rb.tt',
                          "db/migrate/create_#{tool_call_table_name}.rb"
@@ -46,6 +46,12 @@ module RubyLLM
       sleep 1 # Ensure different timestamp
       migration_template 'create_models_migration.rb.tt',
                          "db/migrate/create_#{model_table_name}.rb"
+
+      # Add references to chats, tool_calls and messages.
+      sleep 1 # Ensure different timestamp
+      migration_template 'add_references_to_chats_tool_calls_and_messages_migration.rb.tt',
+                         'db/migrate/add_references_to_' \
+                         "#{chat_table_name}_#{tool_call_table_name}_and_#{message_table_name}.rb"
     end
 
     def create_model_files

data/lib/generators/ruby_llm/install/templates/add_references_to_chats_tool_calls_and_messages_migration.rb.tt

@@ -0,0 +1,9 @@
+class AddReferencesTo<%= "#{chat_model_name.gsub('::', '').pluralize}#{tool_call_model_name.gsub('::', '').pluralize}And#{message_model_name.gsub('::', '').pluralize}" %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_reference :<%= chat_table_name %>, :<%= model_table_name.singularize %>, foreign_key: true
+    add_reference :<%= tool_call_table_name %>, :<%= message_table_name.singularize %>, null: false, foreign_key: true
+    add_reference :<%= message_table_name %>, :<%= chat_table_name.singularize %>, null: false, foreign_key: true
+    add_reference :<%= message_table_name %>, :<%= model_table_name.singularize %>, foreign_key: true
+    add_reference :<%= message_table_name %>, :<%= tool_call_table_name.singularize %>, foreign_key: true
+  end
+end

data/lib/generators/ruby_llm/install/templates/create_chats_migration.rb.tt

@@ -1,7 +1,6 @@
 class Create<%= chat_model_name.gsub('::', '').pluralize %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :<%= chat_table_name %> do |t|
-      t.references :<%= model_table_name.singularize %>, foreign_key: true
       t.timestamps
     end
   end

data/lib/generators/ruby_llm/install/templates/create_messages_migration.rb.tt

@@ -1,13 +1,10 @@
 class Create<%= message_model_name.gsub('::', '').pluralize %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :<%= message_table_name %> do |t|
-      t.references :<%= chat_table_name.singularize %>, null: false, foreign_key: true
       t.string :role, null: false
       t.text :content
-      t.references :<%= model_table_name.singularize %>, foreign_key: true
       t.integer :input_tokens
       t.integer :output_tokens
-      t.references :<%= tool_call_table_name.singularize %>, foreign_key: true
       t.timestamps
     end
 

data/lib/generators/ruby_llm/install/templates/create_tool_calls_migration.rb.tt

@@ -2,7 +2,6 @@
 class Create<%= tool_call_model_name.gsub('::', '').pluralize %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :<%= tool_call_table_name %> do |t|
-      t.references :<%= message_table_name.singularize %>, null: false, foreign_key: true
       t.string :tool_call_id, null: false
       t.string :name, null: false
       t.<%= postgresql? ? 'jsonb' : 'json' %> :arguments, default: {}

data/lib/ruby_llm/attachment.rb

@@ -76,6 +76,7 @@ module RubyLLM
 
     def type
       return :image if image?
+      return :video if video?
       return :audio if audio?
       return :pdf if pdf?
       return :text if text?
@@ -87,6 +88,10 @@ module RubyLLM
       RubyLLM::MimeType.image? mime_type
     end
 
+    def video?
+      RubyLLM::MimeType.video? mime_type
+    end
+
     def audio?
       RubyLLM::MimeType.audio? mime_type
     end

data/lib/ruby_llm/configuration.rb

@@ -26,6 +26,7 @@ module RubyLLM
                   # Default models
                   :default_model,
                   :default_embedding_model,
+                  :default_moderation_model,
                   :default_image_model,
                   # Model registry
                   :model_registry_class,
@@ -54,6 +55,7 @@ module RubyLLM
 
       @default_model = 'gpt-4.1-nano'
       @default_embedding_model = 'text-embedding-3-small'
+      @default_moderation_model = 'omni-moderation-latest'
       @default_image_model = 'gpt-image-1'
 
       @model_registry_class = 'Model'

data/lib/ruby_llm/mime_type.rb

@@ -15,6 +15,10 @@ module RubyLLM
       type.start_with?('image/')
     end
 
+    def video?(type)
+      type.start_with?('video/')
+    end
+
     def audio?(type)
       type.start_with?('audio/')
     end

data/lib/ruby_llm/model/info.rb

@@ -56,6 +56,10 @@ module RubyLLM
         modalities.input.include?('image')
       end
 
+      def supports_video?
+        modalities.input.include?('video')
+      end
+
       def supports_functions?
         function_calling?
       end