Skip to content

fix(examples): refresh chat streaming examples - #2974

Merged
marcuswood-oai merged 2 commits into
openai:mainfrom
edenfunf:fix/update-outdated-examples
Sep 15, 2026
Merged

marcuswood-oai merged 2 commits into
openai:mainfrom
edenfunf:fix/update-outdated-examples

Conversation

@edenfunf

Copy link
Copy Markdown
Contributor

Summary

Several example scripts still reference poetry in their shebangs and use the legacy Completions API, which is no longer documented in the README. This PR brings them up to date:

  • Shebangs: demo.py, async_demo.py, streaming.py, and video.py all used #!/usr/bin/env -S poetry run python. The project migrated to Rye and other examples (e.g. audio.py, speech_to_text.py) already use rye run python. Updated the four remaining files for consistency.

  • Deprecated API: async_demo.py and streaming.py used the legacy Completions endpoint (client.completions.create with gpt-3.5-turbo-instruct). This endpoint isn't referenced in the README and gpt-3.5-turbo-instruct is one of the last models supporting it. Migrated both to the Chat Completions API (client.chat.completions.create).

  • Model name: demo.py referenced gpt-4. Updated to gpt-4o to reflect current recommended usage.

Changes

File Change
examples/demo.py shebang poetry → rye, model gpt-4 → gpt-4o
examples/async_demo.py shebang poetry → rye, completions.create → chat.completions.create
examples/streaming.py shebang poetry → rye, completions.create → chat.completions.create
examples/video.py shebang poetry → rye

Test plan

  • ruff check passes on all modified files
  • ruff format --check passes on all modified files
  • Existing streaming tests (tests/test_streaming.py) pass
  • import openai works correctly

- Replace `poetry run python` shebangs with `rye run python` to match
  the project's current tooling (demo.py, async_demo.py, streaming.py,
  video.py)
- Migrate async_demo.py and streaming.py from the legacy Completions API
  (`client.completions.create` with gpt-3.5-turbo-instruct) to the Chat
  Completions API (`client.chat.completions.create`)
- Update model references from gpt-4 to gpt-4o in demo.py
@edenfunf
edenfunf requested a review from a team as a code owner March 14, 2026 06:49
@marcuswood-oai marcuswood-oai changed the title fix(examples): update outdated shebangs and deprecated API usage fix(examples): refresh chat streaming examples Sep 15, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 15, 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-15T18:01:46.887471Z c910067 New commits
🔒 Security Review ✅ Completed 2026-09-15T18:03:26.970783Z c910067 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.

@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 1493321affb1 → c910067f1842. 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 35005415842 --repo openai/openai-python \
  --name castiron-custom-code-35005415842-1 --dir /tmp/castiron-custom-code-35005415842-1
git apply --stat /tmp/castiron-custom-code-35005415842-1/custom-code.patch
cat /tmp/castiron-custom-code-35005415842-1/custom-code.patch

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

git fetch --no-tags origin 1493321affb1814fba7b669892e376a119d8d36f c910067f18428a0f681181e16d40677ce9c99b0e
python3 scripts/castiron/custom_code_report.py report \
  --base 1493321affb1814fba7b669892e376a119d8d36f \
  --head c910067f18428a0f681181e16d40677ce9c99b0e --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-c910067f1842
cat /tmp/castiron-custom-code-c910067f1842/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

Copy link
Copy Markdown
Contributor

Thanks for updating the streaming examples. streaming.py still uses legacy Completions, and the async demo prints None for contentless deltas. The Chat Completions migration and empty-text handling modernize these examples; this is an example migration, not a runtime SDK fix.

@marcuswood-oai
marcuswood-oai added this pull request to the merge queue Sep 15, 2026
Merged via the queue into openai:main with commit 54f460e Sep 15, 2026
16 checks passed
@openai-sdks openai-sdks Bot mentioned this pull request Sep 15, 2026
pull Bot pushed a commit to Pyrex77/openai-python that referenced this pull request Sep 15, 2026
Automated Release PR
---


##
[3.14.1](openai/openai-python@v3.14.0...v3.14.1)
(2026-09-15)


### Bug Fixes

* **client:** validate retry limits and preserve application errors
([openai#3867](openai#3867))
([f86c721](openai@f86c721))
* correct typo "th" to "the" in StreamAlreadyConsumed error message
([openai#3022](openai#3022))
([7186203](openai@7186203))
* **examples:** correct Azure endpoint hostname
([openai#3298](openai#3298))
([543516c](openai@543516c))
* **examples:** refresh chat streaming examples
([openai#2974](openai#2974))
([54f460e](openai@54f460e))
* **examples:** split push-to-talk shebang arguments
([openai#3210](openai#3210))
([d241ed6](openai@d241ed6))
* **examples:** use uv in remaining Python launchers
([openai#3821](openai#3821))
([8c76c4f](openai@8c76c4f))
* log only metadata for Live WebSocket diagnostics
([openai#3865](openai#3865))
([ccc10f5](openai@ccc10f5))
* **responses:** skip structured parsing for commentary
([openai#3861](openai#3861))
([6520df1](openai@6520df1))


### Chores

* **examples:** bump module_client.py to gpt-5.6
([openai#3211](openai#3211))
([1493321](openai@1493321))
* remove unused fine-tuning data validators
([openai#3863](openai#3863))
([9640f29](openai@9640f29))


### Documentation

* clarify async client cleanup
([openai#2388](openai#2388))
([a3d83b5](openai@a3d83b5))
* clarify filenames for in-memory file uploads
([openai#3729](openai#3729))
([cb27380](openai@cb27380))
* **client:** correct retry jitter comment
([openai#2252](openai#2252))
([bdbbc16](openai@bdbbc16))
* fix Realtime docstring wording
([openai#3535](openai#3535))
([8cb9ded](openai@8cb9ded))
* fix reusing wording in Azure client docstrings
([openai#3061](openai#3061))
([dc625f9](openai@dc625f9))
* fix streaming comment typo
([openai#3005](openai#3005))
([d421d7a](openai@d421d7a))
* fix vector store polling helper paths
([openai#3101](openai#3101))
([2ef2de6](openai@2ef2de6))
* **readme:** correct SSE terminology
([openai#2837](openai#2837))
([caaa9b4](openai@caaa9b4))
* update Responses API reference link
([openai#3279](openai#3279))
([557bd06](openai@557bd06))
* **utils:** correct query component RFC reference
([openai#3300](openai#3300))
([929a8a5](openai@929a8a5))

---
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.

2 participants