Skip to content

chore(api): clarify Realtime modality array definitions - #756

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

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

Conversation

@markstuart-oai

Copy link
Copy Markdown
Contributor

Summary

Clarifies retained Realtime modality arrays in the API reference without changing SDK types or method signatures.

Changes

  • Explicitly describe retained Realtime modality fields as arrays of text or audio values.
  • Preserve existing optionality and SDK behavior.

Castiron-Internal-PR: openai/openai-ruby-internal#150
Castiron-Source-SHA: 93648825b83b6dd5a4b0f207643d01f01ccd83ab
Castiron-Public-Base-SHA: f83af03
@markstuart-oai
markstuart-oai marked this pull request as ready for review September 23, 2026 23:31
@markstuart-oai
markstuart-oai requested a review from a team as a code owner September 23, 2026 23:31
@github-actions

github-actions Bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

70 mixed files remain; 0 existing customizations changed.

Compared f83af03a667a → 0d1896388e55. Generated baselines verified.

70 existing customizations unchanged
  • lib/openai.rb
  • lib/openai/client.rb
  • lib/openai/models/audio/transcription_create_response.rb
  • lib/openai/models/beta/agents/vault_status_filter.rb
  • lib/openai/models/chat/chat_completion_message.rb
  • lib/openai/models/chat/chat_completion_message_function_tool_call.rb
  • lib/openai/models/chat/completion_create_params.rb
  • lib/openai/models/image_edit_completed_event.rb
  • lib/openai/models/image_edit_partial_image_event.rb
  • lib/openai/models/image_gen_completed_event.rb
  • lib/openai/models/image_gen_partial_image_event.rb
  • lib/openai/models/images_response.rb
  • lib/openai/models/response_format_json_schema.rb
  • lib/openai/models/responses/function_tool.rb
  • lib/openai/models/responses/response.rb
  • lib/openai/models/responses/response_create_params.rb
  • lib/openai/models/responses/response_format_text_config.rb
  • lib/openai/models/responses/response_format_text_json_schema_config.rb
  • lib/openai/models/responses/response_function_tool_call.rb
  • lib/openai/models/responses/response_function_web_search.rb
  • lib/openai/models/responses/response_output_text.rb
  • lib/openai/models/responses/tool.rb
  • lib/openai/models/webhooks/webhook_endpoint_with_secret.rb
  • lib/openai/resources/beta/agents/sessions.rb
  • lib/openai/resources/beta/threads.rb
  • lib/openai/resources/chat/completions.rb
  • lib/openai/resources/containers/files.rb
  • lib/openai/resources/files.rb
  • lib/openai/resources/responses.rb
  • lib/openai/resources/vector_stores/file_batches.rb
  • lib/openai/resources/vector_stores/files.rb
  • lib/openai/resources/webhooks.rb
  • rbi/openai/client.rbi
  • rbi/openai/models/beta/agents/vault_status_filter.rbi
  • rbi/openai/models/chat/chat_completion_message.rbi
  • rbi/openai/models/chat/chat_completion_message_function_tool_call.rbi
  • rbi/openai/models/chat/completion_create_params.rbi
  • rbi/openai/models/image_edit_completed_event.rbi
  • rbi/openai/models/image_edit_partial_image_event.rbi
  • rbi/openai/models/image_gen_completed_event.rbi

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

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

git fetch --no-tags origin f83af03a667a7045dde39d2a9ca328432e3d109b 0d1896388e55679a8f4e71a381b88c8dd286b4df
python3 scripts/castiron/custom_code_report.py report \
  --base f83af03a667a7045dde39d2a9ca328432e3d109b \
  --head 0d1896388e55679a8f4e71a381b88c8dd286b4df --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-0d1896388e55
cat /tmp/castiron-custom-code-0d1896388e55/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 23, 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-23T23:32:54.449611Z 0d18963 Draft marked ready
🔒 Security Review ✅ Completed 2026-09-23T23:33:17.265207Z 0d18963 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 23, 2026 •

Copy link
Copy Markdown
Contributor

OkTest Summary

