Python: Require tool_call_id parameter for string-based tool messages in ChatHistory #12753
+53
−8
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.
Motivation and Context
The
add_tool_message
method ofChatHistory
accepts string content without requiring atool_call_id
parameter. This design is flawed from an API design perspective. It created tool messages that:tool_call_id
that references a previous function callDescription
This PR modifies the
add_tool_message
string overload to require atool_call_id
parameter, which makes sure we have proper tool call protocol compliance.tool_call_id
is provided and raises a clear error if missingFunctionResultContent
objects with bothid
andcall_id
set to the providedtool_call_id
function_name
parameter for better bookkeepingtool_call_id
is requiredBefore:
After:
Contribution Checklist