FEATURE: optional tool detail blocks (#662)

This is a rather huge refactor with 1 new feature (tool details can
be suppressed)

Previously we use the name "Command" to describe "Tools", this unifies
all the internal language and simplifies the code.

We also amended the persona UI to use less DToggles which aligns
with our design guidelines.

Co-authored-by: Martin Brennan <martin@discourse.org>

Author: SamSaffron

app/controllers/discourse_ai/admin/ai_personas_controller.rb

@@ -23,7 +23,7 @@ def index
           DiscourseAi::Configuration::LlmEnumerator.values.map do |hash|
             { id: hash[:value], name: hash[:name] }
           end
-        render json: { ai_personas: ai_personas, meta: { commands: tools, llms: llms } }
+        render json: { ai_personas: ai_personas, meta: { tools: tools, llms: llms } }
       end
 
       def show
@@ -126,28 +126,29 @@ def ai_persona_params
             :rag_conversation_chunks,
             :question_consolidator_llm,
             :allow_chat,
+            :tool_details,
             allowed_group_ids: [],
             rag_uploads: [:id],
           )
 
-        if commands = params.dig(:ai_persona, :commands)
-          permitted[:commands] = permit_commands(commands)
+        if tools = params.dig(:ai_persona, :tools)
+          permitted[:tools] = permit_tools(tools)
         end
 
         permitted
       end
 
-      def permit_commands(commands)
-        return [] if !commands.is_a?(Array)
+      def permit_tools(tools)
+        return [] if !tools.is_a?(Array)
 
-        commands.filter_map do |command, options|
-          break nil if !command.is_a?(String)
+        tools.filter_map do |tool, options|
+          break nil if !tool.is_a?(String)
           options&.permit! if options && options.is_a?(ActionController::Parameters)
 
           if options
-            [command, options]
+            [tool, options]
           else
-            command
+            tool
           end
         end
       end

app/models/ai_persona.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 class AiPersona < ActiveRecord::Base
+  # TODO remove this line 01-11-2024
+  self.ignored_columns = [:commands]
+
   # places a hard limit, so per site we cache a maximum of 500 classes
   MAX_PERSONAS_PER_SITE = 500
 
@@ -102,204 +105,78 @@ def bump_cache
   end
 
   def class_instance
-    allowed_group_ids = self.allowed_group_ids
-    id = self.id
-    system = self.system
-    user_id = self.user_id
-    mentionable = self.mentionable
-    default_llm = self.default_llm
-    max_context_posts = self.max_context_posts
-    vision_enabled = self.vision_enabled
-    vision_max_pixels = self.vision_max_pixels
-    rag_conversation_chunks = self.rag_conversation_chunks
-    question_consolidator_llm = self.question_consolidator_llm
-    allow_chat = self.allow_chat
+    attributes = %i[
+      id
+      user_id
+      system
+      mentionable
+      default_llm
+      max_context_posts
+      vision_enabled
+      vision_max_pixels
+      rag_conversation_chunks
+      question_consolidator_llm
+      allow_chat
+      name
+      description
+      allowed_group_ids
+      tool_details
+    ]
 
     persona_class = DiscourseAi::AiBot::Personas::Persona.system_personas_by_id[self.id]
-    if persona_class
-      persona_class.define_singleton_method :allowed_group_ids do
-        allowed_group_ids
-      end
-
-      persona_class.define_singleton_method :id do
-        id
-      end
-
-      persona_class.define_singleton_method :system do
-        system
-      end
-
-      persona_class.define_singleton_method :user_id do
-        user_id
-      end
-
-      persona_class.define_singleton_method :allow_chat do
-        allow_chat
-      end
-
-      persona_class.define_singleton_method :mentionable do
-        mentionable
-      end
-
-      persona_class.define_singleton_method :default_llm do
-        default_llm
-      end
 
-      persona_class.define_singleton_method :max_context_posts do
-        max_context_posts
-      end
-
-      persona_class.define_singleton_method :vision_enabled do
-        vision_enabled
-      end
-
-      persona_class.define_singleton_method :vision_max_pixels do
-        vision_max_pixels
-      end
-
-      persona_class.define_singleton_method :question_consolidator_llm do
-        question_consolidator_llm
-      end
+    instance_attributes = {}
+    attributes.each do |attr|
+      value = self.read_attribute(attr)
+      instance_attributes[attr] = value
+    end
 
-      persona_class.define_singleton_method :rag_conversation_chunks do
-        rag_conversation_chunks
+    if persona_class
+      instance_attributes.each do |key, value|
+        # description/name are localized
+        persona_class.define_singleton_method(key) { value } if key != :description && key != :name
       end
-
       return persona_class
     end
 
-    name = self.name
-    description = self.description
-    ai_persona_id = self.id
-
     options = {}
-
-    tools = self.respond_to?(:commands) ? self.commands : self.tools
-
     tools =
-      tools.filter_map do |element|
-        inner_name = element
-        current_options = nil
-
-        if element.is_a?(Array)
-          inner_name = element[0]
-          current_options = element[1]
-        end
-
-        # Won't migrate data yet. Let's rewrite to the tool name.
-        inner_name = inner_name.gsub("Command", "")
+      self.tools.filter_map do |element|
+        inner_name, current_options = element.is_a?(Array) ? element : [element, nil]
+        inner_name = inner_name.gsub("Tool", "")
         inner_name = "List#{inner_name}" if %w[Categories Tags].include?(inner_name)
 
         begin
