Skip to content

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

🌠 chore: Default OpenAI Image Tools to GPT Image Flare (#17014)

lia-by-librechat[bot]8363766ccbe1
diff --git a/.env.example b/.env.example
index adc737f30b..d326385ca3 100644
--- a/.env.example
+++ b/.env.example
@@ -686,7 +686,7 @@ AZURE_AI_SEARCH_SEARCH_OPTION_SELECT=
# IMAGE_GEN_OAI_API_KEY= # Create or reuse OpenAI API key for image generation tool
# IMAGE_GEN_OAI_BASEURL= # Custom OpenAI base URL for image generation tool
# IMAGE_GEN_OAI_AZURE_API_VERSION= # Custom Azure OpenAI deployments
-# IMAGE_GEN_OAI_MODEL=gpt-image-1 # OpenAI image model (e.g., gpt-image-1, gpt-image-1.5)
+# IMAGE_GEN_OAI_MODEL=gpt-image-2.5-flare # Override the image model or Azure deployment name
# IMAGE_GEN_OAI_DESCRIPTION=
# IMAGE_GEN_OAI_DESCRIPTION_WITH_FILES=Custom description for image generation tool when files are present
# IMAGE_GEN_OAI_DESCRIPTION_NO_FILES=Custom description for image generation tool when no files are present
diff --git a/api/app/clients/tools/structured/OpenAIImageTools.js b/api/app/clients/tools/structured/OpenAIImageTools.js
index d92d17b77e..b3a0a84300 100644
--- a/api/app/clients/tools/structured/OpenAIImageTools.js
+++ b/api/app/clients/tools/structured/OpenAIImageTools.js
@@ -82,7 +82,7 @@ function createOpenAIImageTools(fields = {}) {
let apiKey = fields.IMAGE_GEN_OAI_API_KEY ?? getApiKey();
const closureConfig = { apiKey };
- const imageModel = process.env.IMAGE_GEN_OAI_MODEL || 'gpt-image-1';
+ const imageModel = process.env.IMAGE_GEN_OAI_MODEL || 'gpt-image-2.5-flare';
let baseURL = 'https://api.openai.com/v1/';
if (!override && process.env.IMAGE_GEN_OAI_BASEURL) {
diff --git a/api/test/app/clients/tools/structured/OpenAIImageTools.test.js b/api/test/app/clients/tools/structured/OpenAIImageTools.test.js
index b83ed5335c..7a81865b88 100644
--- a/api/test/app/clients/tools/structured/OpenAIImageTools.test.js
+++ b/api/test/app/clients/tools/structured/OpenAIImageTools.test.js
@@ -1,6 +1,11 @@
+const axios = require('axios');
const OpenAI = require('openai');
+const FormData = require('form-data');
+const { Readable } = require('stream');
const createOpenAIImageTools = require('~/app/clients/tools/structured/OpenAIImageTools');
+const { getStrategyFunctions } = require('~/server/services/Files/strategies');
+jest.mock('axios');
jest.mock('openai');
jest.mock('@librechat/data-schemas', () => ({
logger: {
@@ -45,6 +50,16 @@ describe('OpenAIImageTools - IMAGE_GEN_OAI_MODEL environment variable', () => {
originalEnv = { ...process.env };
process.env.IMAGE_GEN_OAI_API_KEY = 'test-api-key';
+ delete process.env.IMAGE_GEN_OAI_MODEL;
+ delete process.env.IMAGE_GEN_OAI_BASEURL;
+ delete process.env.IMAGE_GEN_OAI_AZURE_API_VERSION;
+
+ axios.post.mockResolvedValue({
+ data: { data: [{ b64_json: 'base64-encoded-image-data' }] },
+ });
+ getStrategyFunctions.mockReturnValue({
+ getDownloadStream: jest.fn(async () => Readable.from([Buffer.from('image-data')])),
+ });
OpenAI.mockImplementation(() => ({
images: {
@@ -60,11 +75,30 @@ describe('OpenAIImageTools - IMAGE_GEN_OAI_MODEL environment variable', () => {
});
afterEach(() => {
+ jest.restoreAllMocks();
process.env = originalEnv;
});
- it('should use default model "gpt-image-1" when IMAGE_GEN_OAI_MODEL is not set', async () => {
- delete process.env.IMAGE_GEN_OAI_MODEL;
+ const createTools = () =>
+ createOpenAIImageTools({
+ isAgent: true,
+ override: false,
+ req: { user: { id: 'test-user' } },
+ imageFiles: [
+ {
+ file_id: 'source-image',
+ source: 'local',
+ filepath: 'source-image.png',
+ filename: 'source-image.png',
+ type: 'image/png',
+ },
+ ],
+ });
+
+ it.each([undefined, ''])('defaults generation when IMAGE_GEN_OAI_MODEL=%j', async (model) => {
+ if (model !== undefined) {
+ process.env.IMAGE_GEN_OAI_MODEL = model;
+ }
const [imageGenTool] = createOpenAIImageTools({
isAgent: true,
@@ -90,14 +124,50 @@ describe('OpenAIImageTools - IMAGE_GEN_OAI_MODEL environment variable', () => {
expect(mockGenerate).toHaveBeenCalledWith(
expect.objectContaining({
- model: 'gpt-image-1',
+ model: 'gpt-image-2.5-flare',
}),
expect.any(Object),
);
});
- it('should use "gpt-image-1.5" when IMAGE_GEN_OAI_MODEL is set to "gpt-image-1.5"', async () => {
- process.env.IMAGE_GEN_OAI_MODEL = 'gpt-image-1.5';
+ it.each(['gpt-image-1', 'gpt-image-1.5', 'gpt-image-2.5-flare', 'gpt-image-2.5-sunburst', ' '])(
+ 'should preserve the configured generation model %j',
+ async (model) => {
+ process.env.IMAGE_GEN_OAI_MODEL = model;
+
+ const mockGenerate = jest.fn().mockResolvedValue({
+ data: [
+ {
+ b64_json: 'base64-encoded-image-data',
+ },
+ ],
+ });
+
+ OpenAI.mockImplementation(() => ({
+ images: {
+ generate: mockGenerate,
+ },
+ }));
+
+ const [imageGenTool] = createOpenAIImageTools({
+ isAgent: true,
+ override: false,
+ req: { user: { id: 'test-user' } },
+ });
+
+ await imageGenTool.func({ prompt: 'test prompt' });
+
+ expect(mockGenerate).toHaveBeenCalledWith(
+ expect.objectContaining({
+ model,
+ }),
+ expect.any(Object),
+ );
+ },
+ );
+
+ it('should use custom model name from IMAGE_GEN_OAI_MODEL environment variable', async () => {
+ process.env.IMAGE_GEN_OAI_MODEL = 'custom-image-model';
const mockGenerate = jest.fn().mockResolvedValue({
data: [
@@ -123,42 +193,75 @@ describe('OpenAIImageTools - IMAGE_GEN_OAI_MODEL environment variable', () => {
expect(mockGenerate).toHaveBeenCalledWith(
expect.objectContaining({
- model: 'gpt-image-1.5',
+ model: 'custom-image-model',
}),
expect.any(Object),
);
});
- it('should use custom model name from IMAGE_GEN_OAI_MODEL environment variable', async () => {
- process.env.IMAGE_GEN_OAI_MODEL = 'custom-image-model';
+ it.each([
+ [undefined, 'gpt-image-2.5-flare'],
+ ['', 'gpt-image-2.5-flare'],
+ ['gpt-image-1', 'gpt-image-1'],
+ ['gpt-image-1.5', 'gpt-image-1.5'],
+ ['gpt-image-2.5-flare', 'gpt-image-2.5-flare'],
+ ['gpt-image-2.5-sunburst', 'gpt-image-2.5-sunburst'],
+ ['custom-image-model', 'custom-image-model'],
+ [' ', ' '],
+ ])('preserves the editing model for IMAGE_GEN_OAI_MODEL=%j', async (model, expectedModel) => {
+ if (model !== undefined) {
+ process.env.IMAGE_GEN_OAI_MODEL = model;
+ }
+ const append = jest.spyOn(FormData.prototype, 'append');
+ const [, imageEditTool] = createTools();
- const mockGenerate = jest.fn().mockResolvedValue({
- data: [
- {
- b64_json: 'base64-encoded-image-data',
- },
- ],
- });
+ await imageEditTool.func({ prompt: 'test prompt', image_ids: ['source-image'] });
- OpenAI.mockImplementation(() => ({
- images: {
- generate: mockGenerate,
- },
- }));
+ expect(append).toHaveBeenCalledWith('model', expectedModel);
+ expect(axios.post).toHaveBeenCalledWith(
+ '/images/edits',
+ expect.any(FormData),
+ expect.any(Object),
+ );
+ });
- const [imageGenTool] = createOpenAIImageTools({
- isAgent: true,
- override: false,
- req: { user: { id: 'test-user' } },
+ it('should preserve the configured Azure deployment for generation and editing', async () => {
+ const model = 'azure-image-deployment';
+ const baseURL = 'https://azure.test/openai/deployments/azure-image-deployment';
+ const apiVersion = '2025-04-01-preview';
+ process.env.IMAGE_GEN_OAI_MODEL = model;
+ process.env.IMAGE_GEN_OAI_BASEURL = baseURL;
+ process.env.IMAGE_GEN_OAI_AZURE_API_VERSION = apiVersion;
+
+ const mockGenerate = jest.fn().mockResolvedValue({
+ data: [{ b64_json: 'base64-encoded-image-data' }],
});
+ OpenAI.mockImplementation(() => ({ images: { generate: mockGenerate } }));
+ const append = jest.spyOn(FormData.prototype, 'append');
+ const [imageGenTool, imageEditTool] = createTools();
await imageGenTool.func({ prompt: 'test prompt' });
+ await imageEditTool.func({ prompt: 'test prompt', image_ids: ['source-image'] });
expect(mockGenerate).toHaveBeenCalledWith(
+ expect.objectContaining({ model }),
+ expect.any(Object),
+ );
+ expect(OpenAI).toHaveBeenCalledWith(
expect.objectContaining({
- model: 'custom-image-model',
+ baseURL,
+ defaultQuery: { 'api-version': apiVersion },
+ }),
+ );
+ expect(append).toHaveBeenCalledWith('model', model);
+ expect(axios.post).toHaveBeenCalledWith(
+ '/images/edits',
+ expect.any(FormData),
+ expect.objectContaining({
+ baseURL,
+ params: { 'api-version': apiVersion },
+ headers: expect.objectContaining({ 'api-key': 'test-api-key' }),
}),
- expect.any(Object),
);
});
});