fix(structured_output): do not modify conversation_history when prompt is passed #628
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
A customer brought up the following concern regarding using structured_output on an agent.
Adding the prompt to the conversation history seems like a bug. We are indicating that we want a particular message structured, but we never add the result to the conversation history.
So, we can either not append or we can add the result of the structuring after it is complete. I am biased towards the former. This is because structured output is not an action taken by the agent. Rather, it is more similar to a utility function for the user to format the result of an agent invocation. The structuring of the output is not itself an invocation in the same sense - especially since it is making a model request with only a single, non-user defined, tool.
Documentation PR
No documentation updates needed after inspecting https://strandsagents.com/latest/documentation/docs/user-guide/concepts/agents/structured-output/
Type 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 prepare
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.