module RubyLLM::ActiveRecord::ChatHelper

View helpers for a chat’s page, available in every view of a Rails app. The views bin/rails generate ruby_llm:chat_ui writes use them.

<%= render tool_call_partial(tool_call), message:, tool_call: %>
Cost so far: <%= cost_label(@chat.cost) %>

To change one, define a method with the same name in a helper of your own, such as app/helpers/messages_helper.rb: it takes the place of RubyLLM’s. An app whose chat UI was generated before RubyLLM shipped these keeps the MessagesHelper the generator wrote, and its methods win the same way.

Public Instance Methods

cost_label (cost)

Source

# File lib/ruby_llm/active_record/chat_helper.rb, line 28
def cost_label(cost)
  number_to_currency(cost.total, unit: '$', precision: 4)
end

Returns cost, a RubyLLM::Cost, in US dollars to four decimal places, such as “$0.0123”. RubyLLM prices every cost in US dollars, so the label is in dollars whatever the app’s locale.

default_model_display_name ()

Source

# File lib/ruby_llm/active_record/chat_helper.rb, line 21
def default_model_display_name
  "Default: #{RubyLLM.models.find(RubyLLM.config.default_model).label}"
end

Returns the label of the configured default model, such as “Default: GPT-6.1 Sol”, for the empty choice of a model picker.

tool_call_partial (tool_call)

Source

# File lib/ruby_llm/active_record/chat_helper.rb, line 39
def tool_call_partial(tool_call)
  ruby_llm_tool_partial('tool_calls', tool_call.name)
end

Returns the partial that renders tool_call, a RubyLLM::ToolCall: the one named after its tool in the tool_calls folder beside the current template, as bin/rails generate ruby_llm:tool writes it, or that folder’s default partial.

tool_call_partial(tool_call) # => "messages/tool_calls/weather"

tool_label (name)

Source

# File lib/ruby_llm/active_record/chat_helper.rb, line 52
def tool_label(name)
  name.to_s.humanize.presence || 'Tool'
end

Returns a tool’s name for a person to read, such as “Weather” for weather, or “Tool” without one.

tool_result_label (message)

Source

# File lib/ruby_llm/active_record/chat_helper.rb, line 58
def tool_result_label(message)
  tool_label(message.try(:parent_tool_call)&.name)
end

Returns the label of the tool whose result message holds. See tool_label.

tool_result_partial (message)

Source

# File lib/ruby_llm/active_record/chat_helper.rb, line 46
def tool_result_partial(message)
  ruby_llm_tool_partial('tool_results', message.try(:parent_tool_call)&.name)
end

Returns the partial that renders message, a tool result, from the tool_results folder beside the current template, as tool_call_partial does for a call.