fix(types): expand FunctionCallOutput.output to accept str or list#3122
Draft
anishesg wants to merge 1 commit intoopenai:mainfrom
Draft
fix(types): expand FunctionCallOutput.output to accept str or list#3122anishesg wants to merge 1 commit intoopenai:mainfrom
anishesg wants to merge 1 commit intoopenai:mainfrom
Conversation
- [ ] I understand that this repository is auto-generated and my pull request may not be merged Signed-off-by: anish k <ak8686@princeton.edu>
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.
Changes being requested
The
FunctionCallOutput.outputfield insrc/openai/types/responses/response_input_item.pywas typed asstronly, which is inconsistent with the OpenAI API documentation that specifies the field accepts either astringor alistof content objects. The root cause was an upstream OpenAPI spec gap (openai/openai-openapi#488), but the Python library needs to reflect the documented behavior. The field type has been updated toUnion[str, ResponseFunctionCallOutputItemList](i.e.str | list[ResponseInputTextContent | ResponseInputImageContent | ResponseInputFileContent]) to match the API docs. A regression test intests/test_models.pyverifies thatFunctionCallOutputcorrectly parses both string and list values foroutput.Additional context & links
Fixes #2668