mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-18 01:10:14 +01: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>
237 lines
6.2 KiB
JavaScript
237 lines
6.2 KiB
JavaScript
const { processAgentResponse } = require('../../../app/clients/agents/processAgentResponse');
|
|
const { Files } = require('../../../models');
|
|
const { getCustomConfig } = require('../../../server/services/Config/getCustomConfig');
|
|
|
|
// Mock dependencies
|
|
jest.mock('../../../models', () => ({
|
|
Files: {
|
|
find: jest.fn(),
|
|
},
|
|
}));
|
|
|
|
jest.mock('../../../server/services/Config/getCustomConfig', () => ({
|
|
getCustomConfig: jest.fn(),
|
|
}));
|
|
|
|
jest.mock('../../../config', () => ({
|
|
logger: {
|
|
warn: jest.fn(),
|
|
error: jest.fn(),
|
|
debug: jest.fn(),
|
|
},
|
|
}));
|
|
|
|
describe('processAgentResponse', () => {
|
|
beforeEach(() => {
|
|
jest.clearAllMocks();
|
|
});
|
|
|
|
it('should return response unchanged when no messageId', async () => {
|
|
const response = { messageId: null };
|
|
const result = await processAgentResponse(response, 'user123', 'conv123');
|
|
expect(result).toBe(response);
|
|
});
|
|
|
|
it('should return response unchanged when no file search results', async () => {
|
|
getCustomConfig.mockResolvedValue({ endpoints: { agents: { maxCitations: 10 } } });
|
|
|
|
const response = { messageId: 'msg123' };
|
|
const contentParts = [{ type: 'text', content: 'some text' }];
|
|
|
|
const result = await processAgentResponse(response, 'user123', 'conv123', contentParts);
|
|
expect(result).toBe(response);
|
|
});
|
|
|
|
it('should process file search results and create attachments', async () => {
|
|
getCustomConfig.mockResolvedValue({
|
|
endpoints: { agents: { maxCitations: 10 } },
|
|
fileStrategy: 's3',
|
|
});
|
|
|
|
Files.find.mockResolvedValue([
|
|
{
|
|
file_id: 'file123',
|
|
source: 's3',
|
|
filename: 'test.pdf',
|
|
},
|
|
]);
|
|
|
|
const response = { messageId: 'msg123' };
|
|
const contentParts = [
|
|
{
|
|
type: 'tool_call',
|
|
tool_call: {
|
|
name: 'file_search',
|
|
output: `File: test.pdf
|
|
File_ID: file123
|
|
Relevance: 0.8
|
|
Page: 1
|
|
Storage_Type: s3
|
|
S3_Bucket: test-bucket
|
|
S3_Key: uploads/user123/file123__test.pdf
|
|
Content: Test content`,
|
|
},
|
|
},
|
|
];
|
|
|
|
const result = await processAgentResponse(response, 'user123', 'conv123', contentParts);
|
|
|
|
expect(result.attachments).toBeDefined();
|
|
expect(result.attachments).toHaveLength(1);
|
|
expect(result.attachments[0].type).toBe('file_search');
|
|
expect(result.attachments[0].file_search.sources).toBeDefined();
|
|
expect(result.attachments[0].file_search.sources).toHaveLength(1);
|
|
|
|
const source = result.attachments[0].file_search.sources[0];
|
|
expect(source.fileId).toBe('file123');
|
|
expect(source.fileName).toBe('test.pdf');
|
|
expect(source.metadata.storageType).toBe('s3');
|
|
});
|
|
|
|
it('should use configured fileStrategy when file metadata is missing', async () => {
|
|
getCustomConfig.mockResolvedValue({
|
|
endpoints: { agents: { maxCitations: 10 } },
|
|
fileStrategy: 's3',
|
|
});
|
|
|
|
Files.find.mockResolvedValue([
|
|
{
|
|
file_id: 'file123',
|
|
// source is undefined, should fallback to fileStrategy
|
|
},
|
|
]);
|
|
|
|
const response = { messageId: 'msg123' };
|
|
const contentParts = [
|
|
{
|
|
type: 'tool_call',
|
|
tool_call: {
|
|
name: 'file_search',
|
|
output: `File: test.pdf
|
|
File_ID: file123
|
|
Relevance: 0.8
|
|
Content: Test content`,
|
|
},
|
|
},
|
|
];
|
|
|
|
const result = await processAgentResponse(response, 'user123', 'conv123', contentParts);
|
|
|
|
const source = result.attachments[0].file_search.sources[0];
|
|
expect(source.metadata.storageType).toBe('s3'); // Should use fileStrategy
|
|
});
|
|
|
|
it('should handle file diversity and allow multiple pages per file', async () => {
|
|
getCustomConfig.mockResolvedValue({
|
|
endpoints: { agents: { maxCitations: 5, maxCitationsPerFile: 3 } },
|
|
fileStrategy: 's3',
|
|
});
|
|
|
|
Files.find.mockResolvedValue([
|
|
{ file_id: 'file1', source: 'local', filename: 'test1.pdf' },
|
|
{ file_id: 'file2', source: 'local', filename: 'test2.pdf' },
|
|
]);
|
|
|
|
const response = { messageId: 'msg123' };
|
|
const contentParts = [
|
|
{
|
|
type: 'tool_call',
|
|
tool_call: {
|
|
name: 'file_search',
|
|
output: `File: test1.pdf
|
|
File_ID: file1
|
|
Relevance: 0.9
|
|
Page: 1
|
|
Content: High relevance content
|
|
|
|
---
|
|
|
|
File: test1.pdf
|
|
File_ID: file1
|
|
Relevance: 0.7
|
|
Page: 2
|
|
Content: Lower relevance content
|
|
|
|
---
|
|
|
|
File: test2.pdf
|
|
File_ID: file2
|
|
Relevance: 0.8
|
|
Page: 1
|
|
Content: Different file content`,
|
|
},
|
|
},
|
|
];
|
|
|
|
const result = await processAgentResponse(response, 'user123', 'conv123', contentParts);
|
|
|
|
const sources = result.attachments[0].file_search.sources;
|
|
expect(sources.length).toBeGreaterThanOrEqual(2); // Can include multiple pages per file now
|
|
|
|
// Should have both files represented
|
|
const fileIds = sources.map((s) => s.fileId);
|
|
expect(fileIds).toContain('file1');
|
|
expect(fileIds).toContain('file2');
|
|
|
|
// Should include multiple pages from file1 due to high relevance
|
|
const file1Sources = sources.filter((s) => s.fileId === 'file1');
|
|
expect(file1Sources.length).toBeGreaterThanOrEqual(1);
|
|
});
|
|
|
|
it('should respect maxCitationsPerFile configuration', async () => {
|
|
getCustomConfig.mockResolvedValue({
|
|
endpoints: { agents: { maxCitations: 10, maxCitationsPerFile: 2 } },
|
|
fileStrategy: 'local',
|
|
});
|
|
|
|
Files.find.mockResolvedValue([{ file_id: 'file1', source: 'local', filename: 'test1.pdf' }]);
|
|
|
|
const response = { messageId: 'msg123' };
|
|
const contentParts = [
|
|
{
|
|
type: 'tool_call',
|
|
tool_call: {
|
|
name: 'file_search',
|
|
output: `File: test1.pdf
|
|
File_ID: file1
|
|
Relevance: 0.9
|
|
Page: 1
|
|
Content: Page 1 content
|
|
|
|
---
|
|
|
|
File: test1.pdf
|
|
File_ID: file1
|
|
Relevance: 0.8
|
|
Page: 2
|
|
Content: Page 2 content
|
|
|
|
---
|
|
|
|
File: test1.pdf
|
|
File_ID: file1
|
|
Relevance: 0.7
|
|
Page: 3
|
|
Content: Page 3 content
|
|
|
|
---
|
|
|
|
File: test1.pdf
|
|
File_ID: file1
|
|
Relevance: 0.6
|
|
Page: 4
|
|
Content: Page 4 content`,
|
|
},
|
|
},
|
|
];
|
|
|
|
const result = await processAgentResponse(response, 'user123', 'conv123', contentParts);
|
|
|
|
const sources = result.attachments[0].file_search.sources;
|
|
expect(sources).toHaveLength(2); // Should be limited to maxCitationsPerFile (2)
|
|
|
|
// Should include the 2 highest relevance pages (0.9 and 0.8)
|
|
expect(sources[0].relevance).toBe(0.9);
|
|
expect(sources[1].relevance).toBe(0.8);
|
|
});
|
|
});
|