Skip to content

release: 3.17.0 - #3904

Merged
marcuswood-oai merged 1 commit into
mainfrom
release-please--branches--main
Sep 22, 2026
Merged

marcuswood-oai merged 1 commit into
mainfrom
release-please--branches--main

Conversation

@openai-sdks

@openai-sdks openai-sdks Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Automated Release PR

3.17.0 (2026-09-22)

Features

  • api: add external storage configuration management (#3909) (6332577)
  • api: add safety case retrieval (#3911) (a87b938)
  • api: add safety warning and deactivation webhook events (#3908) (19f1f37)
  • api: add session environment reset events (#3913) (69a2c1d)
  • api: add SIP media security to incoming call events (#3907) (c377eb2)
  • api: support environment variable vault credentials (#3905) (eeebc53)

Bug Fixes

  • api: correct model types and network policy docs (618bb31)
  • api: preserve model choices and defer error response docs (#3931) (6e7a90f)
  • lib: treat null message content as empty in parse_response (#3851) (fab5283)
  • lib: use log.warning instead of the deprecated log.warn (#3878) (56b1708)

Chores

  • api: document API error response contracts (#3917) (fededc9)
  • api: document response management resources (#3912) (eaa5b77)
  • deps: bump actions/github-script from 7.1.0 to 9.0.0 (#3769) (32e07e1)
  • deps: bump actions/upload-artifact from 5.0.0 to 7.0.1 (#3767) (b413abe)
  • deps: bump CodeQL init and analyze to 4.37.8 (#3765) (f95237f)
  • deps: bump CodeQL init and analyze to 4.37.8 (#3766) (690a8b5)
  • deps: bump httpx2 from 2.7.0 to 2.12.0 in the python-security group across 1 directory (#3823) (9b8e399)
  • deps: bump openai/codex-action from 1.11 to 1.12 (#3768) (9c1579b)

This PR was generated with Release Please. See documentation.

@openai-sdks
openai-sdks Bot requested a review from a team as a code owner September 18, 2026 21:32
@openai-sdks

openai-sdks Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor Author

OkTest Summary

✅ 236/236 SDK tests passed in 8.114s for Python SDK PR #3904.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 137ms
tests/chat-completions-create.test.ts ✅ Passed 170ms
tests/chat-completions-stream.test.ts ✅ Passed 146ms
tests/files-content-binary.test.ts ✅ Passed 235ms
tests/files-create-multipart.test.ts ✅ Passed 120ms
tests/files-list-pagination.test.ts ✅ Passed 108ms
tests/initialize-config.test.ts ✅ Passed 119ms
tests/instance-isolation.test.ts ✅ Passed 170ms
tests/models-list.test.ts ✅ Passed 110ms
tests/responses-background-lifecycle.test.ts ✅ Passed 143ms
tests/responses-body-method-errors.test.ts ✅ Passed 255ms
tests/responses-cancel-timeout.test.ts ✅ Passed 202ms
tests/responses-cancel.test.ts ✅ Passed 140ms
tests/responses-compact-retries.test.ts ✅ Passed 199ms
tests/responses-compact.test.ts ✅ Passed 225ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 206ms
tests/responses-create-advanced.test.ts ✅ Passed 132ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.034s
tests/responses-create-errors.test.ts ✅ Passed 191ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 88ms
tests/responses-create-retries.test.ts ✅ Passed 377ms
tests/responses-create-stream-failures.test.ts ✅ Passed 98ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 198ms
tests/responses-create-stream-wire.test.ts ✅ Passed 2.223s
tests/responses-create-stream.test.ts ✅ Passed 108ms
tests/responses-create-terminal-states.test.ts ✅ Passed 150ms
tests/responses-create-timeout.test.ts ✅ Passed 196ms
tests/responses-create.test.ts ✅ Passed 200ms
tests/responses-delete.test.ts ✅ Passed 186ms
tests/responses-input-items-errors.test.ts ✅ Passed 293ms
tests/responses-input-items-list.test.ts ✅ Passed 216ms
tests/responses-input-items-options.test.ts ✅ Passed 222ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 232ms
tests/responses-input-tokens-count.test.ts ✅ Passed 142ms
tests/responses-malformed-inputs.test.ts ✅ Passed 1.564s
tests/responses-not-found-errors.test.ts ✅ Passed 229ms
tests/responses-parse.test.ts ✅ Passed 153ms
tests/responses-retrieve-retries.test.ts ✅ Passed 193ms
tests/responses-retrieve.test.ts ✅ Passed 151ms
tests/responses-stored-method-errors.test.ts ✅ Passed 400ms
tests/retry-behavior.test.ts ✅ Passed 3.119s
tests/sdk-error-shape.test.ts ✅ Passed 182ms

View OkTest run #35676922039

SDK merge (a21de7e727d8) · head (12011e3caf07) · base (6e7a90f18b92) · OkTest (a0be4375e02d)

@github-actions

github-actions Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

47 mixed files remain; 0 existing customizations changed.

Compared 6e7a90f18b92 → 12011e3caf07. Generated baselines verified.

47 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

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

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

git fetch --no-tags origin 6e7a90f18b92dcf320e94b1edf98187568ac6fbd 12011e3caf07085d6a1f0bd06127cf1e6deb2e04
python3 scripts/castiron/custom_code_report.py report \
  --base 6e7a90f18b92dcf320e94b1edf98187568ac6fbd \
  --head 12011e3caf07085d6a1f0bd06127cf1e6deb2e04 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-12011e3caf07
cat /tmp/castiron-custom-code-12011e3caf07/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

@openai-sdks
openai-sdks Bot force-pushed the release-please--branches--main branch from 619f13a to 47414c7 Compare September 18, 2026 22:05
@openai-sdks openai-sdks Bot changed the title release: 3.16.3 release: 4.0.0 Sep 19, 2026
@openai-sdks
openai-sdks Bot force-pushed the release-please--branches--main branch from 47414c7 to 427cc8b Compare September 19, 2026 01:25

@jbeckwith-oai jbeckwith-oai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

no no no

@openai-sdks openai-sdks Bot changed the title release: 4.0.0 release: 3.17.0 Sep 19, 2026
@openai-sdks
openai-sdks Bot force-pushed the release-please--branches--main branch 2 times, most recently from a472f94 to c07592d Compare September 19, 2026 05:17

@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: c07592d2a7

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread CHANGELOG.md

### Bug Fixes

* **api:** correct model types and network policy docs ([618bb31](https://github.com/openai/openai-python/commit/618bb312e52c2b62f75f56602b7388e6d023aa33))

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Disclose the breaking model-type removal

For users who passed the literal "gpt-5.1-mini" through typed Chat or Responses APIs, upgrading to 3.17.0 now causes type-checking failures because 618bb31 removes that value from the public ChatModel literals. That source commit explicitly marks the removal as an intentional breaking change, but this release note reduces it to an ordinary “correct model types” fix, so affected users receive no actionable upgrade warning. Add a breaking-changes entry that names the removed model choice.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The final release no longer removes this model literal. PR 3931 restored gpt-5.1-mini; I verified it is present in both public ChatModel aliases and the sync/async Responses model literals at release commit 8c72a700d900fb2578227df564a54462abfe67f8. Therefore a warning that 3.17.0 removes it would now be incorrect. This preserves typing compatibility and does not promise that the model is available.

@openai-sdks
openai-sdks Bot force-pushed the release-please--branches--main branch 2 times, most recently from ec23fed to c0321e3 Compare September 19, 2026 11:09

@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: c0321e38fb

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread pyproject.toml
[project]
name = "openai"
version = "3.16.2"
version = "3.17.0"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Publish the breaking type removal as a major release

This release includes 618bb31, whose fix(api)! commit explicitly declares an intentional breaking change and removes "gpt-5.1-mini" from the public ChatModel literals. Versioning it as 3.17.0 allows constraints such as openai>=3,<4 to install the incompatible API automatically, causing affected typed call sites to fail without opting into a major upgrade. Beyond documenting the removal in the changelog, bump the package, manifest, lockfile, and release heading to 4.0.0, or defer the breaking commit.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The breaking type removal was deferred rather than shipped. PR 3931 restored gpt-5.1-mini before the final 3.17.0 release; it is present in the public model aliases and Responses literals at 8c72a700d900fb2578227df564a54462abfe67f8. The final release head reviewed by the owners was 12011e3caf07085d6a1f0bd06127cf1e6deb2e04. A major bump is not needed for this now-absent removal, and I am not changing the published version or release metadata.

@openai-sdks
openai-sdks Bot force-pushed the release-please--branches--main branch 5 times, most recently from 6fb5c1e to 3033df9 Compare September 21, 2026 13:00
@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-21T16:57:22.213510Z b0daca1 New commits
🔒 Security Review ✅ Completed 2026-09-21T16:58:44.810659Z b0daca1 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 force-pushed the release-please--branches--main branch 5 times, most recently from 9a79569 to 5f3fceb Compare September 21, 2026 21:35
@openai-sdks
openai-sdks Bot force-pushed the release-please--branches--main branch from 5f3fceb to 12011e3 Compare September 22, 2026 01:45

@marcuswood-oai marcuswood-oai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewed the release diff and version metadata. The SDK update is merged; this PR contains the version bump and release notes. Approved for the coordinated SDK release.

@marcuswood-oai

Copy link
Copy Markdown
Contributor

@jbeckwith-oai admin merging through the request changes since this is not longer a major release

@marcuswood-oai
marcuswood-oai merged commit 8c72a70 into main Sep 22, 2026
26 checks passed
@marcuswood-oai
marcuswood-oai deleted the release-please--branches--main branch September 22, 2026 02:36
@openai-sdks

openai-sdks Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Created releases:

🌻

@markstuart-oai

Copy link
Copy Markdown
Contributor

@marcuswood-oai @jbeckwith-oai In response to the release disposition, the earlier change request, and the final review: the objection applied to an earlier head; the final owner-approved head is 12011e3caf07085d6a1f0bd06127cf1e6deb2e04. I verified the model literal was restored before the 3.17.0 merge, and replied to both inline versioning findings with that evidence.

The release workflow reports success. That is publication-workflow evidence, not a package download/install check performed by me. I am not dismissing any review, repeating an administrative merge, or modifying release metadata.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants