Skip to content

A platform for community discussion. Free, open, simple.

DEV: Expose search rag tool and case insensitivity (#43632)

Natalie Tayff3b055b9dd4
diff --git a/plugins/discourse-ai/app/models/rag_document_fragment.rb b/plugins/discourse-ai/app/models/rag_document_fragment.rb
index 9a47d195a45..fdacf159467 100644
--- a/plugins/discourse-ai/app/models/rag_document_fragment.rb
+++ b/plugins/discourse-ai/app/models/rag_document_fragment.rb
@@ -79,18 +79,22 @@ class RagDocumentFragment < ActiveRecord::Base
return [] if upload_ids.empty?
query_vector = DiscourseAi::Embeddings::Vector.instance.vector_from(query)
+ phrase_pattern = "(^|[^[:alnum:]_])#{Regexp.escape(query.strip)}($|[^[:alnum:]_])"
fragment_ids =
- DiscourseAi::Embeddings::Schema
- .for(self)
- .asymmetric_similarity_search(query_vector, limit: limit, offset: 0) do |builder|
- builder.join(<<~SQL, target_id: target_id, target_type: target_type)
- rag_document_fragments ON
- rag_document_fragments.id = rag_document_fragment_id AND
- rag_document_fragments.target_id = :target_id AND
- rag_document_fragments.target_type = :target_type
- SQL
- end
- .map(&:rag_document_fragment_id)
+ ranked_fragment_ids(
+ query_vector,
+ target_id:,
+ target_type:,
+ upload_ids:,
+ limit:,
+ phrase_pattern:,
+ )
+
+ if fragment_ids.length < limit
+ semantic_fragment_ids =
+ ranked_fragment_ids(query_vector, target_id:, target_type:, upload_ids:, limit:)
+ fragment_ids = (fragment_ids + semantic_fragment_ids).uniq.take(limit)
+ end
uploads_by_id = Upload.where(id: upload_ids).pluck(:id, :original_filename).to_h
fragments =
@@ -149,6 +153,31 @@ class RagDocumentFragment < ActiveRecord::Base
private
+ def ranked_fragment_ids(
+ query_vector,
+ target_id:,
+ target_type:,
+ upload_ids:,
+ limit:,
+ phrase_pattern: nil
+ )
+ DiscourseAi::Embeddings::Schema
+ .for(self)
+ .asymmetric_similarity_search(query_vector, limit:, offset: 0) do |builder|
+ builder.join(<<~SQL, target_id:, target_type:)
+ rag_document_fragments ON
+ rag_document_fragments.id = rag_document_fragment_id AND
+ rag_document_fragments.target_id = :target_id AND
+ rag_document_fragments.target_type = :target_type
+ SQL
+ builder.where("rag_document_fragments.upload_id IN (:upload_ids)", upload_ids:)
+ if phrase_pattern
+ builder.where("rag_document_fragments.fragment ~* :phrase_pattern", phrase_pattern:)
+ end
+ end
+ .map(&:rag_document_fragment_id)
+ end
+
def upload_ids_for(target_id:, target_type:, filenames: nil)
upload_ids =
UploadReference.where(target_id: target_id, target_type: target_type).pluck(:upload_id)
diff --git a/plugins/discourse-ai/lib/agents/agent.rb b/plugins/discourse-ai/lib/agents/agent.rb
index 1d5519f457c..92369074b13 100644
--- a/plugins/discourse-ai/lib/agents/agent.rb
+++ b/plugins/discourse-ai/lib/agents/agent.rb
@@ -106,6 +106,7 @@ module DiscourseAi
Tools::ListUsers,
Tools::Time,
Tools::Search,
+ Tools::SearchUploadedDocuments,
Tools::Read,
Tools::ReadPost,
Tools::FlagPost,
diff --git a/plugins/discourse-ai/spec/lib/agents/tools/search_uploaded_documents_spec.rb b/plugins/discourse-ai/spec/lib/agents/tools/search_uploaded_documents_spec.rb
index f645a7d8275..37484f38c85 100644
--- a/plugins/discourse-ai/spec/lib/agents/tools/search_uploaded_documents_spec.rb
+++ b/plugins/discourse-ai/spec/lib/agents/tools/search_uploaded_documents_spec.rb
@@ -32,7 +32,7 @@ RSpec.describe DiscourseAi::Agents::Tools::SearchUploadedDocuments do
let(:embedding_value) { 0.04381 }
let(:query_embeddings) { [embedding_value] * vector_def.dimensions }
- def store_fragment(text:, upload:, index:)
+ def store_fragment(text:, upload:, index:, embeddings: nil)
fragment =
Fabricate(
:rag_document_fragment,
@@ -42,7 +42,7 @@ RSpec.describe DiscourseAi::Agents::Tools::SearchUploadedDocuments do
fragment_number: index + 1,
)
- embeddings = [embedding_value + "0.000#{index}".to_f] * vector_def.dimensions
+ embeddings ||= [embedding_value + "0.000#{index}".to_f] * vector_def.dimensions
DiscourseAi::Embeddings::Schema.for(RagDocumentFragment).store(fragment, embeddings, "test")
end
@@ -92,4 +92,119 @@ RSpec.describe DiscourseAi::Agents::Tools::SearchUploadedDocuments do
)
expect(result[:filenames]).to eq(["faq.md"])
end
+
+ it "prioritizes a lowercase glossary query over semantically similar excerpts" do
+ glossary = "| Apothecary Skill | Arzneikunde-Fähigkeit |"
+ store_fragment(text: glossary, upload: upload, index: 0)
+ store_fragment(text: "Making potions", upload: upload, index: 1)
+ store_fragment(text: "Collecting herbs", upload: upload, index: 2)
+ exact_fragment = RagDocumentFragment.find_by!(fragment: glossary, target: ai_agent)
+ DiscourseAi::Embeddings::Schema.for(RagDocumentFragment).store(
+ exact_fragment,
+ query_embeddings.map { |value| -value },
+ "test",
+ )
+ EmbeddingsGenerationStubs.hugging_face_service("apothecary skill", query_embeddings)
+
+ result =
+ described_class.new(
+ { query: "apothecary skill", limit: 1 },
+ bot_user: nil,
+ llm: nil,
+ agent: agent,
+ ).invoke
+
+ expect(result[:excerpts].map { |excerpt| excerpt[:content] }).to eq([glossary])
+ end
+
+ it "keeps exact matches within the agent and requested file" do
+ other_agent = Fabricate(:ai_agent)
+ Fabricate(:rag_document_fragment, target: other_agent, upload: upload, fragment: "猫_100%")
+ store_fragment(text: "猫_100% in another file", upload: other_upload, index: 0)
+ store_fragment(text: "猫X1000", upload: upload, index: 1)
+ store_fragment(text: "猫_100%", upload: upload, index: 2)
+ EmbeddingsGenerationStubs.hugging_face_service("猫_100%", query_embeddings)
+
+ result =
+ described_class.new(
+ { query: "猫_100%", filenames: ["guide.md"], limit: 1 },
+ bot_user: nil,
+ llm: nil,
+ agent: agent,
+ ).invoke
+
+ expect(result[:excerpts]).to eq(
+ [{ filename: "guide.md", metadata: nil, fragment_number: 3, content: "猫_100%" }],
+ )
+ end
+
+ it "fills remaining results with semantic matches without repeating exact matches" do
+ store_fragment(text: "Apothecary Skill", upload: upload, index: 0)
+ store_fragment(text: "Making potions", upload: upload, index: 1)
+ EmbeddingsGenerationStubs.hugging_face_service("apothecary skill", query_embeddings)
+
+ result =
+ described_class.new(
+ { query: "apothecary skill", limit: 3 },
+ bot_user: nil,
+ llm: nil,
+ agent: agent,
+ ).invoke
+
+ expect(result[:excerpts].map { |excerpt| excerpt[:content] }).to eq(
+ ["Apothecary Skill", "Making potions"],
+ )
+ end
+
+ it "does not prioritize a query found inside another word" do
+ store_fragment(
+ text: "Party planning",
+ upload: upload,
+ index: 0,
+ embeddings: query_embeddings.map { |value| -value },
+ )
+ store_fragment(text: "Painting and sculpture", upload: upload, index: 1)
+ EmbeddingsGenerationStubs.hugging_face_service("art", query_embeddings)
+
+ result =
+ described_class.new({ query: "art", limit: 1 }, bot_user: nil, llm: nil, agent: agent).invoke
+
+ expect(result[:excerpts].map { |excerpt| excerpt[:content] }).to eq(["Painting and sculpture"])
+ end
+
+ it "ranks whole phrase matches by relevance when they exceed the result limit" do
+ store_fragment(
+ text: "Art history",
+ upload: upload,
+ index: 0,
+ embeddings: query_embeddings.map { |value| -value },
+ )
+ store_fragment(
+ text: "Art supplies",
+ upload: upload,
+ index: 1,
+ embeddings:
+ query_embeddings.each_with_index.map { |value, index| index.even? ? value : -value },
+ )
+ store_fragment(text: "Art classes", upload: upload, index: 2)
+ EmbeddingsGenerationStubs.hugging_face_service("art", query_embeddings)
+
+ result =
+ described_class.new({ query: "art", limit: 2 }, bot_user: nil, llm: nil, agent: agent).invoke
+
+ expect(result[:excerpts].map { |excerpt| excerpt[:content] }).to eq(
+ ["Art classes", "Art supplies"],
+ )
+ end
+
+ it "matches punctuation in a term literally" do
+ store_fragment(text: "C programming", upload: upload, index: 0)
+ store_fragment(text: "| C++ | C++ |", upload: upload, index: 1)
+ EmbeddingsGenerationStubs.hugging_face_service("C++", query_embeddings)
+
+ result =
+ described_class.new({ query: "C++", limit: 1 }, bot_user: nil, llm: nil, agent: agent).invoke
+
+ expect(result[:excerpts].map { |excerpt| excerpt[:content] }).to eq(["| C++ | C++ |"])
+ end
end
diff --git a/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rb b/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rb
index 59ef8b577d3..e282f0fdba3 100644
--- a/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rb
+++ b/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rb
@@ -15,6 +15,14 @@ RSpec.describe DiscourseAi::Admin::AiAgentsController do
end
describe "GET #index" do
+ it "offers uploaded document search in the tool catalog" do
+ get "/admin/plugins/discourse-ai/ai-agents.json"
+
+ expect(response.parsed_body.dig("meta", "tools")).to include(
+ a_hash_including("id" => "SearchUploadedDocuments"),
+ )
+ end
+
it "returns a success response" do
get "/admin/plugins/discourse-ai/ai-agents.json"
expect(response).to be_successful
diff --git a/plugins/discourse-ai/spec/system/admin_ai_agent_spec.rb b/plugins/discourse-ai/spec/system/admin_ai_agent_spec.rb
index 234d4469a73..b68fc0faddc 100644
--- a/plugins/discourse-ai/spec/system/admin_ai_agent_spec.rb
+++ b/plugins/discourse-ai/spec/system/admin_ai_agent_spec.rb
@@ -14,6 +14,21 @@ RSpec.describe "Admin AI agent configuration" do
sign_in(admin)
end
+ it "lets admins require uploaded document search on every reply" do
+ agent = Fabricate(:ai_agent)
+ agent_editor_page.visit_edit(agent)
+ agent_editor_page.select_tool("SearchUploadedDocuments")
+ agent_editor_page.select_tool("SearchUploadedDocuments", forced: true)
+ form.field("forced_tool_count").select(-1)
+ form.submit
+
+ expect(page).to have_content(I18n.t("js.discourse_ai.ai_agent.saved"))
+ agent_editor_page.visit_edit(agent)
+
+ expect(agent_editor_page).to have_forced_tool("Search Uploaded Documents")
+ expect(page).to have_select("Forced tool strategy", selected: "Apply to all replies")
+ end
+
it "allows creation of a agent" do
visit "/admin/plugins/discourse-ai/ai-agents"
diff --git a/plugins/discourse-ai/spec/system/page_objects/pages/admin_ai_agent.rb b/plugins/discourse-ai/spec/system/page_objects/pages/admin_ai_agent.rb
index 2f37d89854f..8ccb74b8530 100644
--- a/plugins/discourse-ai/spec/system/page_objects/pages/admin_ai_agent.rb
+++ b/plugins/discourse-ai/spec/system/page_objects/pages/admin_ai_agent.rb
@@ -74,6 +74,21 @@ module PageObjects
@form ||= PageObjects::Components::FormKit.new("form")
end
+ def select_tool(tool_id, forced: false)
+ selector =
+ PageObjects::Components::SelectKit.new(
+ "#control-#{forced ? "forcedTools" : "tools"} .select-kit",
+ )
+ selector.expand
+ selector.select_row_by_value(tool_id)
+ selector.collapse
+ self
+ end
+
+ def has_forced_tool?(name)
+ page.has_css?("#control-forcedTools .formatted-selection", text: name)
+ end
+
def has_no_subagent_option?(agent)
subagent_selector.expand
result = subagent_selector.has_no_option_value?(agent.id)