fix(openai): support tools returning image content #1079
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.
Description
This PR resolves an invalid_request_error from the OpenAI API that occurred when a tool returned image content. The API requires that image content only to be included in messages with the user role, whereas tool results are sent with the tool role.This fix implements a workaround by post-processing tool messages before they are sent to the API:
Note: I've also enabled the integration test (test_tool_returning_images), but I don't have an OpenAI API key with credits in them to verify it myself. The unit tests all pass on my end, so the core logic is confirmed to be working.
Related Issues
Closes #320
Documentation PR
N/AType of Change
Bug fix
Testing
How have you tested the change? Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli
hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.