feat(types): add ImageDetail as a public type alias#2901
Open
thakoreh wants to merge 1 commit intoopenai:mainfrom
Open
feat(types): add ImageDetail as a public type alias#2901thakoreh wants to merge 1 commit intoopenai:mainfrom
thakoreh wants to merge 1 commit intoopenai:mainfrom
Conversation
Add ImageDetail type alias following the same pattern as ReasoningEffort.
This allows users to import and use the type directly:
from openai.types import ImageDetail
cast(ImageDetail, image_quality.value if image_quality else 'high')
Previously users had to repeat the inline literal:
cast(Literal["low", "high", "auto"], image_quality.value)
Fixes openai#2889
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
1 participant
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.
Summary
Adds
ImageDetailas a named public type alias following the same pattern asReasoningEffort.This allows users to import and use the type directly:
Previously users had to repeat the inline literal:
Changes
src/openai/types/shared/image_detail.pywithImageDetail: TypeAlias = Optional[Literal["low", "high", "auto"]]src/openai/types/shared/__init__.pysrc/openai/types/__init__.pyfor direct importFixes #2889