Skip to content

chore(api): document fine-tuning and model errors - #3964

Merged
markstuart-oai merged 1 commit into
mainfrom
castiron/promotions/pr-158
Sep 25, 2026
Merged

chore(api): document fine-tuning and model errors#3964
markstuart-oai merged 1 commit into
mainfrom
castiron/promotions/pr-158

Conversation

@markstuart-oai

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

Copy link
Copy Markdown
Contributor

Summary

Clarifies fine-tuning and model error responses while retaining existing Python behavior.

Changes

  • Describe applicable validation, lookup, permission and rate-limit errors.
  • Preserve existing methods, return types and exception behavior.

@markstuart-oai
chore(api): document fine-tuning and model errors
870ca7a 
Castiron-Internal-PR: openai/openai-python-internal#158
Castiron-Source-SHA: 7f5a8f0fa2b251188cc821787022cb31ceeac50d
Castiron-Public-Base-SHA: a73fe0c
@markstuart-oai
markstuart-oai marked this pull request as ready for review September 25, 2026 19:17
@markstuart-oai
markstuart-oai requested a review from a team as a code owner September 25, 2026 19:17
@github-actions

github-actions Bot commented Sep 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

47 mixed files remain; 0 existing customizations changed.

Compared a73fe0c3d404 → 870ca7a345b7. 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 36178793495 --repo openai/openai-python \
  --name castiron-custom-code-36178793495-1 --dir /tmp/castiron-custom-code-36178793495-1
git apply --stat /tmp/castiron-custom-code-36178793495-1/custom-code.patch
cat /tmp/castiron-custom-code-36178793495-1/custom-code.patch

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

git fetch --no-tags origin a73fe0c3d404335a342d1251bd32709b8e3d76f2 870ca7a345b7dcd9b3cabc5052cebe7c0274eac1
python3 scripts/castiron/custom_code_report.py report \
  --base a73fe0c3d404335a342d1251bd32709b8e3d76f2 \
  --head 870ca7a345b7dcd9b3cabc5052cebe7c0274eac1 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-870ca7a345b7
cat /tmp/castiron-custom-code-870ca7a345b7/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 commented Sep 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

OkTest Summary

✅ 236/236 SDK tests passed in 8.901s for Python SDK PR #3964.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 193ms
tests/chat-completions-create.test.ts ✅ Passed 152ms
tests/chat-completions-stream.test.ts ✅ Passed 115ms
tests/files-content-binary.test.ts ✅ Passed 159ms
tests/files-create-multipart.test.ts ✅ Passed 160ms
tests/files-list-pagination.test.ts ✅ Passed 134ms
tests/initialize-config.test.ts ✅ Passed 118ms
tests/instance-isolation.test.ts ✅ Passed 122ms
tests/models-list.test.ts ✅ Passed 156ms
tests/responses-background-lifecycle.test.ts ✅ Passed 151ms
tests/responses-body-method-errors.test.ts ✅ Passed 290ms
tests/responses-cancel-timeout.test.ts ✅ Passed 164ms
tests/responses-cancel.test.ts ✅ Passed 165ms
tests/responses-compact-retries.test.ts ✅ Passed 240ms
tests/responses-compact.test.ts ✅ Passed 189ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 327ms
tests/responses-create-advanced.test.ts ✅ Passed 168ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.173s
tests/responses-create-errors.test.ts ✅ Passed 134ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 321ms
tests/responses-create-retries.test.ts ✅ Passed 153ms
tests/responses-create-stream-failures.test.ts ✅ Passed 119ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 221ms
tests/responses-create-stream-wire.test.ts ✅ Passed 2.638s
tests/responses-create-stream.test.ts ✅ Passed 67ms
tests/responses-create-terminal-states.test.ts ✅ Passed 190ms
tests/responses-create-timeout.test.ts ✅ Passed 167ms
tests/responses-create.test.ts ✅ Passed 244ms
tests/responses-delete.test.ts ✅ Passed 134ms
tests/responses-input-items-errors.test.ts ✅ Passed 297ms
tests/responses-input-items-list.test.ts ✅ Passed 266ms
tests/responses-input-items-options.test.ts ✅ Passed 213ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 185ms
tests/responses-input-tokens-count.test.ts ✅ Passed 184ms
tests/responses-malformed-inputs.test.ts ✅ Passed 1.845s
tests/responses-not-found-errors.test.ts ✅ Passed 199ms
tests/responses-parse.test.ts ✅ Passed 259ms
tests/responses-retrieve-retries.test.ts ✅ Passed 169ms
tests/responses-retrieve.test.ts ✅ Passed 132ms
tests/responses-stored-method-errors.test.ts ✅ Passed 451ms
tests/retry-behavior.test.ts ✅ Passed 3.074s
tests/sdk-error-shape.test.ts ✅ Passed 294ms

