Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEV: Robust check for embeddings enabled #1116

Merged
merged 1 commit into from
Feb 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ def indexing_status_check
def upload_file
file = params[:file] || params[:files].first

if !SiteSetting.ai_embeddings_enabled?
if !DiscourseAi::Embeddings.enabled?
raise Discourse::InvalidAccess.new("Embeddings not enabled")
end

Expand Down
2 changes: 1 addition & 1 deletion app/jobs/regular/generate_embeddings.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class GenerateEmbeddings < ::Jobs::Base
sidekiq_options queue: "low"

def execute(args)
return unless SiteSetting.ai_embeddings_enabled
return unless DiscourseAi::Embeddings.enabled?
return if args[:target_type].blank? || args[:target_id].blank?
target = args[:target_type].constantize.find_by_id(args[:target_id])
return if target.nil? || target.deleted_at.present?
Expand Down
2 changes: 1 addition & 1 deletion app/jobs/scheduled/embeddings_backfill.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ class EmbeddingsBackfill < ::Jobs::Scheduled
cluster_concurrency 1

def execute(args)
return unless SiteSetting.ai_embeddings_enabled
return unless DiscourseAi::Embeddings.enabled?

limit = SiteSetting.ai_embeddings_backfill_batch_size

Expand Down
4 changes: 2 additions & 2 deletions app/models/rag_document_fragment.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class << self
def link_target_and_uploads(target, upload_ids)
return if target.blank?
return if upload_ids.blank?
return if !SiteSetting.ai_embeddings_enabled?
return if !DiscourseAi::Embeddings.enabled?

UploadReference.ensure_exist!(upload_ids: upload_ids, target: target)

Expand All @@ -27,7 +27,7 @@ def link_target_and_uploads(target, upload_ids)

def update_target_uploads(target, upload_ids)
return if target.blank?
return if !SiteSetting.ai_embeddings_enabled?
return if !DiscourseAi::Embeddings.enabled?

if upload_ids.blank?
RagDocumentFragment.where(target: target).destroy_all
Expand Down
2 changes: 1 addition & 1 deletion lib/ai_bot/entry_point.rb
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ def inject_into(plugin)
)

plugin.on(:site_setting_changed) do |name, old_value, new_value|
if name == :ai_embeddings_selected_model && SiteSetting.ai_embeddings_enabled? &&
if name == :ai_embeddings_selected_model && DiscourseAi::Embeddings.enabled? &&
new_value != old_value
RagDocumentFragment.delete_all
UploadReference
Expand Down
2 changes: 1 addition & 1 deletion lib/ai_bot/personas/persona.rb
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ def rag_fragments_prompt(conversation_context, llm:, user:)
upload_refs =
UploadReference.where(target_id: id, target_type: "AiPersona").pluck(:upload_id)

return nil if !SiteSetting.ai_embeddings_enabled?
return nil if !DiscourseAi::Embeddings.enabled?
return nil if conversation_context.blank? || upload_refs.blank?

latest_interactions =
Expand Down
4 changes: 2 additions & 2 deletions lib/ai_helper/semantic_categorizer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ def initialize(input, user)

def categories
return [] if @text.blank?
return [] unless SiteSetting.ai_embeddings_enabled
return [] if !DiscourseAi::Embeddings.enabled?

candidates = nearest_neighbors(limit: 100)
return [] if candidates.empty?
Expand Down Expand Up @@ -51,7 +51,7 @@ def categories

def tags
return [] if @text.blank?
return [] unless SiteSetting.ai_embeddings_enabled
return [] if !DiscourseAi::Embeddings.enabled?

candidates = nearest_neighbors(limit: 100)
return [] if candidates.empty?
Expand Down
13 changes: 2 additions & 11 deletions lib/configuration/embedding_defs_validator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,11 @@ def initialize(opts = {})
end

def valid_value?(val)
if val.blank?
@module_enabled = SiteSetting.ai_embeddings_enabled

!@module_enabled
else
EmbeddingDefinition.exists?(id: val).tap { |def_exists| @invalid_option = !def_exists }
end
val.present? || !SiteSetting.ai_embeddings_enabled
end

def error_message
return I18n.t("discourse_ai.embeddings.configuration.disable_embeddings") if @module_enabled
return I18n.t("discourse_ai.embeddings.configuration.invalid_config") if @invalid_option

""
I18n.t("discourse_ai.embeddings.configuration.disable_embeddings")
end
end
end
Expand Down
10 changes: 10 additions & 0 deletions lib/embeddings.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# frozen_string_literal: true

module DiscourseAi
module Embeddings
def self.enabled?
SiteSetting.ai_embeddings_enabled && SiteSetting.ai_embeddings_selected_model.present? &&
EmbeddingDefinition.exists?(id: SiteSetting.ai_embeddings_selected_model)
end
end
end
2 changes: 1 addition & 1 deletion lib/embeddings/entry_point.rb
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def inject_into(plugin)
# embeddings generation.
callback =
Proc.new do |target|
if SiteSetting.ai_embeddings_enabled &&
if DiscourseAi::Embeddings.enabled? &&
(target.is_a?(Topic) || SiteSetting.ai_embeddings_per_post_enabled)
Jobs.enqueue(
:generate_embeddings,
Expand Down
4 changes: 4 additions & 0 deletions spec/lib/modules/embeddings/entry_point_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
describe DiscourseAi::Embeddings::EntryPoint do
fab!(:user) { Fabricate(:user, refresh_auto_groups: true) }

fab!(:embedding_definition)

before { SiteSetting.ai_embeddings_selected_model = embedding_definition.id }

describe "registering event callbacks" do
context "when creating a topic" do
let(:creator) do
Expand Down
5 changes: 4 additions & 1 deletion spec/models/rag_document_fragment_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
fab!(:upload_2) { Fabricate(:upload) }
fab!(:vector_def) { Fabricate(:embedding_definition) }

before { SiteSetting.ai_embeddings_enabled = true }
before do
SiteSetting.ai_embeddings_selected_model = vector_def.id
SiteSetting.ai_embeddings_enabled = true
end

describe ".link_uploads_and_persona" do
it "does nothing if there is no persona" do
Expand Down
3 changes: 2 additions & 1 deletion spec/requests/admin/ai_personas_controller_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
RSpec.describe DiscourseAi::Admin::AiPersonasController do
fab!(:admin)
fab!(:ai_persona)
fab!(:embedding_definition)

before do
sign_in(admin)

SiteSetting.ai_embeddings_selected_model = embedding_definition.id
SiteSetting.ai_embeddings_enabled = true
end

Expand Down