✅ 236/236 SDK tests passed in 5.937s for Ruby SDK PR #756.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 103ms
tests/chat-completions-create.test.ts ✅ Passed 128ms
tests/chat-completions-stream.test.ts ✅ Passed 102ms
tests/files-content-binary.test.ts ✅ Passed 137ms
tests/files-create-multipart.test.ts ✅ Passed 139ms
tests/files-list-pagination.test.ts ✅ Passed 118ms
tests/initialize-config.test.ts ✅ Passed 60ms
tests/instance-isolation.test.ts ✅ Passed 81ms
tests/models-list.test.ts ✅ Passed 104ms
tests/responses-background-lifecycle.test.ts ✅ Passed 78ms
tests/responses-body-method-errors.test.ts ✅ Passed 255ms
tests/responses-cancel-timeout.test.ts ✅ Passed 160ms
tests/responses-cancel.test.ts ✅ Passed 91ms
tests/responses-compact-retries.test.ts ✅ Passed 107ms
tests/responses-compact.test.ts ✅ Passed 103ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 123ms
tests/responses-create-advanced.test.ts ✅ Passed 58ms
tests/responses-create-disconnect.test.ts ✅ Passed 91ms
tests/responses-create-errors.test.ts ✅ Passed 191ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 104ms
tests/responses-create-retries.test.ts ✅ Passed 104ms
tests/responses-create-stream-failures.test.ts ✅ Passed 108ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 177ms
tests/responses-create-stream-wire.test.ts ✅ Passed 1.226s
tests/responses-create-stream.test.ts ✅ Passed 47ms
tests/responses-create-terminal-states.test.ts ✅ Passed 147ms
tests/responses-create-timeout.test.ts ✅ Passed 161ms
tests/responses-create.test.ts ✅ Passed 94ms
tests/responses-delete.test.ts ✅ Passed 97ms
tests/responses-input-items-errors.test.ts ✅ Passed 118ms
tests/responses-input-items-list.test.ts ✅ Passed 107ms
tests/responses-input-items-options.test.ts ✅ Passed 86ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 199ms
tests/responses-input-tokens-count.test.ts ✅ Passed 79ms
tests/responses-malformed-inputs.test.ts ✅ Passed 1.364s
tests/responses-not-found-errors.test.ts ✅ Passed 183ms
tests/responses-parse.test.ts ✅ Passed 59ms
tests/responses-retrieve-retries.test.ts ✅ Passed 96ms
tests/responses-retrieve.test.ts ✅ Passed 95ms
tests/responses-stored-method-errors.test.ts ✅ Passed 307ms
tests/retry-behavior.test.ts ✅ Passed 3.252s
tests/sdk-error-shape.test.ts ✅ Passed 280ms

View OkTest run #35934010165

SDK merge (2a6166f16085) · head (0d1896388e55) · base (f83af03a667a) · OkTest (8b736c2879a9)

@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 the complete diff from f83af03 to 0d18963. No blocking findings.

The only schema changes add type: array to RealtimeSession.modalities and RealtimeSessionCreateRequest.modalities. Item enums and optionality are preserved; no SDK source, exported types, signatures, or runtime implementation changed.

Validation: parsed the full pinned base/head schemas and confirmed exactly those two key additions; verified the transformed-schema hash against generation metadata; 20 independent positive/negative JSON Schema checks passed. The separate transcription-session schema is unchanged from the base. Exact-head hosted Ruby 3.3/3.4/4.0 and Bedrock tests, lint, RBI/RBS checks, packaging, CodeQL, and Castiron baseline/budget checks are green.

No live API calls or local SDK test suite were run.

@markstuart-oai
markstuart-oai added this pull request to the merge queue Sep 23, 2026
@markstuart-oai

Copy link
Copy Markdown
Contributor Author

Thanks @jbeckwith-oai for the independent Ruby review and schema checks. The reviewed head remains 0d1896388e55679a8f4e71a381b88c8dd286b4df; no SDK source or signature changes have been added. The separate transcription-schema finding remains outside this correction.

Merged via the queue into main with commit 9e18acf Sep 23, 2026
22 checks passed
@markstuart-oai
markstuart-oai deleted the castiron/promotions/pr-150 branch September 23, 2026 23:51
@openai-sdks openai-sdks Bot mentioned this pull request Sep 23, 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