mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-11-18 22:14:27 +00:00
* 🖼️ fix: Apply an Agent's Configured Image Detail The Agent Builder exposes an Image Detail slider and saves it to `model_parameters.imageDetail`, but nothing ever read it back: `encodeAndFormat` resolves the level from `req.body.imageDetail`, which the agents route never populates, so every image was encoded as `detail: "auto"`. Providers that reject `auto` — MiniMax's OpenAI-compatible API among them — fail every image upload through an agent, and the setting that would fix it has no effect. The root cause is a classification error rather than a missing argument. `extractLibreChatParams` splits LibreChat's own settings out of an agent's model parameters, and its key set is derived from the `librechat` group in `parameterSettings`. `imageDetail` sat in `baseDefinitions` instead, so it was neither extracted for LibreChat's use nor stripped from the options handed to the provider. It is now grouped with `resendFiles` and the other LibreChat-level parameters, which gives it the same path those already take: extracted during agent initialization, carried on the initialized agent, passed to the client, and read by `encodeAndFormat`. `AgentClient.getSaveOptions` already expected `options.imageDetail` — nothing had ever populated it. The request body still wins where it is set, so the classic endpoints keep resolving detail from conversation settings exactly as before. Fixes #15359 * 🔤 fix: Type Image Detail as Its Enum, Not a Bare String `TConversation.imageDetail` is the `ImageDetail` enum, so the extractor's return type and the initialized agent's field are now declared as that enum rather than widened to `string`, and the tests pass enum members instead of raw literals. Caught by CI's type check, which I had run before adding the tests and not after — jest compiles the specs through babel, so the suite stayed green over a type error.
217 lines
6.7 KiB
TypeScript
217 lines
6.7 KiB
TypeScript
import { ImageDetail } from 'librechat-data-provider';
|
|
import { extractLibreChatParams } from './llm';
|
|
|
|
describe('extractLibreChatParams', () => {
|
|
it('should return defaults when options is undefined', () => {
|
|
const result = extractLibreChatParams(undefined);
|
|
|
|
expect(result.resendFiles).toBe(true);
|
|
expect(result.promptPrefix).toBeUndefined();
|
|
expect(result.maxContextTokens).toBeUndefined();
|
|
expect(result.fileTokenLimit).toBeUndefined();
|
|
expect(result.modelLabel).toBeUndefined();
|
|
expect(result.modelOptions).toEqual({});
|
|
});
|
|
|
|
it('should return defaults when options is null', () => {
|
|
const result = extractLibreChatParams();
|
|
|
|
expect(result.resendFiles).toBe(true);
|
|
expect(result.promptPrefix).toBeUndefined();
|
|
expect(result.maxContextTokens).toBeUndefined();
|
|
expect(result.fileTokenLimit).toBeUndefined();
|
|
expect(result.modelLabel).toBeUndefined();
|
|
expect(result.modelOptions).toEqual({});
|
|
});
|
|
|
|
it('should extract all LibreChat params and leave model options', () => {
|
|
const options = {
|
|
resendFiles: false,
|
|
promptPrefix: 'You are a helpful assistant',
|
|
maxContextTokens: 4096,
|
|
fileTokenLimit: 50000,
|
|
modelLabel: 'GPT-4',
|
|
imageDetail: ImageDetail.high,
|
|
model: 'gpt-4',
|
|
temperature: 0.7,
|
|
max_tokens: 1000,
|
|
};
|
|
|
|
const result = extractLibreChatParams(options);
|
|
|
|
expect(result.resendFiles).toBe(false);
|
|
expect(result.promptPrefix).toBe('You are a helpful assistant');
|
|
expect(result.maxContextTokens).toBe(4096);
|
|
expect(result.fileTokenLimit).toBe(50000);
|
|
expect(result.modelLabel).toBe('GPT-4');
|
|
expect(result.imageDetail).toBe(ImageDetail.high);
|
|
expect(result.modelOptions).toEqual({
|
|
model: 'gpt-4',
|
|
temperature: 0.7,
|
|
max_tokens: 1000,
|
|
});
|
|
});
|
|
|
|
it('should keep imageDetail out of the model options sent to the provider', () => {
|
|
const result = extractLibreChatParams({ model: 'gpt-4o', imageDetail: ImageDetail.low });
|
|
|
|
expect(result.imageDetail).toBe(ImageDetail.low);
|
|
expect(result.modelOptions).toEqual({ model: 'gpt-4o' });
|
|
expect('imageDetail' in result.modelOptions).toBe(false);
|
|
});
|
|
|
|
it('should leave imageDetail undefined when the agent configures none', () => {
|
|
const result = extractLibreChatParams({ model: 'gpt-4o' });
|
|
|
|
expect(result.imageDetail).toBeUndefined();
|
|
expect(result.modelOptions).toEqual({ model: 'gpt-4o' });
|
|
});
|
|
|
|
it('should handle null values for LibreChat params', () => {
|
|
const options = {
|
|
resendFiles: true,
|
|
promptPrefix: null,
|
|
maxContextTokens: 2048,
|
|
fileTokenLimit: undefined,
|
|
modelLabel: null,
|
|
model: 'claude-3',
|
|
};
|
|
|
|
const result = extractLibreChatParams(options);
|
|
|
|
expect(result.resendFiles).toBe(true);
|
|
expect(result.promptPrefix).toBeNull();
|
|
expect(result.maxContextTokens).toBe(2048);
|
|
expect(result.fileTokenLimit).toBeUndefined();
|
|
expect(result.modelLabel).toBeNull();
|
|
expect(result.modelOptions).toEqual({
|
|
model: 'claude-3',
|
|
});
|
|
});
|
|
|
|
it('should use default for resendFiles when not provided', () => {
|
|
const options = {
|
|
promptPrefix: 'Test prefix',
|
|
model: 'gpt-3.5-turbo',
|
|
temperature: 0.5,
|
|
};
|
|
|
|
const result = extractLibreChatParams(options);
|
|
|
|
expect(result.resendFiles).toBe(true); // Should use default
|
|
expect(result.promptPrefix).toBe('Test prefix');
|
|
expect(result.maxContextTokens).toBeUndefined();
|
|
expect(result.fileTokenLimit).toBeUndefined();
|
|
expect(result.modelLabel).toBeUndefined();
|
|
expect(result.modelOptions).toEqual({
|
|
model: 'gpt-3.5-turbo',
|
|
temperature: 0.5,
|
|
});
|
|
});
|
|
|
|
it('should handle empty options object', () => {
|
|
const result = extractLibreChatParams({});
|
|
|
|
expect(result.resendFiles).toBe(true); // Should use default
|
|
expect(result.promptPrefix).toBeUndefined();
|
|
expect(result.maxContextTokens).toBeUndefined();
|
|
expect(result.fileTokenLimit).toBeUndefined();
|
|
expect(result.modelLabel).toBeUndefined();
|
|
expect(result.modelOptions).toEqual({});
|
|
});
|
|
|
|
it('should only extract known LibreChat params', () => {
|
|
const options = {
|
|
resendFiles: false,
|
|
promptPrefix: 'Custom prompt',
|
|
maxContextTokens: 8192,
|
|
fileTokenLimit: 25000,
|
|
modelLabel: 'Custom Model',
|
|
// Model options
|
|
model: 'gpt-4',
|
|
temperature: 0.9,
|
|
top_p: 0.95,
|
|
frequency_penalty: 0.5,
|
|
presence_penalty: 0.5,
|
|
// Unknown params should stay in modelOptions
|
|
unknownParam: 'should remain',
|
|
customSetting: 123,
|
|
};
|
|
|
|
const result = extractLibreChatParams(options);
|
|
|
|
// LibreChat params extracted
|
|
expect(result.resendFiles).toBe(false);
|
|
expect(result.promptPrefix).toBe('Custom prompt');
|
|
expect(result.maxContextTokens).toBe(8192);
|
|
expect(result.fileTokenLimit).toBe(25000);
|
|
expect(result.modelLabel).toBe('Custom Model');
|
|
|
|
// Model options should include everything else
|
|
expect(result.modelOptions).toEqual({
|
|
model: 'gpt-4',
|
|
temperature: 0.9,
|
|
top_p: 0.95,
|
|
frequency_penalty: 0.5,
|
|
presence_penalty: 0.5,
|
|
unknownParam: 'should remain',
|
|
customSetting: 123,
|
|
});
|
|
});
|
|
|
|
it('should not mutate the original options object', () => {
|
|
const options = {
|
|
resendFiles: false,
|
|
promptPrefix: 'Test',
|
|
model: 'gpt-4',
|
|
temperature: 0.7,
|
|
};
|
|
const originalOptions = { ...options };
|
|
|
|
extractLibreChatParams(options);
|
|
|
|
// Original object should remain unchanged
|
|
expect(options).toEqual(originalOptions);
|
|
});
|
|
|
|
it('should handle undefined values for optional LibreChat params', () => {
|
|
const options = {
|
|
resendFiles: false,
|
|
promptPrefix: undefined,
|
|
maxContextTokens: undefined,
|
|
modelLabel: undefined,
|
|
model: 'claude-2',
|
|
};
|
|
|
|
const result = extractLibreChatParams(options);
|
|
|
|
expect(result.resendFiles).toBe(false);
|
|
expect(result.promptPrefix).toBeUndefined();
|
|
expect(result.maxContextTokens).toBeUndefined();
|
|
expect(result.modelLabel).toBeUndefined();
|
|
expect(result.modelOptions).toEqual({
|
|
model: 'claude-2',
|
|
});
|
|
});
|
|
|
|
it('should handle mixed null and undefined values', () => {
|
|
const options = {
|
|
promptPrefix: null,
|
|
maxContextTokens: undefined,
|
|
modelLabel: null,
|
|
model: 'gpt-3.5-turbo',
|
|
stop: ['\\n', '\\n\\n'],
|
|
};
|
|
|
|
const result = extractLibreChatParams(options);
|
|
|
|
expect(result.resendFiles).toBe(true); // default
|
|
expect(result.promptPrefix).toBeNull();
|
|
expect(result.maxContextTokens).toBeUndefined();
|
|
expect(result.modelLabel).toBeNull();
|
|
expect(result.modelOptions).toEqual({
|
|
model: 'gpt-3.5-turbo',
|
|
stop: ['\\n', '\\n\\n'],
|
|
});
|
|
});
|
|
});
|