Skip to content

chore(api): document batch error responses - #3961

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

markstuart-oai merged 1 commit into
mainfrom
castiron/promotions/pr-156

Conversation

@markstuart-oai

Copy link
Copy Markdown
Contributor

Summary

Documents applicable Batch API errors while preserving Python exception behavior.

Changes

  • Describe invalid requests, missing batches, and cancellation conflicts.
  • Clarify applicable rate-limit and service-error responses.

Castiron-Internal-PR: openai/openai-python-internal#156
Castiron-Source-SHA: 3b108bd0cd7b4578b235997ee3fd78bda7c4a3a1
Castiron-Public-Base-SHA: a9d727f
@markstuart-oai
markstuart-oai marked this pull request as ready for review September 25, 2026 07:10
@markstuart-oai
markstuart-oai requested a review from a team as a code owner September 25, 2026 07:10
@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

47 mixed files remain; 0 existing customizations changed.

Compared a9d727ff9c4a → 5061dff1ce89. 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 36106330590 --repo openai/openai-python \
  --name castiron-custom-code-36106330590-1 --dir /tmp/castiron-custom-code-36106330590-1
git apply --stat /tmp/castiron-custom-code-36106330590-1/custom-code.patch
cat /tmp/castiron-custom-code-36106330590-1/custom-code.patch

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

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

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 25, 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-25T07:11:45.263281Z 5061dff Draft marked ready
🔒 Security Review ✅ Completed 2026-09-25T07:13:12.492276Z 5061dff Draft marked ready
ℹ️ 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 25, 2026 •

Copy link
Copy Markdown
Contributor

OkTest Summary

✅ 236/236 SDK tests passed in 11.754s for Python SDK PR #3961.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 289ms
tests/chat-completions-create.test.ts ✅ Passed 243ms
tests/chat-completions-stream.test.ts ✅ Passed 282ms
tests/files-content-binary.test.ts ✅ Passed 237ms
tests/files-create-multipart.test.ts ✅ Passed 208ms
tests/files-list-pagination.test.ts ✅ Passed 150ms
tests/initialize-config.test.ts ✅ Passed 220ms
tests/instance-isolation.test.ts ✅ Passed 237ms
tests/models-list.test.ts ✅ Passed 253ms
tests/responses-background-lifecycle.test.ts ✅ Passed 231ms
tests/responses-body-method-errors.test.ts ✅ Passed 348ms
tests/responses-cancel-timeout.test.ts ✅ Passed 216ms
tests/responses-cancel.test.ts ✅ Passed 256ms
tests/responses-compact-retries.test.ts ✅ Passed 360ms
tests/responses-compact.test.ts ✅ Passed 334ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 135ms
tests/responses-create-advanced.test.ts ✅ Passed 285ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.301s
tests/responses-create-errors.test.ts ✅ Passed 172ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 269ms
tests/responses-create-retries.test.ts ✅ Passed 242ms
tests/responses-create-stream-failures.test.ts ✅ Passed 814ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 223ms
tests/responses-create-stream-wire.test.ts ✅ Passed 3.309s
tests/responses-create-stream.test.ts ✅ Passed 202ms
tests/responses-create-terminal-states.test.ts ✅ Passed 250ms
tests/responses-create-timeout.test.ts ✅ Passed 226ms
tests/responses-create.test.ts ✅ Passed 569ms
tests/responses-delete.test.ts ✅ Passed 273ms
tests/responses-input-items-errors.test.ts ✅ Passed 585ms
tests/responses-input-items-list.test.ts ✅ Passed 363ms
tests/responses-input-items-options.test.ts ✅ Passed 279ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 250ms
tests/responses-input-tokens-count.test.ts ✅ Passed 206ms
tests/responses-malformed-inputs.test.ts ✅ Passed 2.407s
tests/responses-not-found-errors.test.ts ✅ Passed 305ms
tests/responses-parse.test.ts ✅ Passed 312ms
tests/responses-retrieve-retries.test.ts ✅ Passed 283ms
tests/responses-retrieve.test.ts ✅ Passed 229ms
tests/responses-stored-method-errors.test.ts ✅ Passed 673ms
tests/retry-behavior.test.ts ✅ Passed 3.174s
tests/sdk-error-shape.test.ts ✅ Passed 308ms

View OkTest run #36106305395

SDK merge (0d3da23b2807) · head (5061dff1ce89) · base (a9d727ff9c4a) · OkTest (bc2ef6ca05ab)

@markstuart-oai
markstuart-oai added this pull request to the merge queue Sep 25, 2026
Merged via the queue into main with commit 6e4a79c Sep 25, 2026
28 checks passed
@markstuart-oai
markstuart-oai deleted the castiron/promotions/pr-156 branch September 25, 2026 07:25
@openai-sdks openai-sdks Bot mentioned this pull request Sep 25, 2026
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