ruby_llm 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac485bae964a23af2c0a7ed48fa45fdb3207ad52d1ef6cbdca9b008b4c2429ba
-  data.tar.gz: 7219680107ccf2af1bd7378b0e1b50b2eb328280e8e896cf8f9af7ac270c761a
+  metadata.gz: 3cfdd21451b6e3daac0463dfdb7655892967e5a4da6b00846f353809a9abe18a
+  data.tar.gz: e1505ddd57326601298bb8975c20049a195eb87babd62b08ac0e6340c9e653f6
 SHA512:
-  metadata.gz: cfed1faf8354e9be7b39cfd44bd51596eaca75fb5d810bea7da72691ed7a7494a3ba779504acc20f8e92767be522bb3d6b77fab7db435ab91994b2db21255d2f
-  data.tar.gz: 39b8ed657d27655a1f179fd46915da6acf81a8d0144ef2891bacb4f156311ab1be924d07018b9a095005864f3fb750a63a793d93db6a44de22c4c9bf6fab040f
+  metadata.gz: 7222e575d4f1e5cf620fdc37f4c255c7ededeee945d7b77fac4129c2947d6f78f7d5641b45ed39470180e5bf2dfd48b36e0a6c16579e4e4835564c48b6907920
+  data.tar.gz: ce3fb0f0e8b3665fafe56717cf8fcb10733008821633b024013d0f6e5d0bc90ef47f25b0109aa0e80ee3df4002e2f9b6a20cd98595031aa57235588cb4677052

data/README.md

@@ -9,10 +9,10 @@
 
 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) — *Your AI coworker*
 
