Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active
TypeScript aianthropicartifactsawsazurechatgptchatgpt-cloneclaudeclonedeepseekgeminigooglegpt-5librechatmcpo1openairesponses-apivisionwebui
import { useMemo, useState, useCallback } from 'react';
import { Tools } from 'librechat-data-provider';
import { TooltipAnchor } from '@librechat/client';
import { FileText, FileSpreadsheet, FileCode, FileImage, File } from 'lucide-react';
import {
toolPanelSpacingClassName,
useToolExpansion,
useToolCallIntent,
} from '@librechat/chat/react';
import type { TAttachment, TFile, PartMetadata } from 'librechat-data-provider';
import { useLocalize, useProgress, useExpandCollapse } from '~/hooks';
import { ToolIcon, OutputRenderer, isError } from './ToolOutput';
import { resolveToolCallPhase } from '~/utils/toolCallPhase';
import FilePreviewDialog from './FilePreviewDialog';
import { sortPagesByRelevance, cn } from '~/utils';
import { useToolPreparation } from './preparation';
import { useGetFiles } from '~/data-provider';
import ProgressText from './ProgressText';
interface FileSource {
fileId: string;
fileName: string;
relevance: number;
content: string;
pages: number[];
pageRelevance: Record<number, number>;
fileType?: string;
fileBytes?: number;
fileSource?: string;
metadata?: Record<string, unknown>;
}
function extractFileSources(attachments?: TAttachment[]): FileSource[] {
if (!attachments) {
return [];
}
const deduped = new Map<string, FileSource>();
for (const att of attachments) {
if (att.type !== Tools.file_search || !att[Tools.file_search]) {
continue;
}
const raw = att[Tools.file_search] as { sources?: FileSource[] };
if (!raw.sources) {
continue;
}
for (const source of raw.sources) {
const key = source.fileId;
const existing = deduped.get(key);
const meta = source.metadata as Record<string, unknown> | undefined;
if (existing) {
const mergedPages = [...new Set([...existing.pages, ...(source.pages || [])])];
existing.pages = mergedPages;
existing.relevance = Math.max(existing.relevance, source.relevance || 0);
existing.pageRelevance = { ...existing.pageRelevance, ...source.pageRelevance };
if (source.content && existing.content) {
existing.content += '\n\n' + source.content;
} else if (source.content) {
existing.content = source.content;
}
} else {
deduped.set(key, {
fileId: source.fileId,
fileName: source.fileName,
relevance: source.relevance || 0,
content: source.content || '',
pages: source.pages || [],
pageRelevance: source.pageRelevance || {},
fileType: (meta?.fileType as string) || undefined,
fileBytes: (meta?.fileBytes as number) || undefined,
fileSource: (meta?.storageType as string) || undefined,
metadata: meta,
});
}
}
}
return Array.from(deduped.values()).sort((a, b) => b.relevance - a.relevance);
}
interface ParsedResult {
filename: string;
relevance: number;
content: string;
}
interface DisplayResult {
fileId?: string;
fileName: string;
relevance: number;
content: string;
pages?: number[];
pageRelevance?: Record<number, number>;
fileType?: string;
fileBytes?: number;
fileSource?: string;
}
interface FileMatch {
fileId: string;
fileName: string;
fileType?: string;
fileBytes?: number;
fileSource?: string;
}
function normalizeFilename(filename: string): string {
return filename.toLowerCase().replace(/[^a-z0-9.]/g, '');
}
function addFileMatch(
lookup: Map<string, FileMatch | null>,
fileName: string | undefined,
match: FileMatch,
): void {
if (!fileName) {
return;
}
const key = normalizeFilename(fileName);
if (key.length === 0) {
return;
}
const existing = lookup.get(key);
if (!existing) {
lookup.set(key, match);
return;
}
if (existing.fileId !== match.fileId) {
lookup.set(key, null);
}
}
function buildFileLookup(
fileSources: FileSource[],
files?: TFile[],
): Map<string, FileMatch | null> {
const lookup = new Map<string, FileMatch | null>();
for (const source of fileSources) {
addFileMatch(lookup, source.fileName, {
fileId: source.fileId,
fileName: source.fileName,
fileType: source.fileType,
fileBytes: source.fileBytes,
fileSource: source.fileSource,
});
}
for (const file of files ?? []) {
if (!file.file_id || !file.filename) {
continue;
}
const key = normalizeFilename(file.filename);
if (lookup.has(key)) {
continue;
}
addFileMatch(lookup, file.filename, {
fileId: file.file_id,
fileName: file.filename,
fileType: file.type ?? undefined,
fileBytes: file.bytes,
fileSource: file.source ?? undefined,
});
}
return lookup;
}
function mergeRetrievalResults(
fileSources: FileSource[],
parsedResults: ParsedResult[],
files?: TFile[],
): DisplayResult[] {
if (parsedResults.length === 0) {
return fileSources.map((source) => ({
fileId: source.fileId,
fileName: source.fileName,
relevance: source.relevance,
content: source.content,
pages: source.pages,
pageRelevance: source.pageRelevance,
fileType: source.fileType,
fileBytes: source.fileBytes,
fileSource: source.fileSource,
}));
}
const fileLookup = buildFileLookup(fileSources, files);
return parsedResults.map((result) => {
const key = normalizeFilename(result.filename);
const match = fileLookup.get(key) ?? undefined;
return {
fileId: match?.fileId,
fileName: match?.fileName ?? result.filename,
relevance: result.relevance,
content: result.content,
fileType: match?.fileType,
fileBytes: match?.fileBytes,
fileSource: match?.fileSource,
};
});
}
function parseRetrievalOutput(raw: string): ParsedResult[] {
const sections = raw.split('\n---\n');
const results: ParsedResult[] = [];
for (const section of sections) {
const trimmed = section.trim();
if (!trimmed) {
continue;
}
let filename = '';
let relevance = 0;
const contentLines: string[] = [];
let inContent = false;
for (const line of trimmed.split('\n')) {
if (inContent) {
contentLines.push(line);
continue;
}
if (line.startsWith('File: ')) {
filename = line.slice(6).trim();
} else if (line.startsWith('Relevance: ')) {
relevance = parseFloat(line.slice(11).trim()) || 0;
} else if (line.startsWith('Content: ')) {
inContent = true;
contentLines.push(line.slice(9));
}
}
if (filename) {
results.push({ filename, relevance, content: contentLines.join('\n').trim() });
}
}
return results;
}
function getFileIcon(mimeType?: string): React.ComponentType<{ className?: string }> {
if (!mimeType) {
return FileText;
}
if (mimeType.includes('spreadsheet') || mimeType.includes('excel') || mimeType.includes('csv')) {
return FileSpreadsheet;
}
if (mimeType.includes('image')) {
return FileImage;
}
if (
mimeType.includes('javascript') ||
mimeType.includes('typescript') ||
mimeType.includes('json') ||
mimeType.includes('xml') ||
mimeType.includes('html')
) {
return FileCode;
}
if (mimeType.includes('pdf') || mimeType.includes('text') || mimeType.includes('word')) {
return FileText;
}
return File;
}
function FileHeader({
fileName,
relevance,
pages,
pageRelevance,
fileType,
onOpenPreview,
}: {
fileName: string;
relevance: number;
pages?: number[];
pageRelevance?: Record<number, number>;
fileType?: string;
onOpenPreview?: () => void;
}) {
const localize = useLocalize();
const IconComponent = getFileIcon(fileType);
const sortedPages = pages && pageRelevance ? sortPagesByRelevance(pages, pageRelevance) : pages;
return (
<div className="flex items-center gap-2 px-3 py-2">
<IconComponent className="text-text-secondary size-3.5 shrink-0" aria-hidden="true" />
{onOpenPreview ? (
<button
type="button"
onClick={onOpenPreview}
className="text-text-primary decoration-border-medium hover:text-text-secondary focus-visible:ring-focus-subtle min-w-0 truncate text-start text-xs font-medium underline underline-offset-2 transition-colors focus-visible:ring-2 focus-visible:ring-offset-1 focus-visible:outline-hidden"
aria-label={`${localize('com_ui_preview')}: ${fileName}`}
>
{fileName}
</button>
) : (
<span className="text-text-primary min-w-0 truncate text-xs font-medium">{fileName}</span>
)}
{relevance > 0 && (
<TooltipAnchor
description={localize('com_ui_relevance')}
side="top"
className="flex cursor-help items-center"
>
<span
className="bg-surface-tertiary text-text-secondary text-2xs shrink-0 cursor-help rounded px-1.5 py-0.5 leading-none tabular-nums"
aria-label={`${localize('com_ui_relevance')}: ${Math.round(relevance * 100)}%`}
>
{Math.round(relevance * 100)}%
</span>
</TooltipAnchor>
)}
<span className="flex-1" />
{sortedPages && sortedPages.length > 0 && (
<span className="text-text-secondary text-2xs shrink-0">
{localize('com_file_pages', { pages: sortedPages.join(', ') })}
</span>
)}
</div>
);
}
export default function RetrievalCall({
initialProgress = 0.1,
isSubmitting,
args,
output,
attachments,
onExpand,
runStepStatus,
runStepDurationMs,
}: {
initialProgress: number;
isSubmitting: boolean;
args?: string | Record<string, unknown>;
output?: string;
attachments?: TAttachment[];
onExpand?: () => void;
runStepStatus?: PartMetadata['runStepStatus'];
runStepDurationMs?: PartMetadata['runStepDurationMs'];
}) {
const isClosed = runStepStatus != null;
/**
* Both halves are load-bearing. Passing 1 in stops `useProgress` scheduling
* its 200ms interval, which it keeps alive for any input below 1. Masking
* the result makes the terminal value observable on the same render — the
* hook settles through 0.99 and a 200ms timeout, so a step closing while
* mounted would otherwise render as still in progress for that window.
*/
const rawProgress = useProgress(isClosed ? 1 : initialProgress);
const localize = useLocalize();
/** Model-authored live label (injected when file_search is opted into
* describe_intent); persists as the settled label. The sr-only live
* region below deliberately keeps its stable generic value. */
const intent = useToolCallIntent(args);
const preparationText = useToolPreparation();
/**
* One resolution, read by the label, the live region and the icon alike.
* It also unifies two inputs that had drifted apart: the cancellation
* inference read `initialProgress` while the label read the animated
* `rawProgress`.
*/
const phase = resolveToolCallPhase({
runStepStatus,
displayProgress: rawProgress,
reportedProgress: initialProgress,
isSubmitting,
hasError: typeof output === 'string' && isError(output),
});
const hasOutput = !!output && !isError(output);
const fileSources = useMemo(() => extractFileSources(attachments), [attachments]);
const parsedResults = useMemo(
() => (hasOutput && output ? parseRetrievalOutput(output) : []),
[hasOutput, output],
);
const fileIds = useMemo(
() => new Set(fileSources.map((s) => s.fileId).filter(Boolean)),
[fileSources],
);
const { data: availableFiles = [] } = useGetFiles<TFile[]>({
enabled: hasOutput && parsedResults.length > 0 && fileIds.size > 0,
select: (files) => files.filter((f) => fileIds.has(f.file_id)),
});
const displayResults = useMemo(
() => mergeRetrievalResults(fileSources, parsedResults, availableFiles),
[availableFiles, fileSources, parsedResults],
);
const hasResults = displayResults.length > 0;
const hasExpandableContent = phase !== 'failed' && hasResults;
const [expanded, setExpanded] = useToolExpansion(hasExpandableContent);
const showOutput = hasExpandableContent && expanded;
const { style: expandStyle, ref: expandRef } = useExpandCollapse(showOutput);
const [previewIndex, setPreviewIndex] = useState<number | null>(null);
const openPreview = useCallback((index: number) => {
setPreviewIndex(index);
}, []);
const closePreview = useCallback((open: boolean) => {
if (!open) {
setPreviewIndex(null);
}
}, []);
const previewData = useMemo(() => {
if (previewIndex === null) {
return null;
}
const result = displayResults[previewIndex];
if (!result?.fileId) {
return null;
}
return {
fileName: result.fileName,
fileId: result.fileId,
relevance: result.relevance,
pages: result.pages,
pageRelevance: result.pageRelevance,
fileType: result.fileType,
fileSource: result.fileSource,
};
}, [displayResults, previewIndex]);
const handleToggleOutput = useCallback(() => {
setExpanded(!showOutput);
if (!showOutput) {
onExpand?.();
}
}, [onExpand, setExpanded, showOutput]);
return (
<div>
<span className="sr-only" aria-live="polite" aria-atomic="true">
{(() => {
if (phase === 'running') {
return preparationText ?? localize('com_ui_searching_files');
}
if (phase === 'cancelled') {
return localize('com_ui_cancelled');
}
/** A terminal step that errored must not reach the live region as
* "retrieved files", which would tell a screen-reader user the
* opposite of what the card shows. */
if (phase === 'failed') {
return localize('com_ui_failed');
}
return intent ?? localize('com_ui_retrieved_files');
})()}
</span>
<div className="relative my-1 flex h-5 shrink-0 items-center gap-2.5">
<ProgressText
phase={phase}
onClick={hasExpandableContent ? handleToggleOutput : undefined}
inProgressText={intent ?? localize('com_ui_searching_files')}
/** A cancelled step must not read "Retrieved files" beside a
* cancellation icon while the live region says "Cancelled". */
finishedText={
phase === 'cancelled'
? localize('com_ui_cancelled')
: (intent ?? localize('com_ui_retrieved_files'))
}
durationMs={runStepDurationMs}
icon={<ToolIcon type="file_search" isAnimating={phase === 'running'} />}
hasInput={hasExpandableContent}
isExpanded={showOutput}
/>
</div>
<div style={expandStyle}>
<div className="overflow-hidden" ref={expandRef}>
{hasExpandableContent && (
<div className={cn(toolPanelSpacingClassName, 'flex flex-col gap-2')}>
{displayResults.map((item, i) => {
return (
<div
key={`${item.fileId ?? item.fileName}-${i}`}
className={cn(
'border-border-light bg-surface-secondary overflow-hidden rounded-lg border',
)}
>
<FileHeader
fileName={item.fileName}
relevance={item.relevance}
pages={item.pages}
pageRelevance={item.pageRelevance}
fileType={item.fileType}
onOpenPreview={item.fileId ? () => openPreview(i) : undefined}
/>
{item.content && (
<div className="border-border-inset border-t px-3 py-3">
<OutputRenderer text={item.content} />
</div>
)}
</div>
);
})}
</div>
)}
</div>
</div>
<FilePreviewDialog
open={previewData !== null}
onOpenChange={closePreview}
fileName={previewData?.fileName ?? ''}
fileId={previewData?.fileId}
relevance={previewData?.relevance}
pages={previewData?.pages}
pageRelevance={previewData?.pageRelevance}
fileType={previewData?.fileType}
fileSource={previewData?.fileSource}
/>
</div>
);
}