docs: add image generation architecture guideline#480
Open
liyin2015 wants to merge 1 commit into
Open
Conversation
Comprehensive design doc covering: - Correct ModelClient → Generator → GeneratorOutput architecture - GeneratorOutput contract for images (b64_json/url dict format) - What each ModelClient must implement for IMAGE_GENERATION - Why ImageModelAdapter is redundant and migration path - OpenAI gpt-image-2 API reference (params, sizes, costs, gotchas) - Common bugs catalog (base64 leak, wrong field, format issues) - Testing checklist for new image providers Co-Authored-By: AdaL <adal@sylph.ai>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Image Generation Architecture Guideline
TL;DR: Adds a comprehensive design doc for the image generation pipeline, documenting the correct
ModelClient → Generator → GeneratorOutputarchitecture, theGeneratorOutputcontract for images, and provider-specific API references.What's in the doc
{"b64_json": ..., "mime_type": ...}or{"url": ...})IMAGE_GENERATION(convert_inputs, acall, parse_response)gpt-image-2parameter docs, flexible resolution constraints, size options, cost table, and behavioral gotchasdata, wrong dict format, base64 inraw_response, list unwrap) with before/after codeWhy this matters
The image generation pipeline had undocumented contracts that led to bugs (e.g., OpenAI client storing base64 in
GeneratorOutput.datainstead ofimages, causing base64 to leak into user-visible display). This doc captures the correct architecture so future provider integrations follow the right pattern.🌸 Generated with AdaL