fix(compat_oai): correct parameter order in ToolMessage call #3504
+1
−1
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
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
The parameters to openai.ToolMessage were swapped, causing tool responses to have their content and tool_call_id fields reversed in the JSON output. This was causing validation errors with AWS Bedrock which expects: - tool_call_id: to contain the tool reference ID (matching [a-zA-Z0-9_-]+ pattern) - content: to contain the actual response data The incorrect order was putting JSON response data in tool_call_id field, causing Bedrock validation to fail with regex pattern errors. Fixed by swapping the parameters to match the OpenAI SDK signature: ToolMessage(content, toolCallID) instead of ToolMessage(toolCallID, content)
panbanda
force-pushed
the
fix-tool-response-field-swap
branch
from
69caca3 to
aa78c2d
Compare
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
This PR fixes a critical bug where tool response messages have their
contentandtool_call_idfields swapped in the JSON output when using the OpenAI compatibility layer.Problem
When Genkit creates tool response messages, the parameters to
openai.ToolMessage()were in the wrong order, resulting in:{ "role": "tool", "content": "tooluse_B8G0zOhpTIKkZKFc_DRtdQ", // Should be the response data "tool_call_id": "{\"conditions\":\"Clear\",...}" // Should be the tool ID }This causes validation errors with services like AWS Bedrock that enforce strict validation on
tool_call_idfields (must match pattern[a-zA-Z0-9_-]+and be ≤64 chars).Solution
The OpenAI SDK signature for
ToolMessageis:This PR corrects the parameter order from:
To:
Impact
This fix ensures tool responses are properly formatted according to the OpenAI API specification, making them compatible with strict validation backends like AWS Bedrock.
Testing