Skip to content

chore(api): clarify image fidelity and legacy image guidance - #3919

Open
markstuart-oai wants to merge 1 commit into
mainfrom
castiron/promotions/pr-124
Open

markstuart-oai wants to merge 1 commit into
mainfrom
castiron/promotions/pr-124

Conversation

@markstuart-oai

@markstuart-oai markstuart-oai commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Clarifies image fidelity guidance: the low default applies to supporting models, mini retains its low-only exception, and unsupported models require omission. Stable/beta image-tool help names both image-2 identifiers explicitly. Labels retired DALL·E settings and variations as legacy and directs callers toward supported image workflows with an explicit model choice.

No image request types, enum values, defaults, nullability or serialization change.

Validation: AST and snapshot comparisons confirm all Python changes are documentation-only. Existing focused import/event/credential/storage checks passed (32 tests); runtime and test code are unchanged.

@github-actions

github-actions Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

47 mixed files remain; 0 existing customizations changed; 2 generated baselines changed.

Compared 69a2c1db6fea11f6ecff0e76. Generated baselines verified.

File Result Current custom patch
src/openai/types/responses/tool.py Generated baseline changed +5 / −0
src/openai/types/responses/tool_param.py Generated baseline changed +9 / −0
45 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/api.md
  • 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/realtime/conversation_item_input_audio_transcription_delta_event.py
  • src/openai/types/realtime/realtime_error_event.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

5 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 35566134878 --repo openai/openai-python \
  --name castiron-custom-code-35566134878-1 --dir /tmp/castiron-custom-code-35566134878-1
git apply --stat /tmp/castiron-custom-code-35566134878-1/custom-code.patch
cat /tmp/castiron-custom-code-35566134878-1/custom-code.patch

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

git fetch --no-tags origin 69a2c1db6feacf32be6693809e7cab1c3b49cad7 11f6ecff0e76bd6d622bd81b3de8e88c160b4059
python3 scripts/castiron/custom_code_report.py report \
  --base 69a2c1db6feacf32be6693809e7cab1c3b49cad7 \
  --head 11f6ecff0e76bd6d622bd81b3de8e88c160b4059 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-11f6ecff0e76
cat /tmp/castiron-custom-code-11f6ecff0e76/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

@markstuart-oai
markstuart-oai marked this pull request as ready for review September 21, 2026 00:22
@markstuart-oai
markstuart-oai requested a review from a team as a code owner September 21, 2026 00:22
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 21, 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-21T05:53:39.831434Z 11f6ecf New commits
🔒 Security Review Completed 2026-09-21T05:54:24.229244Z 11f6ecf New commits
ℹ️ 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 21, 2026

Copy link
Copy Markdown
Contributor

OkTest Summary

236/236 SDK tests passed in 11.378s for Python SDK PR #3919.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 236ms
tests/chat-completions-create.test.ts ✅ Passed 248ms
tests/chat-completions-stream.test.ts ✅ Passed 264ms
tests/files-content-binary.test.ts ✅ Passed 254ms
tests/files-create-multipart.test.ts ✅ Passed 214ms
tests/files-list-pagination.test.ts ✅ Passed 159ms
tests/initialize-config.test.ts ✅ Passed 207ms
tests/instance-isolation.test.ts ✅ Passed 240ms
tests/models-list.test.ts ✅ Passed 264ms
tests/responses-background-lifecycle.test.ts ✅ Passed 244ms
tests/responses-body-method-errors.test.ts ✅ Passed 328ms
tests/responses-cancel-timeout.test.ts ✅ Passed 204ms
tests/responses-cancel.test.ts ✅ Passed 252ms
tests/responses-compact-retries.test.ts ✅ Passed 331ms
tests/responses-compact.test.ts ✅ Passed 378ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 136ms
tests/responses-create-advanced.test.ts ✅ Passed 212ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.189s
tests/responses-create-errors.test.ts ✅ Passed 181ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 210ms
tests/responses-create-retries.test.ts ✅ Passed 327ms
tests/responses-create-stream-failures.test.ts ✅ Passed 834ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 214ms
tests/responses-create-stream-wire.test.ts ✅ Passed 3.272s
tests/responses-create-stream.test.ts ✅ Passed 196ms
tests/responses-create-terminal-states.test.ts ✅ Passed 230ms
tests/responses-create-timeout.test.ts ✅ Passed 203ms
tests/responses-create.test.ts ✅ Passed 652ms
tests/responses-delete.test.ts ✅ Passed 236ms
tests/responses-input-items-errors.test.ts ✅ Passed 596ms
tests/responses-input-items-list.test.ts ✅ Passed 365ms
tests/responses-input-items-options.test.ts ✅ Passed 289ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 242ms
tests/responses-input-tokens-count.test.ts ✅ Passed 208ms
tests/responses-malformed-inputs.test.ts ✅ Passed 2.364s
tests/responses-not-found-errors.test.ts ✅ Passed 238ms
tests/responses-parse.test.ts ✅ Passed 233ms
tests/responses-retrieve-retries.test.ts ✅ Passed 321ms
tests/responses-retrieve.test.ts ✅ Passed 221ms
tests/responses-stored-method-errors.test.ts ✅ Passed 551ms
tests/retry-behavior.test.ts ✅ Passed 2.966s
tests/sdk-error-shape.test.ts ✅ Passed 278ms

View OkTest run #35566113466

SDK merge (9ab8044557c7) · head (11f6ecff0e76) · base (69a2c1db6fea) · OkTest (a0be4375e02d)

@markstuart-oai

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

🛡️ Codex Security Review · Automatically triggered

Security review completed. No security issues were found in this pull request.

Reviewed commit: e0a9c0d7ce

View security finding report

Only the user who started this review can view the report in Codex.

ℹ️ About Codex security reviews in GitHub

This is an experimental Codex feature. Security reviews are triggered when:

  • You comment "@codex security review"
  • A regular code review gets triggered (for example, "@codex review" or when a PR is opened), and you’re opted in so security review runs alongside code review

Once complete, Codex will leave suggestions, or a comment if no findings are found.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e0a9c0d7ce

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread api_reference/openapi.transformed.yml
Comment thread src/openai/types/responses/tool.py Outdated
@markstuart-oai
markstuart-oai force-pushed the castiron/promotions/pr-124 branch from e0a9c0d to 3b764ed Compare September 21, 2026 00:55
@markstuart-oai markstuart-oai changed the title chore(api): clarify image fidelity and edit guidance chore(api): clarify image fidelity and legacy image guidance Sep 21, 2026
@markstuart-oai
markstuart-oai force-pushed the castiron/promotions/pr-124 branch from 3b764ed to b3da684 Compare September 21, 2026 05:03
@markstuart-oai
markstuart-oai requested a review from a team September 21, 2026 05:10
Castiron-Internal-PR: openai/openai-python-internal#124
Castiron-Source-SHA: d84f221f4059cad13dcd92d937dd0570cecc8abc
Castiron-Public-Base-SHA: 69a2c1d
@markstuart-oai
markstuart-oai force-pushed the castiron/promotions/pr-124 branch from b3da684 to 11f6ecf Compare September 21, 2026 05:51
@markstuart-oai
markstuart-oai requested a review from a team September 21, 2026 05:58
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.

2 participants