support for seeded models

Author: romanrizzi

app/controllers/discourse_ai/admin/ai_embeddings_controller.rb

@@ -49,6 +49,12 @@ def create
       def update
         embedding_def = EmbeddingDefinition.find(params[:id])
 
+        if embedding_def.seeded?
+          return(
+            render_json_error(I18n.t("discourse_ai.embeddings.cannot_edit_builtin"), status: 403)
+          )
+        end
+
         if embedding_def.update(ai_embeddings_params.except(:dimensions))
           render json: AiEmbeddingDefinitionSerializer.new(embedding_def)
         else
@@ -59,6 +65,12 @@ def update
       def destroy
         embedding_def = EmbeddingDefinition.find(params[:id])
 
+        if embedding_def.seeded?
+          return(
+            render_json_error(I18n.t("discourse_ai.embeddings.cannot_edit_builtin"), status: 403)
+          )
+        end
+
         if embedding_def.id == SiteSetting.ai_embeddings_selected_model.to_i
           return render_json_error(I18n.t("discourse_ai.embeddings.delete_failed"), status: 409)
         end

app/models/embedding_definition.rb

@@ -173,6 +173,15 @@ def strategy_version
     strategy.version
   end
 
+  def api_key
+    if seeded?
+      env_key = "DISCOURSE_AI_SEEDED_EMBEDDING_API_KEY"
+      ENV[env_key] || self[:api_key]
+    else
+      self[:api_key]
+    end
+  end
+
   private
 
   def strategy
@@ -215,6 +224,7 @@ def gemini_client
 #  tokenizer_class     :string           not null
 #  url                 :string           not null
 #  api_key             :string
+#  seeded              :boolean          default(FALSE), not null
 #  provider_params     :jsonb
 #  created_at          :datetime         not null
 #  updated_at          :datetime         not null

app/serializers/ai_embedding_definition_serializer.rb

@@ -11,6 +11,19 @@ class AiEmbeddingDefinitionSerializer < ApplicationSerializer
              :provider,
              :url,
              :api_key,
+             :seeded,
              :tokenizer_class,
              :provider_params
+
+  def api_key
+    object.seeded? ? "********" : object.api_key
+  end
+
+  def url
+    object.seeded? ? "********" : object.url
+  end
+
+  def provider
+    object.seeded? ? "CDCK" : object.provider
+  end
 end

assets/javascripts/discourse/components/ai-embeddings-list-editor.gjs

@@ -6,6 +6,7 @@ import DButton from "discourse/components/d-button";
 import DPageSubheader from "discourse/components/d-page-subheader";
 import { i18n } from "discourse-i18n";
 import AdminConfigAreaEmptyList from "admin/components/admin-config-area-empty-list";
+import DTooltip from "float-kit/components/d-tooltip";
 import AiEmbeddingEditor from "./ai-embedding-editor";
 
 export default class AiEmbeddingsListEditor extends Component {
@@ -72,12 +73,28 @@ export default class AiEmbeddingsListEditor extends Component {
                     }}
                   </td>
                   <td class="d-admin-row__controls">
-                    <DButton
-                      class="btn btn-default btn-small ai-embeddings-list__edit-button"
-                      @label="discourse_ai.embeddings.edit"
-                      @route="adminPlugins.show.discourse-ai-embeddings.edit"
-                      @routeModels={{embedding.id}}
-                    />
+                    {{#if embedding.seeded}}
+                      <DTooltip
+                        class="ai-embeddings-list__edit-disabled-tooltip"
+                      >
+                        <:trigger>
+                          <DButton
+                            class="btn btn-default btn-small disabled"
+                            @label="discourse_ai.embeddings.edit"
+                          />
+                        </:trigger>
+                        <:content>
+                          {{i18n "discourse_ai.embeddings.seeded_warning"}}
+                        </:content>
+                      </DTooltip>
+                    {{else}}
+                      <DButton
+                        class="btn btn-default btn-small ai-embeddings-list__edit-button"
+                        @label="discourse_ai.embeddings.edit"
+                        @route="adminPlugins.show.discourse-ai-embeddings.edit"
+                        @routeModels={{embedding.id}}
+                      />
+                    {{/if}}
                   </td>
                 </tr>
               {{/each}}

config/locales/client.en.yml

@@ -514,6 +514,7 @@ en:
         presets: "Select a preset..."
         configure_manually: "Configure manually"
         edit: "Edit"
+        seeded_warning: "This is pre-configured on your site and cannot be edited."
         tests: 
           title: "Run test"
           running: "Running test..."
@@ -539,6 +540,7 @@ en:
           open_ai: "OpenAI"
           google: "Google"
           cloudflare: "Cloudflare"
+          CDCK: "CDCK"
         provider_fields:
           model_name: "Model name"
 

config/locales/server.en.yml

@@ -431,6 +431,7 @@ en:
 
     embeddings:
       delete_failed: "This model is currently in use. Update the `ai embeddings selected model` first."
+      cannot_edit_builtin: "You can't edit a built-in model."
       configuration:
         disable_embeddings: "You have to disable 'ai embeddings enabled' first."
         choose_model: "Set 'ai embeddings selected model' first."

db/migrate/20241217164540_create_embedding_definitions.rb

@@ -11,6 +11,7 @@ def change
       t.string :tokenizer_class, null: false
       t.string :url, null: false
       t.string :api_key
+      t.boolean :seeded, null: false, default: false
       t.jsonb :provider_params
       t.timestamps
     end

db/migrate/20250110114305_embedding_config_data_migration.rb

@@ -61,18 +61,22 @@ def creds_for(provider)
       }
       # TEI
     elsif provider == "hugging_face"
+      seeded = false
       endpoint = fetch_setting("ai_hugging_face_tei_endpoint")
 
       if endpoint.blank?
         endpoint = fetch_setting("ai_hugging_face_tei_endpoint_srv")
-        endpoint = "srv://#{endpoint}" if endpoint.present?
+        if endpoint.present?
+          endpoint = "srv://#{endpoint}"
+          seeded = true
+        end
       end
 
       api_key = fetch_setting("ai_hugging_face_tei_api_key")
 
       return if endpoint.blank? || api_key.blank?
 
-      { url: endpoint, api_key: api_key }
+      { url: endpoint, api_key: api_key, seeded: seeded }
       # Gemini
     elsif provider == "google"
       api_key = fetch_setting("ai_gemini_api_key")