OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.
Python
fix: add clickable citations in onboarding (#2156)
Lucas Oliveira1ba77a7524ed
diff --git a/frontend/app/chat/_components/assistant-message.tsx b/frontend/app/chat/_components/assistant-message.tsxindex 47dcfbc2c..7d4cac7c6 100644--- a/frontend/app/chat/_components/assistant-message.tsx+++ b/frontend/app/chat/_components/assistant-message.tsx@@ -66,7 +66,7 @@ interface AssistantMessageProps {usage?: TokenUsageType;timestamp?: Date;showFeedback?: boolean;- interactiveCitations?: boolean;+ showViewDocument?: boolean;showFunctionCalls?: boolean;unstyledMessageContent?: boolean;}@@ -88,7 +88,7 @@ export function AssistantMessage({usage,timestamp,showFeedback = true,- interactiveCitations = true,+ showViewDocument = true,showFunctionCalls = true,unstyledMessageContent = false,}: AssistantMessageProps) {@@ -270,9 +270,7 @@ export function AssistantMessage({: "text-foreground",)}chatMessage={displayMessageText}- onCitationClick={- interactiveCitations ? openChunkPopoverFromText : undefined- }+ onCitationClick={openChunkPopoverFromText}/>{/* Citation Cards */}@@ -280,13 +278,8 @@ export function AssistantMessage({<CitationCardscitedSources={citedSources}activeCardIndex={activeChunkIndex}- onCardClick={- interactiveCitations ? openChunkPopover : undefined- }- onCardRef={- interactiveCitations ? setCitationCardRef : undefined- }- interactive={interactiveCitations}+ onCardClick={openChunkPopover}+ onCardRef={setCitationCardRef}/>)}@@ -307,7 +300,7 @@ export function AssistantMessage({</Message>{/* Chunk Details Popup Modal */}- {interactiveCitations && activeCitedSource && (+ {activeCitedSource && (<ChunkPopuponClose={closeChunkPopover}chunkNumber={activeCitedSource.index}@@ -327,6 +320,7 @@ export function AssistantMessage({""}item={activeCitedSource.item}+ showViewDocument={showViewDocument}/>)}</Popover>diff --git a/frontend/app/chat/_components/chunk-popup.tsx b/frontend/app/chat/_components/chunk-popup.tsxindex 9c9be4877..e7784eebc 100644--- a/frontend/app/chat/_components/chunk-popup.tsx+++ b/frontend/app/chat/_components/chunk-popup.tsx@@ -14,6 +14,7 @@ interface ChunkPopupProps {score: number | string;sourceText: string;item: ToolCallResult;+ showViewDocument?: boolean;}const getMetadataValue = (@@ -103,11 +104,12 @@ export function ChunkPopup({score,sourceText,item,+ showViewDocument = true,}: ChunkPopupProps) {const { data: settings } = useGetSettingsQuery();const closeButtonRef = useRef<HTMLButtonElement>(null);- const hasUrl = !!item.source_url;+ const hasUrl = showViewDocument && !!item.source_url;const parser = formatParser(item, filename);const scoreLabel = formatScore(item, score);const pageLabel = formatPage(item);diff --git a/frontend/app/onboarding/_components/onboarding-content.tsx b/frontend/app/onboarding/_components/onboarding-content.tsxindex 7f0362f68..d4b3ad546 100644--- a/frontend/app/onboarding/_components/onboarding-content.tsx+++ b/frontend/app/onboarding/_components/onboarding-content.tsx@@ -39,6 +39,12 @@ const sanitizeCitationResult = (item: ToolCallResult): ToolCallResult => {file_path: item.data.file_path,page: item.data.page,score: item.data.score,+ text: item.data.text,+ embedding_model: item.data.embedding_model,+ parser: item.data.parser,+ chunk_size: item.data.chunk_size,+ chunk_overlap: item.data.chunk_overlap,+ metadata: item.data.metadata,};return Object.values(sanitizedData).some((value) => value !== undefined)@@ -53,6 +59,13 @@ const sanitizeCitationResult = (item: ToolCallResult): ToolCallResult => {filename: item.filename,page: item.page ?? item.data?.page,score: item.score ?? item.data?.score,+ text: item.text ?? item.data?.text,+ embedding_model: item.embedding_model ?? item.data?.embedding_model,+ parser: item.parser ?? item.data?.parser,+ chunk_size: item.chunk_size ?? item.data?.chunk_size,+ chunk_overlap: item.chunk_overlap ?? item.data?.chunk_overlap,+ source_url: item.source_url,+ metadata: item.metadata ?? item.data?.metadata,};};@@ -351,7 +364,7 @@ export function OnboardingContent({isStreaming={!!streamingMessage}isCompleted={currentStep > 3}showFeedback={false}- interactiveCitations={false}+ showViewDocument={false}showFunctionCalls={false}unstyledMessageContent/>diff --git a/src/api/settings/models.py b/src/api/settings/models.pyindex 183849fd3..a7108f225 100644--- a/src/api/settings/models.py+++ b/src/api/settings/models.py@@ -67,6 +67,12 @@ class CitationDisplayData(BaseModel):file_path: str | None = Nonepage: int | str | None = Nonescore: float | str | None = None+ text: str | None = None+ embedding_model: str | None = None+ parser: str | None = None+ chunk_size: int | float | str | None = None+ chunk_overlap: int | float | str | None = None+ metadata: dict[str, Any] | None = Noneclass CitationDisplayResult(BaseModel):@@ -76,6 +82,13 @@ class CitationDisplayResult(BaseModel):filename: str | None = Nonepage: int | str | None = Nonescore: float | str | None = None+ text: str | None = None+ embedding_model: str | None = None+ parser: str | None = None+ chunk_size: int | float | str | None = None+ chunk_overlap: int | float | str | None = None+ source_url: str | None = None+ metadata: dict[str, Any] | None = Noneclass CitationDisplayResultGroup(BaseModel):diff --git a/tests/unit/api/test_settings_endpoints.py b/tests/unit/api/test_settings_endpoints.pyindex 88177acb5..1b1c57580 100644--- a/tests/unit/api/test_settings_endpoints.py+++ b/tests/unit/api/test_settings_endpoints.py@@ -9,6 +9,7 @@ import pytestfrom fastapi import HTTPExceptionfrom api.settings import DoclingPresetBody, update_docling_preset+from api.settings.models import AssistantMessage, OnboardingFunctionCallfrom session_manager import User@@ -35,3 +36,60 @@ async def test_update_docling_preset_invalid_preset_returns_400():assert exc_info.value.status_code == 400assert "Invalid preset" in exc_info.value.detailassert "nonexistent_preset" in exc_info.value.detail+++def test_assistant_message_citation_serialization():+ """Test AssistantMessage model citation parsing with text and metadata."""+ payload = {+ "role": "assistant",+ "content": "Here is the response [1]",+ "timestamp": "2026-07-27T00:00:00.000Z",+ "functionCalls": [+ {+ "name": "search_docs",+ "status": "completed",+ "result": [+ {+ "chunk_id": "chunk-123",+ "filename": "doc.pdf",+ "page": 2,+ "score": 0.95,+ "text": "Extracted chunk text",+ "embedding_model": "text-embedding-3-small",+ "parser": "Docling",+ "chunk_size": 512,+ "chunk_overlap": 64,+ "source_url": "https://example.com/doc.pdf",+ "metadata": {"custom_key": "val"},+ "data": {+ "file_path": "/path/to/doc.pdf",+ "page": 2,+ "score": 0.95,+ "text": "Extracted chunk text",+ "embedding_model": "text-embedding-3-small",+ "parser": "Docling",+ "chunk_size": 512,+ "chunk_overlap": 64,+ },+ }+ ],+ }+ ],+ }++ msg = AssistantMessage(**payload)+ assert msg.functionCalls is not None+ assert len(msg.functionCalls) == 1+ fc = msg.functionCalls[0]+ assert isinstance(fc, OnboardingFunctionCall)+ assert fc.result is not None+ result = fc.result[0]+ assert result.text == "Extracted chunk text"+ assert result.embedding_model == "text-embedding-3-small"+ assert result.parser == "Docling"+ assert result.chunk_size == 512+ assert result.chunk_overlap == 64+ assert result.source_url == "https://example.com/doc.pdf"+ assert result.metadata == {"custom_key": "val"}+ assert result.data is not None+ assert result.data.text == "Extracted chunk text"