docs: correct OpenAI vision request count - #117
Merged
kstonekuan merged 1 commit intoAug 23, 2026
Conversation
kstonekuan
approved these changes
Aug 23, 2026
kstonekuan
left a comment
Contributor
There was a problem hiding this comment.
LGTM. Merging.
Verified against the example: two checks, each with its own client.responses.create, fps=0.5 and max_tiles=12 unchanged, and OPENAI_ENDPOINT_ALIAS = "vision" so the snippet's uses="vision" stays truthful. Copying describe_activity's version string rather than hand_visibility's is the right one for that snippet. Lychee here matches your numbers: 260 links, 0 errors.
"caps each request at 12 tiles" instead of "the request" was not in the issue and is the more correct wording once there are two.
#107 is still sitting closed from the PR cap and can be reopened whenever.
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.
Summary
While reviewing the current OpenAI vision how-to against its runnable example, I found two documentation mismatches. This change:
version="responses-contact-sheet-v1"to the guide’s decorator;Why
The runnable example has two checks and each independently calls
client.responses.create. Describing that as one request per episode understates API usage, while omittingversion=conflicts with the guide’s advice to version external model configuration.Fixes #73.
Validation
git diff --check— passedlychee --no-progress --include-fragments ...command — 260 total links, 257 OK, 3 expected exclusions, 0 errorsChecklist