FEATURE: allow suppression of tool details

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.

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
 
@@ -117,6 +120,7 @@ def class_instance
       name
       description
       allowed_group_ids
+      tool_details
     ]
 
     persona_class = DiscourseAi::AiBot::Personas::Persona.system_personas_by_id[self.id]
@@ -136,11 +140,10 @@ def class_instance
     end
 
     options = {}
-    tools = self.respond_to?(:commands) ? self.commands : self.tools
     tools =
-      tools.filter_map do |element|
+      self.tools.filter_map do |element|
         inner_name, current_options = element.is_a?(Array) ? element : [element, nil]
-        inner_name = inner_name.gsub("Command", "")
+        inner_name = inner_name.gsub("Tool", "")
         inner_name = "List#{inner_name}" if %w[Categories Tags].include?(inner_name)
 
         begin
@@ -231,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
@@ -252,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
@@ -282,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

assets/javascripts/discourse/admin/models/ai-persona.js

@@ -6,7 +6,7 @@ const CREATE_ATTRIBUTES = [
   "id",
   "name",
   "description",
-  "commands",
+  "tools",
   "system_prompt",
   "allowed_group_ids",
   "enabled",
@@ -27,6 +27,7 @@ const CREATE_ATTRIBUTES = [
   "rag_conversation_chunks",
   "question_consolidator_llm",
   "allow_chat",
+  "tool_details",
 ];
 
 const SYSTEM_ATTRIBUTES = [
@@ -48,37 +49,37 @@ const SYSTEM_ATTRIBUTES = [
   "rag_conversation_chunks",
   "question_consolidator_llm",
   "allow_chat",
+  "tool_details",
 ];
 
-class CommandOption {
+class ToolOption {
   @tracked value = null;
 }
 
 export default class AiPersona extends RestModel {
   // this code is here to convert the wire schema to easier to work with object
-  // on the wire we pass in/out commands as an Array.
-  // [[CommandName, {option1: value, option2: value}], CommandName2, CommandName3]
-  // So we rework this into a "commands" property and nested commandOptions
+  // on the wire we pass in/out tools as an Array.
+  // [[ToolName, {option1: value, option2: value}], ToolName2, ToolName3]
+  // So we rework this into a "tools" property and nested toolOptions
   init(properties) {
-    if (properties.commands) {
-      properties.commands = properties.commands.map((command) => {
-        if (typeof command === "string") {
-          return command;
+    if (properties.tools) {
+      properties.tools = properties.tools.map((tool) => {
+        if (typeof tool === "string") {
+          return tool;
         } else {
-          let [commandId, options] = command;
+          let [toolId, options] = tool;
           for (let optionId in options) {
             if (!options.hasOwnProperty(optionId)) {
               continue;
             }
-            this.getCommandOption(commandId, optionId).value =
-              options[optionId];
+            this.getToolOption(toolId, optionId).value = options[optionId];
           }
-          return commandId;
+          return toolId;
         }
       });
     }
     super.init(properties);
-    this.commands = properties.commands;
+    this.tools = properties.tools;
   }
 
   async createUser() {
@@ -93,23 +94,23 @@ export default class AiPersona extends RestModel {
     return this.user;
   }
 
-  getCommandOption(commandId, optionId) {
-    this.commandOptions ||= {};
-    this.commandOptions[commandId] ||= {};
-    return (this.commandOptions[commandId][optionId] ||= new CommandOption());
+  getToolOption(toolId, optionId) {
+    this.toolOptions ||= {};
+    this.toolOptions[toolId] ||= {};
+    return (this.toolOptions[toolId][optionId] ||= new ToolOption());
   }
 
-  populateCommandOptions(attrs) {
-    if (!attrs.commands) {
+  populateToolOptions(attrs) {
+    if (!attrs.tools) {
       return;
     }
-    let commandsWithOptions = [];
-    attrs.commands.forEach((commandId) => {
-      if (typeof commandId !== "string") {
-        commandId = commandId[0];
+    let toolsWithOptions = [];
+    attrs.tools.forEach((toolId) => {
+      if (typeof toolId !== "string") {
+        toolId = toolId[0];
       }
-      if (this.commandOptions && this.commandOptions[commandId]) {
-        let options = this.commandOptions[commandId];
+      if (this.toolOptions && this.toolOptions[toolId]) {
+        let options = this.toolOptions[toolId];
         let optionsWithValues = {};
         for (let optionId in options) {
           if (!options.hasOwnProperty(optionId)) {
@@ -118,33 +119,33 @@ export default class AiPersona extends RestModel {
           let option = options[optionId];
           optionsWithValues[optionId] = option.value;
         }
-        commandsWithOptions.push([commandId, optionsWithValues]);
+        toolsWithOptions.push([toolId, optionsWithValues]);
       } else {
-        commandsWithOptions.push(commandId);
+        toolsWithOptions.push(toolId);
       }
     });
-    attrs.commands = commandsWithOptions;
+    attrs.tools = toolsWithOptions;
   }
 
   updateProperties() {
     let attrs = this.system
       ? this.getProperties(SYSTEM_ATTRIBUTES)
       : this.getProperties(CREATE_ATTRIBUTES);
     attrs.id = this.id;
-    this.populateCommandOptions(attrs);
+    this.populateToolOptions(attrs);
 
     return attrs;
   }
 
   createProperties() {
     let attrs = this.getProperties(CREATE_ATTRIBUTES);
-    this.populateCommandOptions(attrs);
+    this.populateToolOptions(attrs);
     return attrs;
   }
 
   workingCopy() {
     let attrs = this.getProperties(CREATE_ATTRIBUTES);
-    this.populateCommandOptions(attrs);
+    this.populateToolOptions(attrs);
     return AiPersona.create(attrs);
   }
 }