fix: include tool fields in CompletionResponse.to_dict()#54
Draft
cursor[bot] wants to merge 1 commit into
Draft
Conversation
CompletionResponse.to_dict() dropped tools_used, tool_execution_history, tool_execution_cost, and tool_calls from serialized messages. Extend serialization to preserve tool metadata for logging and downstream consumers, with unit tests. Co-authored-by: Darshan Harihar <DarshanHarihar1@users.noreply.github.com>
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
CompletionResponse.to_dict()was dropping tool-related metadata when serializing responses. This fix ensures tool calling data is preserved for logging, caching, and downstream consumers.Feature branch:
darshan/fix-completion-response-to-dictProblem
When calling
to_dict()on aCompletionResponsefrom a tool-calling completion, the following fields were silently omitted:tool_callsinside choice messagestools_usedtool_execution_historytool_execution_costSolution
Message.model_dump()sotool_calls,tool_call_id, and other optional fields are includedtools_used,tool_execution_cost, andtool_execution_historywhen settool_execution_historyentries via theirto_dict()method when availableTests
Added
tests/test_completion_response.pywith three unit tests covering tool call serialization, tool metadata fields, and omission when unset.CI
All checks pass locally: ruff, black, mypy, pytest (97 tests), and build.