Skip to content

docs: use the vision guide image in README example - #3849

Merged
marcuswood-oai merged 1 commit into
mainfrom
codex/fix-vision-readme-image
Sep 10, 2026
Merged

marcuswood-oai merged 1 commit into
mainfrom
codex/fix-vision-readme-image

Conversation

@marcuswood-oai

Copy link
Copy Markdown
Contributor

Summary

The README vision example points to a Wikimedia thumbnail URL that can fail during the API's image download. Replace it with the National Gallery of Art image already used in the OpenAI vision guide, preserving the current Responses API example and model.

Fixes #2776.

Image provenance

The image UUID a2e6da57-3cd1-4235-b20e-95dcaefed6c8 is listed with openaccess=1 in the National Gallery's official published-image catalog. The Gallery's open-access policy releases these images under CC0 for commercial and non-commercial use. The URL is hosted directly by the Gallery and matches the official OpenAI docs example.

Validation

  • Ran the exact updated README URL example against the live Responses API with SDK 3.13.0 and gpt-5.5: status completed, with a description of the seated woman in the portrait.
  • git diff --check passed.
  • Reviewed the full diff: one image URL replacement in README.md.

@marcuswood-oai
marcuswood-oai requested a review from a team as a code owner September 10, 2026 20:21
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 10, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-10T20:22:41.712321Z ca5a57a PR opened
🔒 Security Review ✅ Completed 2026-09-10T20:24:56.978024Z ca5a57a PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@openai-sdks

openai-sdks Bot commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

OkTest Summary

✅ 236/236 SDK tests passed in 10.362s for Python SDK PR #3849.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 191ms
tests/chat-completions-create.test.ts ✅ Passed 176ms
tests/chat-completions-stream.test.ts ✅ Passed 162ms
tests/files-content-binary.test.ts ✅ Passed 179ms
tests/files-create-multipart.test.ts ✅ Passed 162ms
tests/files-list-pagination.test.ts ✅ Passed 169ms
tests/initialize-config.test.ts ✅ Passed 204ms
tests/instance-isolation.test.ts ✅ Passed 170ms
tests/models-list.test.ts ✅ Passed 155ms
tests/responses-background-lifecycle.test.ts ✅ Passed 109ms
tests/responses-body-method-errors.test.ts ✅ Passed 219ms
tests/responses-cancel-timeout.test.ts ✅ Passed 219ms
tests/responses-cancel.test.ts ✅ Passed 160ms
tests/responses-compact-retries.test.ts ✅ Passed 208ms
tests/responses-compact.test.ts ✅ Passed 170ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 133ms
tests/responses-create-advanced.test.ts ✅ Passed 171ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.287s
tests/responses-create-errors.test.ts ✅ Passed 177ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 158ms
tests/responses-create-retries.test.ts ✅ Passed 502ms
tests/responses-create-stream-failures.test.ts ✅ Passed 472ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 201ms
tests/responses-create-stream-wire.test.ts ✅ Passed 3.212s
tests/responses-create-stream.test.ts ✅ Passed 98ms
tests/responses-create-terminal-states.test.ts ✅ Passed 165ms
tests/responses-create-timeout.test.ts ✅ Passed 211ms
tests/responses-create.test.ts ✅ Passed 155ms
tests/responses-delete.test.ts ✅ Passed 254ms
tests/responses-input-items-errors.test.ts ✅ Passed 364ms
tests/responses-input-items-list.test.ts ✅ Passed 402ms
tests/responses-input-items-options.test.ts ✅ Passed 356ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 199ms
tests/responses-input-tokens-count.test.ts ✅ Passed 163ms
tests/responses-malformed-inputs.test.ts ✅ Passed 2.343s
tests/responses-not-found-errors.test.ts ✅ Passed 145ms
tests/responses-parse.test.ts ✅ Passed 310ms
tests/responses-retrieve-retries.test.ts ✅ Passed 227ms
tests/responses-retrieve.test.ts ✅ Passed 131ms
tests/responses-stored-method-errors.test.ts ✅ Passed 563ms
tests/retry-behavior.test.ts ✅ Passed 3.027s
tests/sdk-error-shape.test.ts ✅ Passed 381ms

View OkTest run #34525904949

SDK merge (e2fe7af679eb) · head (ca5a57ab3d81) · base (7e31f8cb87f4) · OkTest (08ec4299e769)

@github-actions

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

43 mixed files remain; 0 existing customizations changed.

Compared 7e31f8cb87f4 → ca5a57ab3d81. Generated baselines verified.

