Skip to content

feat(api): make function call output call IDs optional - #539

Open
apcha-oai wants to merge 1 commit into
mainfrom
castiron/promotions/pr-56
Open

feat(api): make function call output call IDs optional#539
apcha-oai wants to merge 1 commit into
mainfrom
castiron/promotions/pr-56

Conversation

@apcha-oai

Copy link
Copy Markdown
Contributor

Summary

Align function call output types with the API schema: call_id is optional in stable and beta input and response types, and input types also accept null.

Castiron-Internal-PR: openai/openai-ruby-internal#56
Castiron-Source-SHA: 459d6e33fb51f0048317306401710e3e47437f58
Castiron-Public-Base-SHA: b431570
@github-actions

github-actions Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

47 mixed files remain; 0 existing customizations changed.

Compared b431570fd5882ba45955c670. Generated baselines verified.

47 existing customizations unchanged
  • lib/openai.rb
  • lib/openai/client.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/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/resources/beta/threads.rb
  • lib/openai/resources/chat/completions.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/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/response_format_json_schema.rbi
  • rbi/openai/models/responses/response.rbi
  • rbi/openai/models/responses/response_create_params.rbi
  • rbi/openai/models/responses/response_function_tool_call.rbi
  • rbi/openai/models/responses/response_function_web_search.rbi
  • rbi/openai/models/responses/response_output_text.rbi
  • rbi/openai/resources/chat/completions.rbi
  • rbi/openai/resources/files.rbi
  • rbi/openai/resources/responses.rbi
  • rbi/openai/resources/vector_stores/file_batches.rbi
  • rbi/openai/resources/vector_stores/files.rbi
  • scripts/castiron/README.md
  • scripts/castiron/custom_code_report.py
  • scripts/castiron/test_custom_code_report.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 33022801225 --repo openai/openai-ruby \
  --name castiron-custom-code-33022801225-1 --dir /tmp/castiron-custom-code-33022801225-1
git apply --stat /tmp/castiron-custom-code-33022801225-1/custom-code.patch
cat /tmp/castiron-custom-code-33022801225-1/custom-code.patch

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

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

@apcha-oai
apcha-oai marked this pull request as ready for review August 26, 2026 23:17
@apcha-oai
apcha-oai requested a review from a team as a code owner August 26, 2026 23:17
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Aug 26, 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-08-26T23:18:25.846267Z 2ba4595 Draft marked ready
🔒 Security Review Completed 2026-08-26T23:19:59.282815Z 2ba4595 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 Aug 26, 2026

Copy link
Copy Markdown
Contributor

OkTest Summary

237/237 SDK tests passed in 9.635s for Ruby SDK PR #539.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 184ms
tests/chat-completions-create.test.ts ✅ Passed 243ms
tests/chat-completions-stream.test.ts ✅ Passed 137ms
tests/files-content-binary.test.ts ✅ Passed 134ms
tests/files-create-multipart.test.ts ✅ Passed 144ms
tests/files-list-pagination.test.ts ✅ Passed 153ms
tests/initialize-config.test.ts ✅ Passed 197ms
tests/instance-isolation.test.ts ✅ Passed 155ms
tests/models-list.test.ts ✅ Passed 245ms
tests/responses-background-lifecycle.test.ts ✅ Passed 240ms
tests/responses-body-method-errors.test.ts ✅ Passed 354ms
tests/responses-cancel-timeout.test.ts ✅ Passed 247ms
tests/responses-cancel.test.ts ✅ Passed 184ms
tests/responses-compact-retries.test.ts ✅ Passed 305ms
tests/responses-compact.test.ts ✅ Passed 190ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 128ms
tests/responses-create-advanced.test.ts ✅ Passed 233ms
tests/responses-create-disconnect.test.ts ✅ Passed 923ms
tests/responses-create-errors.test.ts ✅ Passed 235ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 142ms
tests/responses-create-retries.test.ts ✅ Passed 284ms
tests/responses-create-stream-failures.test.ts ✅ Passed 141ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 229ms
tests/responses-create-stream-wire.test.ts ✅ Passed 2.347s
tests/responses-create-stream.test.ts ✅ Passed 173ms
tests/responses-create-terminal-states.test.ts ✅ Passed 296ms
tests/responses-create-timeout.test.ts ✅ Passed 256ms
tests/responses-create.test.ts ✅ Passed 253ms
tests/responses-delete.test.ts ✅ Passed 207ms
tests/responses-input-items-errors.test.ts ✅ Passed 167ms
tests/responses-input-items-list.test.ts ✅ Passed 185ms
tests/responses-input-items-options.test.ts ✅ Passed 213ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 256ms
tests/responses-input-tokens-count.test.ts ✅ Passed 255ms
tests/responses-malformed-inputs.test.ts ✅ Passed 2.025s
tests/responses-not-found-errors.test.ts ✅ Passed 301ms
tests/responses-parse.test.ts ✅ Passed 201ms
tests/responses-retrieve-retries.test.ts ✅ Passed 245ms
tests/responses-retrieve.test.ts ✅ Passed 237ms
tests/responses-stored-method-errors.test.ts ✅ Passed 702ms
tests/retry-behavior.test.ts ✅ Passed 3.19s
tests/sdk-error-shape.test.ts ✅ Passed 378ms

View OkTest run #33022778849

SDK merge (bc04f5258eee) · head (2ba45955c670) · base (b431570fd588) · OkTest (2b1bdfd25e98)

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

The newly optional output call_id is correctly omitted at runtime, but the generated public Sorbet/RBS to_hash contracts still guarantee a required non-null call_id. Update the stable and beta generated hash shapes to accurately model omission and add a focused omitted-output regression.

output: OpenAI::Responses::ResponseFunctionToolCallOutputItem::Output::Variants,
status: OpenAI::Responses::ResponseFunctionToolCallOutputItem::Status::TaggedSymbol,
type: Symbol,
call_id: String,

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.

[P2] Make the generated output hash contract reflect omitted call_id

This PR makes response-output call_id optional, and BaseModel skips an absent optional field when populating @data; to_hash returns that data without a :call_id entry. However, this changed RBI still declares the returned hash has a required call_id: String, and the matching RBS and beta signatures make the same promise. Consequently model.to_hash.fetch(:call_id) type-checks but raises KeyError for the newly supported valid response. Generate an accurately optional hash key (and matching RBS/beta contracts) and add a focused regression for an output with no call ID.

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