-[![Gem Version](https://badge.fury.io/rb/ruby_llm.svg?a=10)](https://badge.fury.io/rb/ruby_llm)
+[![Gem Version](https://badge.fury.io/rb/ruby_llm.svg)](https://badge.fury.io/rb/ruby_llm)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
 [![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)
+[![codecov](https://codecov.io/gh/crmne/ruby_llm/branch/main/graph/badge.svg)](https://codecov.io/gh/crmne/ruby_llm)
 
 <a href="https://trendshift.io/repositories/13640" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13640" alt="crmne%2Fruby_llm | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
 </div>
@@ -24,6 +24,10 @@ Battle tested at [<picture><source media="(prefers-color-scheme: dark)" srcset="
 
 Build chatbots, AI agents, RAG applications. Works with OpenAI, xAI, Anthropic, Google, AWS, local models, and any OpenAI-compatible API.
 
+## From zero to AI chat app in under two minutes
+
+https://github.com/user-attachments/assets/65422091-9338-47da-a303-92b918bd1345
+
 ## Why RubyLLM?
 
 Every AI provider ships their own bloated client. Different APIs. Different response formats. Different conventions. It's exhausting.
@@ -82,9 +86,7 @@ RubyLLM.moderate "Check if this text is safe"
 ```ruby
 # Let AI use your code
 class Weather < RubyLLM::Tool
-  description "Get current weather"
-  param :latitude
-  param :longitude
+  desc "Get current weather"
 
   def execute(latitude:, longitude:)
     url = "https://api.open-meteo.com/v1/forecast?latitude=#{latitude}&longitude=#{longitude}&current=temperature_2m,wind_speed_10m"

data/lib/generators/ruby_llm/generator_helpers.rb

@@ -87,6 +87,7 @@ module RubyLLM
 
         add_association_params(params, :message, message_table_name, message_model_name,
                                owner_table: tool_call_table_name, owner_model_name: tool_call_model_name)
+        add_result_foreign_key_param(params)
 
         "acts_as_tool_call#{" #{params.join(', ')}" if params.any?}"
       end
@@ -178,6 +179,13 @@ module RubyLLM
         "#{owner_model_name.demodulize.underscore}_id"
       end
 
+      def add_result_foreign_key_param(params)
+        foreign_key = "#{tool_call_table_name.singularize}_id"
+        default_foreign_key = "#{tool_call_model_name.demodulize.underscore}_id"
+
+        params << "result_foreign_key: :#{foreign_key}" if foreign_key != default_foreign_key
+      end
+
       # Convert namespaced model names to proper table names
       # e.g., "Assistant::Chat" -> "assistant_chats" (not "assistant/chats")
       def table_name_for(model_name)

data/lib/generators/ruby_llm/tool/templates/tool.rb.tt

@@ -1,5 +1,5 @@
 class <%= class_name %>Tool < RubyLLM::Tool
-  description "TODO: describe what this tool does"
+  desc "TODO: describe what this tool does"
 
   def execute
     # TODO: return something to the LLM.

data/lib/ruby_llm/active_record/acts_as.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'active_support/concern'
+require 'active_support/inflector'
+
 module RubyLLM
   module ActiveRecord
     # Adds chat and message persistence capabilities to ActiveRecord models.

data/lib/ruby_llm/active_record/acts_as_legacy.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'active_support/concern'
+require 'active_support/inflector'
+
 module RubyLLM
   module ActiveRecord
     # Adds chat and message persistence capabilities to ActiveRecord models.
@@ -160,27 +163,33 @@ module RubyLLM
         self
       end
 
-      def on_new_message(&block)
-        to_llm
+      def on_new_message(&)
+        to_llm.on_new_message(&)
+        self
+      end
 
-        existing_callback = @chat.instance_variable_get(:@on)[:new_message]
+      def on_end_message(&)
+        to_llm.on_end_message(&)
+        self
+      end
 
-        @chat.on_new_message do
-          existing_callback&.call
-          block&.call
-        end
+      def before_message(...)
+        to_llm.before_message(...)
         self
       end
 
-      def on_end_message(&block)
-        to_llm
+      def after_message(...)
+        to_llm.after_message(...)
+        self
+      end
 
-        existing_callback = @chat.instance_variable_get(:@on)[:end_message]
+      def before_tool_call(...)
+        to_llm.before_tool_call(...)
+        self
+      end
 
-        @chat.on_end_message do |msg|
-          existing_callback&.call(msg)
-          block&.call(msg)
-        end
+      def after_tool_result(...)
+        to_llm.after_tool_result(...)
         self
       end
 
@@ -319,8 +328,8 @@ module RubyLLM
       def setup_persistence_callbacks
         return @chat if @chat.instance_variable_get(:@_persistence_callbacks_setup)
 
-        @chat.on_new_message { persist_new_message }
-        @chat.on_end_message { |msg| persist_message_completion(msg) }
+        @chat.before_message { persist_new_message }
+        @chat.after_message { |msg| persist_message_completion(msg) }
 
         @chat.instance_variable_set(:@_persistence_callbacks_setup, true)
         @chat
@@ -383,8 +392,8 @@ module RubyLLM
           case attachment
           when ActionDispatch::Http::UploadedFile, ActiveStorage::Blob
             attachment
-          when ActiveStorage::Attached::One, ActiveStorage::Attached::Many
-            attachment.blobs
+          when ActiveStorage::Attachment, ActiveStorage::Attached::One, ActiveStorage::Attached::Many
+            active_storage_blobs(attachment)
           when Hash
             attachment.values.map { |v| prepare_for_active_storage(v) }
           else
@@ -398,16 +407,28 @@ module RubyLLM
 
         attachment = source.is_a?(RubyLLM::Attachment) ? source : RubyLLM::Attachment.new(source)
 
-        {
-          io: StringIO.new(attachment.content),
-          filename: attachment.filename,
-          content_type: attachment.mime_type
-        }
+        if attachment.active_storage?
+          active_storage_blobs(attachment.source)
+        else
+          {
+            io: StringIO.new(attachment.content),
+            filename: attachment.filename,
+            content_type: attachment.mime_type
+          }
+        end
       rescue StandardError => e
         RubyLLM.logger.warn "Failed to process attachment #{source}: #{e.message}"
         nil
       end
 
+      def active_storage_blobs(attachment)
+        case attachment
+        when ActiveStorage::Blob then attachment
+        when ActiveStorage::Attachment, ActiveStorage::Attached::One then attachment.blob
+        when ActiveStorage::Attached::Many then attachment.blobs
+        end
+      end
+
       def build_content(message, attachments)
         return message if content_like?(message)
 
@@ -473,9 +494,15 @@ module RubyLLM
       end
 
       def extract_content
-        return content unless respond_to?(:attachments) && attachments.attached?
+        text_content = if content.respond_to?(:to_plain_text)
+                         content.to_plain_text
+                       else
+                         content
+                       end
+
+        return text_content unless respond_to?(:attachments) && attachments.attached?
 
-        RubyLLM::Content.new(content).tap do |content_obj|
+        RubyLLM::Content.new(text_content).tap do |content_obj|
           @_tempfiles = []
 
           attachments.each do |attachment|

data/lib/ruby_llm/active_record/chat_methods.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/concern'
+
 module RubyLLM
   module ActiveRecord
     # Methods mixed into chat models.
@@ -154,27 +156,33 @@ module RubyLLM
         self
       end
 
-      def on_new_message(&block)
-        to_llm
+      def on_new_message(&)
+        to_llm.on_new_message(&)
+        self
+      end
 
-        existing_callback = @chat.instance_variable_get(:@on)[:new_message]
+      def on_end_message(&)
+        to_llm.on_end_message(&)
+        self
+      end
 
-        @chat.on_new_message do
-          existing_callback&.call
-          block&.call
-        end
+      def before_message(...)
+        to_llm.before_message(...)
         self
       end
 
-      def on_end_message(&block)
-        to_llm
+      def after_message(...)
+        to_llm.after_message(...)
+        self
+      end
 
-        existing_callback = @chat.instance_variable_get(:@on)[:end_message]
+      def before_tool_call(...)
+        to_llm.before_tool_call(...)
+        self
+      end
 
-        @chat.on_end_message do |msg|
-          existing_callback&.call(msg)
-          block&.call(msg)
-        end
+      def after_tool_result(...)
+        to_llm.after_tool_result(...)
         self
       end
 
@@ -208,6 +216,10 @@ module RubyLLM
         message_record
       end
 
+      def cost
+        RubyLLM::Cost.aggregate(messages_association.map(&:cost))
+      end
+
       def create_user_message(content, with: nil)
         add_message(role: :user, content: build_content(content, with))
       end
@@ -258,8 +270,8 @@ module RubyLLM
       def setup_persistence_callbacks
         return @chat if @chat.instance_variable_get(:@_persistence_callbacks_setup)
 
-        @chat.on_new_message { persist_new_message }
-        @chat.on_end_message { |msg| persist_message_completion(msg) }
+        @chat.before_message { persist_new_message }
+        @chat.after_message { |msg| persist_message_completion(msg) }
 
         @chat.instance_variable_set(:@_persistence_callbacks_setup, true)
         @chat
@@ -402,8 +414,8 @@ module RubyLLM
           case attachment
           when ActionDispatch::Http::UploadedFile, ActiveStorage::Blob
             attachment
-          when ActiveStorage::Attached::One, ActiveStorage::Attached::Many
-            attachment.blobs
+          when ActiveStorage::Attachment, ActiveStorage::Attached::One, ActiveStorage::Attached::Many
+            active_storage_blobs(attachment)
           when Hash
             attachment.values.map { |v| prepare_for_active_storage(v) }
           else
@@ -417,16 +429,28 @@ module RubyLLM
 
         attachment = source.is_a?(RubyLLM::Attachment) ? source : RubyLLM::Attachment.new(source)
 
-        {
-          io: StringIO.new(attachment.content),
-          filename: attachment.filename,
-          content_type: attachment.mime_type
-        }
+        if attachment.active_storage?
+          active_storage_blobs(attachment.source)
+        else
+          {
+            io: StringIO.new(attachment.content),
+            filename: attachment.filename,
+            content_type: attachment.mime_type
+          }
+        end
       rescue StandardError => e
         RubyLLM.logger.warn "Failed to process attachment #{source}: #{e.message}"
         nil
       end
 
+      def active_storage_blobs(attachment)
+        case attachment
+        when ActiveStorage::Blob then attachment
+        when ActiveStorage::Attachment, ActiveStorage::Attached::One then attachment.blob
+        when ActiveStorage::Attached::Many then attachment.blobs
+        end
+      end
+
       def build_content(message, attachments)
         return message if content_like?(message)
 

data/lib/ruby_llm/active_record/message_methods.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
+require 'active_support/concern'
+require 'ruby_llm/active_record/payload_helpers'
+
 module RubyLLM
   module ActiveRecord
     # Methods mixed into message models.
     module MessageMethods
       extend ActiveSupport::Concern
+      include PayloadHelpers
 
       class_methods do
         attr_reader :chat_class, :tool_call_class, :chat_foreign_key, :tool_call_foreign_key
@@ -39,6 +43,18 @@ module RubyLLM
         )
       end
 
+      def cost
+        RubyLLM::Cost.new(tokens:, model: model_association)
+      end
+
+      def cache_read_tokens
+        cached_value
+      end
+
+      def cache_write_tokens
+        cache_creation_value
+      end
+
       def to_partial_path
         partial_prefix = self.class.name.underscore.pluralize
         role_partial = if to_llm.tool_call?
@@ -52,10 +68,7 @@ module RubyLLM
       end
 
       def tool_error_message
-        payload = parse_payload(content)
-        return unless payload.is_a?(Hash)
-
-        payload['error'] || payload[:error]
+        payload_error_message(content)
       end
 
       private
@@ -101,7 +114,8 @@ module RubyLLM
       def extract_content
         return RubyLLM::Content::Raw.new(content_raw) if has_attribute?(:content_raw) && content_raw.present?
 
-        content_value = self[:content]
+        content_value = content
+        content_value = content_value.to_plain_text if content_value.respond_to?(:to_plain_text)
 
         return content_value unless respond_to?(:attachments) && attachments.attached?
 
@@ -128,15 +142,6 @@ module RubyLLM
         @_tempfiles << tempfile
         tempfile
       end
-
-      def parse_payload(value)
-        return value if value.is_a?(Hash) || value.is_a?(Array)
-        return if value.blank?
-
-        JSON.parse(value)
-      rescue JSON::ParserError
-        nil
-      end
     end
   end
 end

data/lib/ruby_llm/active_record/model_methods.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'active_support/concern'
+require 'active_support/core_ext/module/delegation'
+
 module RubyLLM
   module ActiveRecord
     # Methods mixed into model registry models.
@@ -10,15 +13,7 @@ module RubyLLM
         def refresh!
           RubyLLM.models.refresh!
 
-          transaction do
-            RubyLLM.models.all.each do |model_info|
-              model = find_or_initialize_by(
-                model_id: model_info.id,
-                provider: model_info.provider
-              )
-              model.update!(from_llm_attributes(model_info))
-            end
-          end
+          save_to_database
         end
 
         def save_to_database
@@ -76,8 +71,11 @@ module RubyLLM
 
       delegate :supports?, :supports_vision?, :supports_functions?, :type,
                :input_price_per_million, :output_price_per_million,
+               :cache_read_input_price_per_million, :cache_write_input_price_per_million,
+               :cached_input_price_per_million, :cache_creation_input_price_per_million,
                :function_calling?, :structured_output?, :batch?,
                :reasoning?, :citations?, :streaming?, :provider_class, :label,
+               :cost_for,
                to: :to_llm
     end
   end

data/lib/ruby_llm/active_record/payload_helpers.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'json'
+
+module RubyLLM
+  module ActiveRecord
+    # Shared helpers for parsing serialized payloads on ActiveRecord-backed models.
+    module PayloadHelpers
+      private
+
+      def payload_error_message(value)
+        payload = parse_payload(value)
+        return unless payload.is_a?(Hash)
+
+        payload['error'] || payload[:error]
+      end
+
+      def parse_payload(value)
+        return value if value.is_a?(Hash) || value.is_a?(Array)
+        return if value.blank?
+
+        JSON.parse(value)
+      rescue JSON::ParserError
+        nil
+      end
+    end
+  end
+end

data/lib/ruby_llm/active_record/tool_call_methods.rb

@@ -1,27 +1,17 @@
 # frozen_string_literal: true
 
+require 'active_support/concern'
+require 'ruby_llm/active_record/payload_helpers'
+
 module RubyLLM
   module ActiveRecord
     # Methods mixed into tool call models.
     module ToolCallMethods
       extend ActiveSupport::Concern
+      include PayloadHelpers
 
       def tool_error_message
-        payload = parse_payload(arguments)
-        return unless payload.is_a?(Hash)
-
-        payload['error'] || payload[:error]
-      end
-
-      private
-
-      def parse_payload(value)
-        return value if value.is_a?(Hash) || value.is_a?(Array)
-        return if value.blank?
-
-        JSON.parse(value)
-      rescue JSON::ParserError
-        nil
+        payload_error_message(arguments)
       end
     end
   end

data/lib/ruby_llm/agent.rb

@@ -359,7 +359,8 @@ module RubyLLM
 
     def_delegators :chat, :model, :messages, :tools, :params, :headers, :schema, :ask, :say, :with_tool, :with_tools,
                    :with_model, :with_temperature, :with_thinking, :with_context, :with_params, :with_headers,
-                   :with_schema, :on_new_message, :on_end_message, :on_tool_call, :on_tool_result, :each, :complete,
-                   :add_message, :reset_messages!
+                   :with_schema, :on_new_message, :on_end_message, :on_tool_call, :on_tool_result, :before_message,
+                   :after_message, :before_tool_call, :after_tool_result, :each, :complete, :add_message,
+                   :reset_messages!, :cost
   end
 end

data/lib/ruby_llm/aliases.json

@@ -9,17 +9,13 @@
   },
   "claude-3-5-sonnet": {
     "anthropic": "claude-3-5-sonnet-20241022",
-    "openrouter": "anthropic/claude-3.5-sonnet",
-    "bedrock": "anthropic.claude-3-5-sonnet-20240620-v1:0:200k"
+    "bedrock": "anthropic.claude-3-5-sonnet-20241022-v2:0"
   },
   "claude-3-7-sonnet": {
     "anthropic": "claude-3-7-sonnet-20250219",
     "openrouter": "anthropic/claude-3.7-sonnet",
     "bedrock": "anthropic.claude-3-7-sonnet-20250219-v1:0"
   },
-  "claude-3-7-sonnet-latest": {
-    "anthropic": "claude-3-7-sonnet-latest"
-  },
   "claude-3-haiku": {
     "anthropic": "claude-3-haiku-20240307",
     "openrouter": "anthropic/claude-3-haiku",
@@ -64,6 +60,12 @@
     "bedrock": "anthropic.claude-opus-4-6-v1",
     "azure": "claude-opus-4-6"
   },
+  "claude-opus-4-7": {
+    "anthropic": "claude-opus-4-7",
+    "openrouter": "anthropic/claude-opus-4.7",
+    "bedrock": "anthropic.claude-opus-4-7",
+    "azure": "claude-opus-4-7"
+  },
   "claude-sonnet-4": {
     "anthropic": "claude-sonnet-4-20250514",
     "openrouter": "anthropic/claude-sonnet-4",
@@ -88,6 +90,14 @@
     "deepseek": "deepseek-chat",
     "openrouter": "deepseek/deepseek-chat"
   },
+  "deepseek-v4-flash": {
+    "deepseek": "deepseek-v4-flash",
+    "openrouter": "deepseek/deepseek-v4-flash"
+  },
+  "deepseek-v4-pro": {
+    "deepseek": "deepseek-v4-pro",
+    "openrouter": "deepseek/deepseek-v4-pro"
+  },
   "gemini-1.5-flash": {
     "gemini": "gemini-1.5-flash",
     "vertexai": "gemini-1.5-flash"
@@ -190,7 +200,8 @@
   },
   "gemini-3.1-flash-lite-preview": {
     "gemini": "gemini-3.1-flash-lite-preview",
-    "openrouter": "google/gemini-3.1-flash-lite-preview"
+    "openrouter": "google/gemini-3.1-flash-lite-preview",
+    "vertexai": "gemini-3.1-flash-lite-preview"
   },
   "gemini-3.1-pro-preview": {
     "gemini": "gemini-3.1-pro-preview",
@@ -206,6 +217,10 @@
     "gemini": "gemini-embedding-001",
     "vertexai": "gemini-embedding-001"
   },
+  "gemini-embedding-2": {
+    "gemini": "gemini-embedding-2",
+    "vertexai": "gemini-embedding-2"
+  },
   "gemini-flash": {
     "gemini": "gemini-flash-latest",
     "vertexai": "gemini-flash-latest"
@@ -230,6 +245,14 @@
     "gemini": "gemma-3n-e4b-it",
     "openrouter": "google/gemma-3n-e4b-it"
   },
+  "gemma-4-26b-a4b-it": {
+    "gemini": "gemma-4-26b-a4b-it",
+    "openrouter": "google/gemma-4-26b-a4b-it"
+  },
+  "gemma-4-31b-it": {
+    "gemini": "gemma-4-31b-it",
+    "openrouter": "google/gemma-4-31b-it"
+  },
   "gpt-3.5-turbo": {
     "openai": "gpt-3.5-turbo",
     "openrouter": "openai/gpt-3.5-turbo"
@@ -247,18 +270,10 @@
     "openrouter": "openai/gpt-4",
     "azure": "gpt-4"
   },
-  "gpt-4-1106-preview": {
-    "openai": "gpt-4-1106-preview",
-    "openrouter": "openai/gpt-4-1106-preview"
-  },
   "gpt-4-turbo": {
     "openai": "gpt-4-turbo",
     "openrouter": "openai/gpt-4-turbo"
   },
-  "gpt-4-turbo-preview": {
-    "openai": "gpt-4-turbo-preview",
-    "openrouter": "openai/gpt-4-turbo-preview"
-  },
   "gpt-4.1": {
     "openai": "gpt-4.1",
     "openrouter": "openai/gpt-4.1",
@@ -373,10 +388,26 @@
     "openai": "gpt-5.4",
     "openrouter": "openai/gpt-5.4"
   },
+  "gpt-5.4-mini": {
+    "openai": "gpt-5.4-mini",
+    "openrouter": "openai/gpt-5.4-mini"
+  },
+  "gpt-5.4-nano": {
+    "openai": "gpt-5.4-nano",
+    "openrouter": "openai/gpt-5.4-nano"
+  },
   "gpt-5.4-pro": {
     "openai": "gpt-5.4-pro",
     "openrouter": "openai/gpt-5.4-pro"
   },
+  "gpt-5.5": {
+    "openai": "gpt-5.5",
+    "openrouter": "openai/gpt-5.5"
+  },
+  "gpt-5.5-pro": {
+    "openai": "gpt-5.5-pro",
+    "openrouter": "openai/gpt-5.5-pro"
+  },
   "gpt-audio": {
     "openai": "gpt-audio",
     "openrouter": "openai/gpt-audio"
@@ -385,6 +416,14 @@
     "openai": "gpt-audio-mini",
     "openrouter": "openai/gpt-audio-mini"
   },
+  "lyria-3-clip-preview": {
+    "gemini": "lyria-3-clip-preview",
+    "openrouter": "google/lyria-3-clip-preview"
+  },
+  "lyria-3-pro-preview": {
+    "gemini": "lyria-3-pro-preview",
+    "openrouter": "google/lyria-3-pro-preview"
+  },
   "o1": {
     "openai": "o1",
     "openrouter": "openai/o1"