mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-09-22 08:12:00 +02:00

* 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>
128 lines
4.6 KiB
JavaScript
128 lines
4.6 KiB
JavaScript
const fs = require('fs');
|
|
const axios = require('axios');
|
|
const FormData = require('form-data');
|
|
const { logAxiosError } = require('@librechat/api');
|
|
const { logger } = require('@librechat/data-schemas');
|
|
const { FileSources } = require('librechat-data-provider');
|
|
const { generateShortLivedToken } = require('~/server/services/AuthService');
|
|
|
|
/**
|
|
* Deletes a file from the vector database. This function takes a file object, constructs the full path, and
|
|
* verifies the path's validity before deleting the file. If the path is invalid, an error is thrown.
|
|
*
|
|
* @param {ServerRequest} req - The request object from Express. It should have an `app.locals.paths` object with
|
|
* a `publicPath` property.
|
|
* @param {MongoFile} file - The file object to be deleted. It should have a `filepath` property that is
|
|
* a string representing the path of the file relative to the publicPath.
|
|
*
|
|
* @returns {Promise<void>}
|
|
* A promise that resolves when the file has been successfully deleted, or throws an error if the
|
|
* file path is invalid or if there is an error in deletion.
|
|
*/
|
|
const deleteVectors = async (req, file) => {
|
|
if (!file.embedded || !process.env.RAG_API_URL) {
|
|
return;
|
|
}
|
|
try {
|
|
const jwtToken = generateShortLivedToken(req.user.id);
|
|
|
|
return await axios.delete(`${process.env.RAG_API_URL}/documents`, {
|
|
headers: {
|
|
Authorization: `Bearer ${jwtToken}`,
|
|
'Content-Type': 'application/json',
|
|
accept: 'application/json',
|
|
},
|
|
data: [file.file_id],
|
|
});
|
|
} catch (error) {
|
|
logAxiosError({
|
|
error,
|
|
message: 'Error deleting vectors',
|
|
});
|
|
if (
|
|
error.response &&
|
|
error.response.status !== 404 &&
|
|
(error.response.status < 200 || error.response.status >= 300)
|
|
) {
|
|
logger.warn('Error deleting vectors, file will not be deleted');
|
|
throw new Error(error.message || 'An error occurred during file deletion.');
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Uploads a file to the configured Vector database
|
|
*
|
|
* @param {Object} params - The params object.
|
|
* @param {Object} params.req - The request object from Express. It should have a `user` property with an `id`
|
|
* representing the user, and an `app.locals.paths` object with an `uploads` path.
|
|
* @param {Express.Multer.File} params.file - The file object, which is part of the request. The file object should
|
|
* have a `path` property that points to the location of the uploaded file.
|
|
* @param {string} params.file_id - The file ID.
|
|
* @param {string} [params.entity_id] - The entity ID for shared resources.
|
|
* @param {Object} [params.storageMetadata] - Storage metadata for dual storage pattern.
|
|
*
|
|
* @returns {Promise<{ filepath: string, bytes: number }>}
|
|
* A promise that resolves to an object containing:
|
|
* - filepath: The path where the file is saved.
|
|
* - bytes: The size of the file in bytes.
|
|
*/
|
|
async function uploadVectors({ req, file, file_id, entity_id, storageMetadata }) {
|
|
if (!process.env.RAG_API_URL) {
|
|
throw new Error('RAG_API_URL not defined');
|
|
}
|
|
|
|
try {
|
|
const jwtToken = generateShortLivedToken(req.user.id);
|
|
const formData = new FormData();
|
|
formData.append('file_id', file_id);
|
|
formData.append('file', fs.createReadStream(file.path));
|
|
if (entity_id != null && entity_id) {
|
|
formData.append('entity_id', entity_id);
|
|
}
|
|
|
|
// Include storage metadata for RAG API to store with embeddings
|
|
if (storageMetadata) {
|
|
formData.append('storage_metadata', JSON.stringify(storageMetadata));
|
|
}
|
|
|
|
const formHeaders = formData.getHeaders();
|
|
|
|
const response = await axios.post(`${process.env.RAG_API_URL}/embed`, formData, {
|
|
headers: {
|
|
Authorization: `Bearer ${jwtToken}`,
|
|
accept: 'application/json',
|
|
...formHeaders,
|
|
},
|
|
});
|
|
|
|
const responseData = response.data;
|
|
logger.debug('Response from embedding file', responseData);
|
|
|
|
if (responseData.known_type === false) {
|
|
throw new Error(`File embedding failed. The filetype ${file.mimetype} is not supported`);
|
|
}
|
|
|
|
if (!responseData.status) {
|
|
throw new Error('File embedding failed.');
|
|
}
|
|
|
|
return {
|
|
bytes: file.size,
|
|
filename: file.originalname,
|
|
filepath: FileSources.vectordb,
|
|
embedded: Boolean(responseData.known_type),
|
|
};
|
|
} catch (error) {
|
|
logAxiosError({
|
|
error,
|
|
message: 'Error uploading vectors',
|
|
});
|
|
throw new Error(error.message || 'An error occurred during file upload.');
|
|
}
|
|
}
|
|
|
|
module.exports = {
|
|
deleteVectors,
|
|
uploadVectors,
|
|
};
|