View OkTest run #36178748225

SDK merge (6d3f08fe2526) · head (870ca7a345b7) · base (a73fe0c3d404) · OkTest (f9111d4e2fcd)

jbeckwith-oai
jbeckwith-oai approved these changes Sep 25, 2026
View reviewed changes

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

Reviewed 870ca7a. No findings.

Parsed the complete immutable base/head API-reference YAML with duplicate-key rejection. The only semantic changes are 38 added error responses across 16 fine-tuning/grader/model operations; removing those additions makes the parsed document identical to the base. Every new ErrorResponse/PermissionErrorResponse reference resolves. The transformed-spec MD5 matches .castiron.stats.yml, whose changes are limited to the five generation/provenance fields.

The complete two-file diff leaves runtime code, methods, public types, existing success responses, parameters, schemas, exception handling, dependencies, and workflow/budget policy unchanged.

Exact-head repository CI is green, including baseline consistency, compatibility/breaking-change checks, build, lint, and applicable runtime tests. The successful OkTest run 36178748225 is pinned to this SDK head/base and reports 236/236 cases passing.

Validation here was source review and full-YAML semantic/reference/hash checks; I did not rerun the SDK suite locally or make live API calls.

@markstuart-oai ChatGPT Codex Connector

markstuart-oai commented Sep 25, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the exact-head review and the independent YAML, reference, and checksum checks. The reviewed head 870ca7a is unchanged. This remains a documentation/metadata-only update: existing APIs and error behavior are preserved, with no user-code migration required. CI and the 236-case downstream suite are green; no further change is needed for this review.

@markstuart-oai
markstuart-oai added this pull request to the merge queue Sep 25, 2026
Merged via the queue into main with commit 5d4003c Sep 25, 2026
28 checks passed
@markstuart-oai
markstuart-oai deleted the castiron/promotions/pr-158 branch September 25, 2026 19:39
@openai-sdks openai-sdks Bot mentioned this pull request Sep 25, 2026
Merged
pull Bot pushed a commit to pdibenedetto/openai-python that referenced this pull request Sep 28, 2026
@openai-sdks
release: 3.20.0 (openai#3957)
68b173a 
Automated Release PR
---


##
[3.20.0](openai/openai-python@v3.19.2...v3.20.0)
(2026-09-28)


### Features

* **api:** add Agents credential and session options
([openai#3967](openai#3967))
([bb68198](openai@bb68198))
* **api:** add Cyber access programs to Responses
([openai#3956](openai#3956))
([09c5b6f](openai@09c5b6f))
* **responses:** opt in to incremental WebSocket text and tool snapshots
([openai#3973](openai#3973))
([d0207b4](openai@d0207b4))
* **responses:** preserve detailed WebSocket accumulator snapshots
([openai#3981](openai#3981))
([a380cf2](openai@a380cf2))


### Bug Fixes

* **client:** retry unmapped TLS transport errors
([openai#3982](openai#3982))
([0d35a26](openai@0d35a26))
* **live:** avoid hangs at fractional transcript grouping deadlines
([openai#3970](openai#3970))
([4ef4129](openai@4ef4129))
* **live:** keep query parameters out of WebSocket endpoint paths
([openai#3972](openai#3972))
([f9c458b](openai@f9c458b))
* **live:** preserve caller queues and prevent uncertain WebSocket
replay ([openai#3980](openai#3980))
([80e9686](openai@80e9686))
* **realtime:** preserve base URL queries in WebSocket upgrades
([openai#3971](openai#3971))
([f7bd4a7](openai@f7bd4a7))
* **realtime:** retain configured queues without replaying attempted
sends ([openai#3978](openai#3978))
([a52805c](openai@a52805c))


### Chores

* **api:** clarify documented API error responses
([openai#3965](openai#3965))
([384fee3](openai@384fee3))
* **api:** document batch error responses
([openai#3961](openai#3961))
([6e4a79c](openai@6e4a79c))
* **api:** document files and uploads error responses
([openai#3960](openai#3960))
([a9d727f](openai@a9d727f))
* **api:** document fine-tuning and model errors
([openai#3964](openai#3964))
([5d4003c](openai@5d4003c))
* **api:** document Responses not-found errors
([openai#3959](openai#3959))
([63099e7](openai@63099e7))
* **api:** document stored chat completion errors
([openai#3963](openai#3963))
([a73fe0c](openai@a73fe0c))

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

Reviewers

@jbeckwith-oai jbeckwith-oai jbeckwith-oai approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@markstuart-oai @jbeckwith-oai