LibreChat/api/server/utils/files.js
Danny Avila 52e59e40be
📚 feat: Add Source Citations for File Search in Agents (#8652)
* feat: Source Citations for file_search in Agents

* Fix: Added citation limits and relevance score to app service. Removed duplicate tests

*  feat: implement Role-level toggle to optionally disable file Source Citation in Agents

* 🐛 fix: update mock for librechat-data-provider to include PermissionTypes and SystemRoles

---------

Co-authored-by: “Praneeth <praneeth.goparaju@slalom.com>
2025-08-13 16:24:16 -04:00

67 lines
2 KiB
JavaScript

const sharp = require('sharp');
/**
* Determines the file type of a buffer
* @param {Buffer} dataBuffer
* @param {boolean} [returnFileType=false] - Optional. If true, returns the file type instead of the file extension.
* @returns {Promise<string|null|import('file-type').FileTypeResult>} - Returns the file extension if found, else null
* */
const determineFileType = async (dataBuffer, returnFileType) => {
const fileType = await import('file-type');
const type = await fileType.fileTypeFromBuffer(dataBuffer);
if (returnFileType) {
return type;
}
return type ? type.ext : null; // Returns extension if found, else null
};
/**
* Get buffer metadata
* @param {Buffer} buffer
* @returns {Promise<{ bytes: number, type: string, dimensions: Record<string, number>, extension: string}>}
*/
const getBufferMetadata = async (buffer) => {
const fileType = await determineFileType(buffer, true);
const bytes = buffer.length;
let extension = fileType ? fileType.ext : 'unknown';
/** @type {Record<string, number>} */
let dimensions = {};
if (fileType && fileType.mime.startsWith('image/') && extension !== 'unknown') {
const imageMetadata = await sharp(buffer).metadata();
dimensions = {
width: imageMetadata.width,
height: imageMetadata.height,
};
}
return {
bytes,
type: fileType?.mime ?? 'unknown',
dimensions,
extension,
};
};
/**
* Removes UUID prefix from filename for clean display
* Pattern: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx__filename.ext
* @param {string} fileName - The filename to clean
* @returns {string} - The cleaned filename without UUID prefix
*/
const cleanFileName = (fileName) => {
if (!fileName) {
return fileName;
}
// Remove UUID pattern: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx__
const cleaned = fileName.replace(
/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}__/i,
'',
);
return cleaned;
};
module.exports = { determineFileType, getBufferMetadata, cleanFileName };