docs: fix nested params example#3318
Open
nightcityblade wants to merge 1 commit into
Open
Conversation
nomiveritas
approved these changes
May 27, 2026
nomiveritas
approved these changes
May 29, 2026
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
2 participants
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
Fixes #3264.
Updates the README "Nested params" example to use the Responses API consistently:
client.responses.create(...)instead of the non-existentclient.chat.responses.create(...)text={"format": {"type": "json_object"}}for JSON output configurationAdditional context & links
Validation run locally:
pythoncompile check for the extracted README nested params exampleruff check /tmp/readme_nested_params.pyruff format --check /tmp/readme_nested_params.pyNote:
ruff format --check --preview README.mdreports the existing README would be reformatted outside this targeted change, so I validated the extracted Python snippet directly.