OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.
Python
import { useMemo } from "react";
import type { ChunkResult } from "@/app/api/queries/useGetSearchQuery";
import {
EMPTY_SEARCH_RESULT,
type File,
type SearchResult,
useGetSearchQuery,
} from "@/app/api/queries/useGetSearchQuery";
import {
documentScopedSearchQueryData,
fileScopedSearchQueryData,
} from "@/lib/file-chunks";
/**
* Loads every chunk for one filename (shared by chunks page + FileChunksPanel).
*
* When `searchQuery` is a non-wildcard string, a second search request is fired
* in parallel to fetch highlight fragments for that query. The full wildcard
* result (all chunks) is always returned as the source of truth for chunk count
* and the local "Search chunks" filter. Highlights are merged in by chunk_id so
* non-matching chunks stay visible with an empty highlights list, while matching
* chunks get their <mark> fragments attached.
*/
export function useFileScopedChunksQuery(
filename: string | null | undefined,
searchQuery?: string,
) {
const isRealQuery =
Boolean(searchQuery) &&
searchQuery!.trim() !== "*" &&
searchQuery!.trim() !== "";
const queryData = filename ? fileScopedSearchQueryData(filename) : null;
// Always fetch the complete chunk list via wildcard — this is the source of
// truth for chunk count and the local "Search chunks" filter.
const { data: allData = EMPTY_SEARCH_RESULT, isFetching: isFetchingAll } =
useGetSearchQuery("*", queryData, { enabled: Boolean(filename) });
// When there is a real search query, fire a second request (scoped to the
// same file) purely to collect highlight fragments. This result is never used
// for the chunk list itself — only for merging highlights below.
//
// placeholderData is explicitly cleared (overrides the hook default of
// `prev => prev`) so stale highlights from a previous query are never merged
// onto chunks belonging to a different search term.
const { data: hlData = EMPTY_SEARCH_RESULT, isFetching: isFetchingHl } =
useGetSearchQuery(isRealQuery ? searchQuery! : "*", queryData, {
enabled: Boolean(filename) && isRealQuery,
placeholderData: undefined,
});
const file = useMemo(() => {
const allFile = (allData as SearchResult).files.find(
(entry: File) => entry.filename === filename,
);
if (!allFile || !isRealQuery) return allFile;
// Build chunk_id → highlights lookup from the search result.
const hlFile = (hlData as SearchResult).files.find(
(entry: File) => entry.filename === filename,
);
if (!hlFile) return allFile;
const hlMap = new Map<string, string[]>();
for (const chunk of hlFile.chunks ?? []) {
const key = chunk.chunk_id ?? chunk.id;
if (key && chunk.highlights && chunk.highlights.length > 0) {
hlMap.set(key, chunk.highlights);
}
}
// Merge highlights onto the full chunk list without dropping any chunks.
const mergedChunks: ChunkResult[] = (allFile.chunks ?? []).map((chunk) => {
const key = chunk.chunk_id ?? chunk.id;
const highlights = key ? (hlMap.get(key) ?? []) : [];
return highlights.length > 0 ? { ...chunk, highlights } : chunk;
});
return { ...allFile, chunks: mergedChunks };
}, [allData, hlData, filename, isRealQuery]);
return { file, isFetching: isFetchingAll || isFetchingHl };
}
export function useDocumentScopedChunksQuery(
documentId: string | null | undefined,
searchQuery?: string,
) {
const queryData = documentId
? documentScopedSearchQueryData(documentId)
: null;
const isRealQuery =
Boolean(searchQuery) &&
searchQuery!.trim() !== "*" &&
searchQuery!.trim() !== "";
const { data: allData = EMPTY_SEARCH_RESULT, isFetching: isFetchingAll } =
useGetSearchQuery(
"*",
queryData,
{ enabled: Boolean(documentId) },
{ groupBy: "document_id" },
);
const { data: hlData = EMPTY_SEARCH_RESULT, isFetching: isFetchingHl } =
useGetSearchQuery(
isRealQuery ? searchQuery! : "*",
queryData,
{
enabled: Boolean(documentId) && isRealQuery,
placeholderData: undefined,
},
{ groupBy: "document_id" },
);
const file = useMemo(() => {
const allFile = (allData as SearchResult).files[0];
if (!allFile || !isRealQuery) return allFile;
const highlightsByChunk = new Map<string, string[]>();
for (const chunk of (hlData as SearchResult).files[0]?.chunks ?? []) {
const key = chunk.chunk_id ?? chunk.id;
if (key && chunk.highlights?.length) {
highlightsByChunk.set(key, chunk.highlights);
}
}
return {
...allFile,
chunks: (allFile.chunks ?? []).map((chunk) => {
const key = chunk.chunk_id ?? chunk.id;
const highlights = key ? (highlightsByChunk.get(key) ?? []) : [];
return highlights.length ? { ...chunk, highlights } : chunk;
}),
};
}, [allData, hlData, isRealQuery]);
return { file, isFetching: isFetchingAll || isFetchingHl };
}