Repository navigation
fix(ai): preserve terminal reasoning metadata - #44997
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
response.completed.response.outputwhen providers omitresponse.output_item.doneBefore and after
Some Responses streams start a reasoning item and stream its summary but omit the individual item-completion event:
{ "type": "response.output_item.added", "item": { "type": "reasoning", "id": "rs_1", "encrypted_content": null } } { "type": "response.reasoning_summary_text.delta", "item_id": "rs_1", "delta": "Checked the diff." } { "type": "response.completed", "response": { "output": [ { "type": "reasoning", "id": "rs_1", "encrypted_content": "terminal-state", "summary": [{ "type": "summary_text", "text": "Checked the diff." }] } ] } }Before: Generic stream finalization closed the reasoning block without its authoritative terminal metadata, so the assistant message retained
reasoningEncryptedContent: null. A laterstore: falserequest omitted the reasoning item because it lacked encrypted continuation state.After: The terminal output item closes the pending reasoning block with its authoritative metadata:
{ "type": "reasoning-end", "id": "rs_1:0", "providerMetadata": { "openai": { "itemId": "rs_1", "reasoningEncryptedContent": "terminal-state" } } }The next stateless request can therefore replay the reasoning item:
{ "type": "reasoning", "id": "rs_1", "summary": [{ "type": "summary_text", "text": "Checked the diff." }], "encrypted_content": "terminal-state" }Already-finalized reasoning items are not emitted twice.
Verification
bun test test/partial-json.test.ts test/tool-stream.test.ts test/provider/openai-responses.test.ts test/provider/openai-compatible-responses.test.ts test/provider/openai-responses-websocket.recorded.test.ts test/provider/openai-chat.test.ts test/provider/anthropic-messages.test.ts test/provider/bedrock-converse.test.ts test/provider/xai-responses.test.ts test/response.test.ts test/tool-runtime.test.ts --timeout 30000 --only-failures(352 passing)RECORDED_PREFIX=openai-responses bun test test/provider/golden.recorded.test.ts --timeout 30000 --only-failuresbun typecheckfrompackages/aibunx prettier --check packages/ai/src/protocols/open-responses.ts packages/ai/test/provider/openai-responses.test.ts packages/ai/test/provider/openai-compatible-responses.test.ts