43 existing customizations unchanged
  • api.md
  • scripts/castiron/README.md
  • scripts/castiron/custom_code_report.py
  • scripts/castiron/test_custom_code_report.py
  • src/openai/init.py
  • src/openai/_client.py
  • src/openai/resources/audio/transcriptions.py
  • src/openai/resources/audio/translations.py
  • src/openai/resources/beta/agents/sessions/sessions.py
  • src/openai/resources/beta/beta.py
  • src/openai/resources/beta/responses/responses.py
  • src/openai/resources/beta/threads/runs/runs.py
  • src/openai/resources/beta/threads/threads.py
  • src/openai/resources/chat/completions/completions.py
  • src/openai/resources/embeddings.py
  • src/openai/resources/files.py
  • src/openai/resources/live/forks.py
  • src/openai/resources/live/live.py
  • src/openai/resources/live/sideband.py
  • src/openai/resources/realtime/realtime.py
  • src/openai/resources/responses/responses.py
  • src/openai/resources/uploads/uploads.py
  • src/openai/resources/vector_stores/file_batches.py
  • src/openai/resources/vector_stores/files.py
  • src/openai/resources/videos.py
  • src/openai/resources/webhooks/init.py
  • src/openai/resources/webhooks/webhooks.py
  • src/openai/types/beta/agent_session_message.py
  • src/openai/types/chat/init.py
  • src/openai/types/chat/chat_completion_message_tool_call.py
  • src/openai/types/fine_tuning/fine_tuning_job_integration.py
  • src/openai/types/responses/init.py
  • src/openai/types/responses/response.py
  • src/openai/types/responses/response_function_web_search.py
  • src/openai/types/responses/response_function_web_search_param.py
  • src/openai/types/responses/responses_client_event.py
  • src/openai/types/responses/responses_client_event_param.py
  • src/openai/types/responses/tool.py
  • src/openai/types/responses/tool_param.py
  • src/openai/types/webhooks/init.py

3 more in the full report.

A changed generated baseline means this report cannot reliably identify which handwritten lines changed.

Inspect the custom-code diff

Download the exact patch produced by this run (requires repository access):

gh run download 34525997532 --repo openai/openai-python \
  --name castiron-custom-code-34525997532-1 --dir /tmp/castiron-custom-code-34525997532-1
git apply --stat /tmp/castiron-custom-code-34525997532-1/custom-code.patch
cat /tmp/castiron-custom-code-34525997532-1/custom-code.patch

Or reproduce it from an SDK checkout containing the vendored reporter:

git fetch --no-tags origin 7e31f8cb87f43568952bb53287e7478d76db9224 ca5a57ab3d81b228f9d79ba6f3d7aaff23b13e16
python3 scripts/castiron/custom_code_report.py report \
  --base 7e31f8cb87f43568952bb53287e7478d76db9224 \
  --head ca5a57ab3d81b228f9d79ba6f3d7aaff23b13e16 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-ca5a57ab3d81
cat /tmp/castiron-custom-code-ca5a57ab3d81/custom-code.patch

This is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR.

Full report and patch

@marcuswood-oai
marcuswood-oai merged commit 1ed8902 into main Sep 10, 2026
26 checks passed
@marcuswood-oai
marcuswood-oai deleted the codex/fix-vision-readme-image branch September 10, 2026 20:25
@openai-sdks openai-sdks Bot mentioned this pull request Sep 10, 2026
marcuswood-oai pushed a commit that referenced this pull request Sep 14, 2026
Automated Release PR
---


##
[3.14.0](v3.13.0...v3.14.0)
(2026-09-14)


### Features

* **streaming:** normalize errors raised while reading streams
([#3827](#3827))
([d7c41ef](d7c41ef))


### Bug Fixes

* bound vector store file polling
([#3401](#3401))
([ae41bc4](ae41bc4))
* **example:** refresh realtime push_to_talk_app session types
([#2926](#2926))
([0b7ad38](0b7ad38))
* **files:** normalize PathLike upload tuples
([#3475](#3475))
([90ac74c](90ac74c))
* include completion in content filter errors
([#3094](#3094))
([e57a1b1](e57a1b1))
* **logging:** support standard OPENAI_LOG levels
([#3734](#3734))
([44000e0](44000e0))
* normalize API error codes to strings
([#3532](#3532))
([233d955](233d955)),
closes [#3531](#3531)
* preserve response stream indexes after empty items
([#3126](#3126))
([8f84fbd](8f84fbd))
* **responses:** handle null text in output_text
([#3019](#3019))
([df6b72c](df6b72c))


### Documentation

* use the vision guide image in README example
([#3849](#3849))
([1ed8902](1ed8902))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: openai-sdks[bot] <284451331+openai-sdks[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Vision example throws an error

1 participant