Skip to content

types: add gpt-image-2 image model alias #3127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nightcityblade wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −3
Open

types: add gpt-image-2 image model alias #3127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/openai/types/image_generate_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ class ImageGenerateParamsBase(TypedDict, total=False):
model: Union[str, ImageModel, None]
"""The model to use for image generation.

One of `dall-e-2`, `dall-e-3`, or a GPT image model (`gpt-image-1`,
`gpt-image-1-mini`, `gpt-image-1.5`). Defaults to `dall-e-2` unless a parameter
One of `dall-e-2`, `dall-e-3`, or a GPT image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`). Defaults to `dall-e-2` unless a parameter
specific to the GPT image models is used.
"""

Expand Down
2 changes: 1 addition & 1 deletion src/openai/types/image_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

__all__ = ["ImageModel"]

ImageModel: TypeAlias = Literal["gpt-image-1.5", "dall-e-2", "dall-e-3", "gpt-image-1", "gpt-image-1-mini"]
ImageModel: TypeAlias = Literal["gpt-image-1.5", "gpt-image-2", "dall-e-2", "dall-e-3", "gpt-image-1", "gpt-image-1-mini"]
7 changes: 7 additions & 0 deletions tests/test_image_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from typing import get_args

from openai.types import ImageModel


def test_image_model_includes_gpt_image_2() -> None:
assert "gpt-image-2" in get_args(ImageModel)