FEATURE: AI Usage page

This is a work in progress PR to provide admins with an AI usage page

Author: SamSaffron

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

@@ -0,0 +1,11 @@
+import { service } from "@ember/service";
+import { ajax } from "discourse/lib/ajax";
+import DiscourseRoute from "discourse/routes/discourse";
+
+export default class DiscourseAiUsageRoute extends DiscourseRoute {
+  @service store;
+
+  model() {
+    ajax("/admin/plugins/discourse-ai/ai-usage.json");
+  }
+}

admin/assets/javascripts/discourse/templates/admin-plugins/show/discourse-ai-usage.hbs

@@ -0,0 +1 @@
+<AiUsage @model={{this.model}}/>

app/controllers/discourse_ai/admin/ai_usage_controller.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module DiscourseAi
+  module Admin
+    class AiUsageController < ::Admin::AdminController
+      requires_plugin "discourse-ai"
+
+      def show
+        render json: AiUsageSerializer.new(create_report, root: false)
+      end
+
+      private
+
+      def create_report
+        report =
+          DiscourseAi::Completions::Report.new(
+            start_date: params[:start_date]&.to_date || 30.days.ago,
+            end_date: params[:end_date]&.to_date || Time.current,
+          )
+
+        report = report.filter_by_feature(params[:feature]) if params[:feature].present?
+        report = report.filter_by_model(params[:model]) if params[:model].present?
+        report
+      end
+
+      def time_series_data(report)
+        case params[:period]
+        when "hour"
+          report.tokens_per_hour
+        when "month"
+          report.tokens_per_month
+        else
+          report.tokens_per_day
+        end
+      end
+    end
+  end
+end

app/serializers/ai_usage_serializer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class AiUsageSerializer < ApplicationSerializer
+  attributes :data, :features, :models, :summary
+
+  def data
+    object.tokens_by_period.to_json
+  end
+
+  def features
+    object.feature_breakdown.as_json(only: %i[feature_name usage_count total_tokens])
+  end
+
+  def models
+    object.model_breakdown.as_json(only: %i[llm usage_count total_tokens])
+  end
+
+  def summary
+    {
+      total_tokens: object.total_tokens,
+      date_range: {
+        start: object.start_date,
+        end: object.end_date,
+      },
+    }
+  end
+end

assets/javascripts/discourse/admin-discourse-ai-plugin-route-map.js

@@ -18,5 +18,6 @@ export default {
       this.route("new");
       this.route("show", { path: "/:id" });
     });
+    this.route("discourse-ai-usage", { path: "ai-usage" });
   },
 };

assets/javascripts/discourse/components/ai-usage.gjs

@@ -0,0 +1,8 @@
+import Component from "@glimmer/component";
+
+export default class AiUsage extends Component {
+  hello() {}
+  <template>
+    testing
+  </template>
+}

assets/javascripts/initializers/admin-plugin-configuration-nav.js

@@ -24,6 +24,10 @@ export default {
           label: "discourse_ai.tools.short_title",
           route: "adminPlugins.show.discourse-ai-tools",
         },
+        {
+          label: "discourse_ai.usage.short_title",
+          route: "adminPlugins.show.discourse-ai-usage",
+        },
       ]);
     });
   },

config/locales/client.en.yml

@@ -126,6 +126,9 @@ en:
       modals:
         select_option: "Select an option..."
 
+      usage:
+        short_title: "Usage"
+
       ai_persona:
         tool_strategies:
           all: "Apply to all replies"

config/routes.rb

@@ -77,6 +77,8 @@
     get "/rag-document-fragments/files/status",
         to: "discourse_ai/admin/rag_document_fragments#indexing_status_check"
 
+    get "/ai-usage", to: "discourse_ai/admin/ai_usage#show"
+
     resources :ai_llms,
               only: %i[index create show update destroy],
               path: "ai-llms",

lib/completions/report.rb

@@ -0,0 +1,75 @@
+module DiscourseAi
+  module Completions
+    class Report
+      attr_reader :start_date, :end_date, :base_query
+
+      def initialize(start_date: 30.days.ago, end_date: Time.current)
+        @start_date = start_date.beginning_of_day
+        @end_date = end_date.end_of_day
+        @base_query = AiApiAuditLog.where(created_at: @start_date..@end_date)
+      end
+
+      def total_tokens
+        base_query.sum("request_tokens + response_tokens")
+      end
+
+      def guess_period(period)
+        period = nil if %i[day month hour].include?(period)
+        period ||
+          case @end_date - @start_date
+          when 0..7.days
+            :hour
+          when 7.days..90.days
+            :day
+          else
+            :month
+          end
+      end
+
+      def tokens_by_period(period = nil)
+        period = guess_period(period)
+        base_query.group("DATE_TRUNC('#{period}', created_at)").sum(
+          "request_tokens + response_tokens",
+        )
+      end
+
+      def feature_breakdown
+        base_query.group(:feature_name).select(
+          "feature_name",
+          "COUNT(*) as usage_count",
+          "SUM(request_tokens + response_tokens) as total_tokens",
+        )
+      end
+
+      def model_breakdown
+        base_query.group(:language_model).select(
+          "language_model as llm",
+          "COUNT(*) as usage_count",
+          "SUM(request_tokens + response_tokens) as total_tokens",
+        )
+      end
+
+      def tokens_per_hour
+        tokens_by_period(:hour)
+      end
+
+      def tokens_per_day
+        tokens_by_period(:day)
+      end
+
+      def tokens_per_month
+        tokens_by_period(:month)
+      end
+
+      def filter_by_feature(feature_name)
+        @base_query = base_query.where(feature_name: feature_name)
+        self
+      end
+
+      def filter_by_model(model_name)
+        @base_query = base_query.where(language_model: model_name)
+        self
+      end
+    end
+  end
+end