FEATURE: Add spending metrics to AI usage (#1268)

This update adds metrics for estimated spending in AI usage. To make use of it, admins must add cost details to the LLM config page (input, output, and cached input costs per 1M tokens). After doing so, the metrics will appear in the AI usage dashboard as the AI plugin is used.

Author: keegangeorge

admin/assets/javascripts/discourse/routes/admin-plugins-show-discourse-ai-llms-edit.js

@@ -2,8 +2,17 @@ import DiscourseRoute from "discourse/routes/discourse";
 
 export default class AdminPluginsShowDiscourseAiLlmsEdit extends DiscourseRoute {
   async model(params) {
-    const allLlms = this.modelFor("adminPlugins.show.discourse-ai-llms");
     const id = parseInt(params.id, 10);
+
+    if (id < 0) {
+      // You shouldn't be able to access the edit page
+      // if the model is seeded
+      return this.router.transitionTo(
+        "adminPlugins.show.discourse-ai-llms.index"
+      );
+    }
+
+    const allLlms = this.modelFor("adminPlugins.show.discourse-ai-llms");
     const record = allLlms.findBy("id", id);
     record.provider_params = record.provider_params || {};
     return record;

app/controllers/discourse_ai/admin/ai_llms_controller.rb

@@ -161,6 +161,9 @@ def ai_llm_params(updating: nil)
             :api_key,
             :enabled_chat_bot,
             :vision_enabled,
+            :input_cost,
+            :cached_input_cost,
+            :output_cost,
           )
 
         provider = updating ? updating.provider : permitted[:provider]

app/models/llm_model.rb

@@ -13,7 +13,14 @@ class LlmModel < ActiveRecord::Base
   validates :url, presence: true, unless: -> { provider == BEDROCK_PROVIDER_NAME }
   validates_presence_of :name, :api_key
   validates :max_prompt_tokens, numericality: { greater_than: 0 }
-  validates :max_output_tokens, numericality: { greater_than_or_equal_to: 0 }, allow_nil: true
+  validates :input_cost,
+            :cached_input_cost,
+            :output_cost,
+            :max_output_tokens,
+            numericality: {
+              greater_than_or_equal_to: 0,
+            },
+            allow_nil: true
   validate :required_provider_params
   scope :in_use,
         -> do
@@ -184,5 +191,8 @@ def required_provider_params
 #  enabled_chat_bot  :boolean          default(FALSE), not null
 #  provider_params   :jsonb
 #  vision_enabled    :boolean          default(FALSE), not null
+#  input_cost        :float
+#  cached_input_cost :float
+#  output_cost       :float
 #  max_output_tokens :integer
 #

app/serializers/ai_usage_serializer.rb

@@ -22,6 +22,9 @@ def features
         total_cached_tokens
         total_request_tokens
         total_response_tokens
+        input_spending
+        output_spending
+        cached_input_spending
       ],
     )
   end
@@ -35,6 +38,9 @@ def models
         total_cached_tokens
         total_request_tokens
         total_response_tokens
+        input_spending
+        output_spending
+        cached_input_spending
       ],
     )
   end
@@ -49,6 +55,9 @@ def users
         total_cached_tokens: user.total_cached_tokens,
         total_request_tokens: user.total_request_tokens,
         total_response_tokens: user.total_response_tokens,
+        input_spending: user.input_spending,
+        output_spending: user.output_spending,
+        cached_input_spending: user.cached_input_spending,
       }
     end
   end
@@ -60,6 +69,7 @@ def summary
       total_request_tokens: object.total_request_tokens,
       total_response_tokens: object.total_response_tokens,
       total_requests: object.total_requests,
+      total_spending: object.total_spending,
       date_range: {
         start: object.start_date,
         end: object.end_date,

app/serializers/llm_model_serializer.rb

@@ -18,6 +18,9 @@ class LlmModelSerializer < ApplicationSerializer
              :enabled_chat_bot,
              :provider_params,
              :vision_enabled,
+             :input_cost,
+             :output_cost,
+             :cached_input_cost,
              :used_by
 
   has_one :user, serializer: BasicUserSerializer, embed: :object

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

@@ -15,7 +15,10 @@ export default class AiLlm extends RestModel {
       "api_key",
       "enabled_chat_bot",
       "provider_params",
-      "vision_enabled"
+      "vision_enabled",
+      "input_cost",
+      "cached_input_cost",
+      "output_cost"
     );
   }