-          klass = ("DiscourseAi::AiBot::Tools::#{inner_name}").constantize
+          klass = "DiscourseAi::AiBot::Tools::#{inner_name}".constantize
           options[klass] = current_options if current_options
           klass
         rescue StandardError
           nil
         end
       end
 
-    Class.new(DiscourseAi::AiBot::Personas::Persona) do
-      define_singleton_method :id do
-        id
-      end
-
-      define_singleton_method :name do
-        name
-      end
-
-      define_singleton_method :user_id do
-        user_id
-      end
-
-      define_singleton_method :description do
-        description
-      end
-
-      define_singleton_method :system do
-        system
-      end
-
-      define_singleton_method :allowed_group_ids do
-        allowed_group_ids
-      end
-
-      define_singleton_method :user_id do
-        user_id
-      end
-
-      define_singleton_method :mentionable do
-        mentionable
-      end
-
-      define_singleton_method :default_llm do
-        default_llm
-      end
-
-      define_singleton_method :max_context_posts do
-        max_context_posts
-      end
-
-      define_singleton_method :vision_enabled do
-        vision_enabled
-      end
-
-      define_singleton_method :vision_max_pixels do
-        vision_max_pixels
-      end
-
-      define_singleton_method :rag_conversation_chunks do
-        rag_conversation_chunks
-      end
-
-      define_singleton_method :question_consolidator_llm do
-        question_consolidator_llm
-      end
+    ai_persona_id = self.id
 
-      define_singleton_method :allow_chat do
-        allow_chat
-      end
+    Class.new(DiscourseAi::AiBot::Personas::Persona) do
+      instance_attributes.each { |key, value| define_singleton_method(key) { value } }
 
-      define_singleton_method :to_s do
-        "#<DiscourseAi::AiBot::Personas::Persona::Custom @name=#{self.name} @allowed_group_ids=#{self.allowed_group_ids.join(",")}>"
+      define_singleton_method(:to_s) do
+        "#<#{self.class.name} @name=#{name} @allowed_group_ids=#{allowed_group_ids.join(",")}>"
       end
 
-      define_singleton_method :inspect do
-        "#<DiscourseAi::AiBot::Personas::Persona::Custom @name=#{self.name} @allowed_group_ids=#{self.allowed_group_ids.join(",")}>"
-      end
+      define_singleton_method(:inspect) { to_s }
 
-      define_method :initialize do |*args, **kwargs|
+      define_method(:initialize) do |*args, **kwargs|
         @ai_persona = AiPersona.find_by(id: ai_persona_id)
         super(*args, **kwargs)
       end
 
-      define_method :persona_id do
-        @ai_persona&.id
-      end
-
-      define_method :tools do
-        tools
-      end
-
-      define_method :options do
-        options
-      end
-
-      define_method :temperature do
-        @ai_persona&.temperature
-      end
-
-      define_method :top_p do
-        @ai_persona&.top_p
-      end
-
-      define_method :system_prompt do
-        @ai_persona&.system_prompt || "You are a helpful bot."
-      end
-
-      define_method :uploads do
-        @ai_persona&.uploads
-      end
+      define_method(:tools) { tools }
+      define_method(:options) { options }
+      define_method(:temperature) { @ai_persona&.temperature }
+      define_method(:top_p) { @ai_persona&.top_p }
+      define_method(:system_prompt) { @ai_persona&.system_prompt || "You are a helpful bot." }
+      define_method(:uploads) { @ai_persona&.uploads }
     end
   end
 
@@ -357,7 +234,7 @@ def chat_preconditions
   end
 
   def system_persona_unchangeable
-    if top_p_changed? || temperature_changed? || system_prompt_changed? || commands_changed? ||
+    if top_p_changed? || temperature_changed? || system_prompt_changed? || tools_changed? ||
          name_changed? || description_changed?
       errors.add(:base, I18n.t("discourse_ai.ai_bot.personas.cannot_edit_system_persona"))
     end
@@ -378,7 +255,7 @@ def ensure_not_system
 #  id                          :bigint           not null, primary key
 #  name                        :string(100)      not null
 #  description                 :string(2000)     not null
-#  commands                    :json             not null
+#  tools                       :json             not null
 #  system_prompt               :string(10000000) not null
 #  allowed_group_ids           :integer          default([]), not null, is an Array
 #  created_by_id               :integer
@@ -408,6 +285,7 @@ def ensure_not_system
 #  role_max_responses_per_hour :integer          default(50), not null
 #  question_consolidator_llm   :text
 #  allow_chat                  :boolean          default(FALSE), not null
+#  tool_details                :boolean          default(TRUE), not null
 #
 # Indexes
 #

app/serializers/localized_ai_persona_serializer.rb

@@ -9,7 +9,7 @@ class LocalizedAiPersonaSerializer < ApplicationSerializer
              :enabled,
              :system,
              :priority,
-             :commands,
+             :tools,
              :system_prompt,
              :allowed_group_ids,
              :temperature,
@@ -24,7 +24,8 @@ class LocalizedAiPersonaSerializer < ApplicationSerializer
              :rag_chunk_overlap_tokens,
              :rag_conversation_chunks,
              :question_consolidator_llm,
-             :allow_chat
+             :allow_chat,
+             :tool_details
 
   has_one :user, serializer: BasicUserSerializer, embed: :object
   has_many :rag_uploads, serializer: UploadSerializer, embed: :object