-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Python: Feat: Add finish_reason support to AgentResponse and AgentResponseUpdate #4958
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
LEDazzio01
wants to merge
3
commits into
microsoft:main
Choose a base branch
from
LEDazzio01:feature/agent-response-finish-reason
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+152
−3
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
36b514d
docs: update middleware layering docs and add RawAnthropicClient to A…
LEDazzio01 3e0a046
feat: Add finish_reason support to AgentResponse and AgentResponseUpdate
LEDazzio01 83255b2
fix: address Copilot review — remove unused imports and use framework…
LEDazzio01 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| import pytest | ||
| from pydantic import BaseModel | ||
|
|
||
| from agent_framework import ( | ||
| AgentResponse, | ||
| AgentResponseUpdate, | ||
| ChatResponse, | ||
LEDazzio01 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ChatResponseUpdate, | ||
| Content, | ||
| Message, | ||
| ) | ||
| from agent_framework._types import _process_update, map_chat_to_agent_update | ||
|
|
||
|
|
||
| def test_agent_response_init_with_finish_reason() -> None: | ||
| """Test that AgentResponse correctly initializes and stores finish_reason.""" | ||
| response = AgentResponse( | ||
| messages=[Message("assistant", [Content.from_text("test")])], | ||
| finish_reason="stop", | ||
| ) | ||
| assert response.finish_reason == "stop" | ||
|
|
||
|
|
||
| def test_agent_response_update_init_with_finish_reason() -> None: | ||
| """Test that AgentResponseUpdate correctly initializes and stores finish_reason.""" | ||
| update = AgentResponseUpdate( | ||
| contents=[Content.from_text("test")], | ||
| role="assistant", | ||
| finish_reason="stop", | ||
| ) | ||
| assert update.finish_reason == "stop" | ||
|
|
||
|
|
||
| def test_map_chat_to_agent_update_forwards_finish_reason() -> None: | ||
| """Test that mapping a ChatResponseUpdate with finish_reason forwards it.""" | ||
| chat_update = ChatResponseUpdate( | ||
| contents=[Content.from_text("test")], | ||
| finish_reason="length", | ||
| ) | ||
| agent_update = map_chat_to_agent_update(chat_update, agent_name="test_agent") | ||
|
|
||
| assert agent_update.finish_reason == "length" | ||
| assert agent_update.author_name == "test_agent" | ||
|
|
||
|
|
||
| def test_process_update_propagates_finish_reason_to_agent_response() -> None: | ||
| """Test that _process_update correctly updates an AgentResponse from an AgentResponseUpdate.""" | ||
| response = AgentResponse(messages=[Message("assistant", [Content.from_text("test")])]) | ||
| update = AgentResponseUpdate( | ||
| contents=[Content.from_text("more text")], | ||
| role="assistant", | ||
| finish_reason="stop", | ||
| ) | ||
|
|
||
| # Process the update | ||
| _process_update(response, update) | ||
|
|
||
| assert response.finish_reason == "stop" | ||
|
|
||
|
|
||
| def test_process_update_does_not_overwrite_with_none() -> None: | ||
| """Test that _process_update does not overwrite an existing finish_reason with None.""" | ||
| response = AgentResponse( | ||
| messages=[Message("assistant", [Content.from_text("test")])], | ||
| finish_reason="length" | ||
| ) | ||
| update = AgentResponseUpdate( | ||
| contents=[Content.from_text("more text")], | ||
| role="assistant", | ||
| finish_reason=None, | ||
| ) | ||
|
|
||
| # Process the update | ||
| _process_update(response, update) | ||
|
|
||
| assert response.finish_reason == "length" | ||
|
|
||
|
|
||
| def test_agent_response_serialization_includes_finish_reason() -> None: | ||
| """Test that AgentResponse serializes correctly, including finish_reason.""" | ||
| response = AgentResponse( | ||
| messages=[Message("assistant", [Content.from_text("test")])], | ||
| response_id="test_123", | ||
| finish_reason="stop", | ||
| ) | ||
|
|
||
| # Dump to JSON model to verify it works (AgentResponse is a dataclass without dump but | ||
| # tested functionally or through usage_details/properties testing serialization patterns) | ||
| from dataclasses import asdict | ||
|
|
||
| data = asdict(response) | ||
| assert "finish_reason" in data | ||
| assert data["finish_reason"] == "stop" | ||
|
|
||
|
|
||
| def test_agent_response_update_serialization_includes_finish_reason() -> None: | ||
| """Test that AgentResponseUpdate serializes correctly via asdict.""" | ||
| update = AgentResponseUpdate( | ||
| contents=[Content.from_text("test")], | ||
| role="assistant", | ||
| response_id="test_456", | ||
| finish_reason="tool_calls", | ||
| ) | ||
| from dataclasses import asdict | ||
|
|
||
| data = asdict(update) | ||
LEDazzio01 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
LEDazzio01 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| assert "finish_reason" in data | ||
| assert data["finish_reason"] == "tool_calls" | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.