Repository navigation
🖼️ docs: Retire DALL-E 3 and Document the GPT Image Flare Default #834
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,8 +31,8 @@ Get image generation working in a few minutes with OpenAI Image Tools. | |
|
|
||
| ```bash filename=".env" | ||
| IMAGE_GEN_OAI_API_KEY=sk-your-openai-api-key | ||
| # Optional; defaults to gpt-image-2.5-flare | ||
| IMAGE_GEN_OAI_MODEL=gpt-image-2.5-flare | ||
| ``` | ||
|
|
||
| </Step> | ||
|
|
@@ -61,7 +61,7 @@ IMAGE_GEN_OAI_MODEL=gpt-image-1 | |
| - **Image Generation** creates brand-new images from text prompts (no upload required). | ||
| - **Image Editing** edits or remixes images you uploaded: change colors, add objects, extend the canvas, and more. | ||
|
|
||
| Both default to `gpt-image-2.5-flare`. Use `IMAGE_GEN_OAI_MODEL` to choose a different OpenAI image model when your deployment supports it. OpenAI retires `gpt-image-1` on October 23, 2026, so remove it from `IMAGE_GEN_OAI_MODEL` if you set it explicitly. See OpenAI's [Image Generation documentation](https://platform.openai.com/docs/guides/image-generation) for more details. | ||
|
berry-13 marked this conversation as resolved.
berry-13 marked this conversation as resolved.
|
||
|
|
||
| ### Generation vs. Editing | ||
|
|
||
|
|
@@ -86,35 +86,39 @@ Both tools are always available, and the agent chooses the appropriate one based | |
| **Image Generation** | ||
|
|
||
| - **prompt**: text description (required) | ||
| - **size**: `auto` (default), `1024x1024` (square), `1536x1024` (landscape), or `1024x1536` (portrait); models that support custom dimensions, such as `gpt-image-2.5-flare`, accept any `WIDTHxHEIGHT` within their limits, for example `2048x1152` or `3840x2160` | ||
|
There was a problem hiding this comment.
When a user requests the newly advertised Useful? React with 👍 / 👎.
Collaborator
Author
There was a problem hiding this comment. Fixed in 8a5e923. Confirmed on LibreChat dev: tool images are saved through saveBase64Image with fileConfig.imageGeneration defaulting to 'high', which caps the short edge at 768px (resize.js), so 3840x2160 is stored at 1365x768. A callout under Parameters now says so and links fileConfig.imageGeneration with percentage: 100 or a px cap; the image-gen-default-model-matches-code scenario asserts the text and follows the link to #imagegeneration. |
||
| - **quality**: `auto` (default), `high`, `medium`, or `low` | ||
| - **background**: `auto` (default), `transparent`, or `opaque` (transparent requires PNG or WebP format) | ||
|
|
||
| **Image Editing** | ||
|
|
||
| - **image_ids**: array of image IDs to use as reference for editing (required) | ||
| - **prompt**: text description of the changes (required) | ||
| - **size**: `auto` (default), `1024x1024`, `1536x1024`, or `1024x1536`; models that support custom dimensions accept any `WIDTHxHEIGHT` within their limits, for example `3840x2160` | ||
| - **quality**: `auto` (default), `high`, `medium`, or `low` | ||
|
|
||
| <Callout type="info" title="Keeping large sizes"> | ||
| By default, LibreChat resizes saved images so their shorter side is at most 768 pixels, so a `3840x2160` result is stored at 1365x768. To keep the requested size, set [`fileConfig.imageGeneration`](/docs/configuration/librechat_yaml/object_structure/file_config#imagegeneration) to `percentage: 100`, or to a `px` cap large enough for your sizes. | ||
| </Callout> | ||
|
|
||
| ### Setup | ||
|
|
||
| Create or reuse an OpenAI key and add it to `.env`, then add "OpenAI Image Tools" to your agent's **Tools** list: | ||
|
|
||
| ```bash filename=".env" | ||
| IMAGE_GEN_OAI_API_KEY=sk-... | ||
| # optional extras | ||
| IMAGE_GEN_OAI_MODEL=gpt-image-2.5-flare | ||
| IMAGE_GEN_OAI_BASEURL=https://... | ||
| ``` | ||
|
|
||
| For Azure OpenAI, deploy an image model in your Azure OpenAI resource, then add your credentials to `.env`. Set `IMAGE_GEN_OAI_MODEL` to the deployment name: | ||
|
|
||
| ```bash filename=".env" | ||
| IMAGE_GEN_OAI_API_KEY=your-api-key | ||
| # optional extras | ||
| IMAGE_GEN_OAI_MODEL=your-deployment-name | ||
| IMAGE_GEN_OAI_BASEURL=https://your-resource-name.openai.azure.com/openai/deployments/your-deployment-name/ | ||
| IMAGE_GEN_OAI_AZURE_API_VERSION=2025-04-01-preview | ||
| ``` | ||
|
|
||
|
|
@@ -124,7 +128,7 @@ Customize the tool descriptions and prompt guidance with these environment varia | |
|
|
||
| ```bash filename=".env" | ||
| # Image Model | ||
| IMAGE_GEN_OAI_MODEL=gpt-image-2.5-flare | ||
|
|
||
| # Image Generation Tool Descriptions | ||
| IMAGE_GEN_OAI_DESCRIPTION=... | ||
|
|
@@ -137,7 +141,7 @@ IMAGE_EDIT_OAI_PROMPT_DESCRIPTION=... | |
|
|
||
| ### Pricing | ||
|
|
||
| See OpenAI's [API pricing page](https://openai.com/api/pricing/) and [Image Generation documentation](https://platform.openai.com/docs/guides/image-generation) for image generation costs. | ||
|
|
||
| ## Gemini Image Tools | ||
|
|
||
|
|
@@ -191,46 +195,6 @@ GEMINI_IMAGE_IDS_DESCRIPTION=... | |
|
|
||
| More details are in the dedicated [Gemini Image Gen guide](/docs/configuration/tools/gemini_image_gen). | ||
|
|
||
| ## Stable Diffusion (local) | ||
|
|
||
| Run images entirely on your own machine or server. Point LibreChat at any Automatic1111 (or compatible) endpoint and you're set. | ||
|
|
@@ -371,7 +335,7 @@ If a tool encounters an error, it returns a message explaining what went wrong. | |
|
|
||
| ## Prompting | ||
|
|
||
| You can customize the prompts for [OpenAI Image Tools](#advanced-configuration), but the following tips inform the default prompts the tool supplies, which is useful to know for your own writing: | ||
|
|
||
| 1. Start with the **subject** and **style** (photo, oil painting, etc.). | ||
| 2. Add **composition** and **camera/medium** ("wide-angle shot of…", "watercolour…"). | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import { test, expect } from '@playwright/test' | ||
|
|
||
| test.describe('Image generation docs', () => { | ||
| test('@scenario:image-gen-page-has-no-dalle-setup no page documents the retired DALL-E tool', async ({ | ||
| page, | ||
| }) => { | ||
| await page.goto('/docs/features/image_gen') | ||
| const main = page.locator('main') | ||
| await expect(page.getByRole('heading', { level: 1 }).first()).toBeVisible() | ||
| await expect(main.getByRole('heading', { name: /dall/i })).toHaveCount(0) | ||
| await expect(main).not.toContainText(/DALLE_API_KEY|DALLE3_/) | ||
|
|
||
| await page.goto('/docs/configuration/librechat_yaml/ai_endpoints/azure') | ||
| const azure = page.locator('main') | ||
| await expect(azure.getByRole('heading', { name: /generate images with azure/i })).toBeVisible() | ||
| await expect(azure).not.toContainText(/DALL-?E/i) | ||
| await expect(azure).toContainText('IMAGE_GEN_OAI_BASEURL') | ||
| }) | ||
|
|
||
| test('@scenario:image-gen-default-model-matches-code the documented default is gpt-image-2.5-flare', async ({ | ||
| page, | ||
| }) => { | ||
| await page.goto('/docs/features/image_gen') | ||
| const main = page.locator('main') | ||
| await expect(main).toContainText('defaults to gpt-image-2.5-flare') | ||
| await expect(main).not.toContainText('IMAGE_GEN_OAI_MODEL=gpt-image-1') | ||
| await expect(main).not.toContainText(/defaults? to \**gpt-image-1/i) | ||
| await expect(main).toContainText('accept any WIDTHxHEIGHT') | ||
| await expect(main).toContainText('stored at 1365x768') | ||
| const resizeLink = main.getByRole('link', { name: 'fileConfig.imageGeneration' }) | ||
| await expect(resizeLink).toHaveAttribute('href', /file_config#imagegeneration$/) | ||
| await resizeLink.click() | ||
| await expect(page.locator('[id="imagegeneration"]')).toHaveCount(1) | ||
| }) | ||
|
|
||
| test('@scenario:tools-table-and-agent-lists-omit-dalle feature cards and tool lists omit DALL-E and image links resolve', async ({ | ||
| page, | ||
| }) => { | ||
| const anchors = new Set<string>() | ||
| for (const path of ['/docs/features', '/docs/configuration/tools', '/docs/features/agents']) { | ||
| await page.goto(path) | ||
| const main = page.locator('main') | ||
| await expect(page.getByRole('heading', { level: 1 }).first()).toBeVisible() | ||
| await expect(main).not.toContainText(/DALL-?E/i) | ||
| const hrefs = await main | ||
| .locator('a[href*="/docs/features/image_gen#"]') | ||
| .evaluateAll((links) => links.map((link) => link.getAttribute('href') ?? '')) | ||
| for (const href of hrefs) anchors.add(href.split('#')[1]) | ||
| } | ||
|
|
||
| expect(anchors.size).toBeGreaterThan(0) | ||
| await page.goto('/docs/features/image_gen') | ||
| for (const anchor of anchors) { | ||
| await expect(page.locator(`[id="${anchor}"]`)).toHaveCount(1) | ||
| } | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.