mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Python: [BREAKING] Types API Review improvements (#3647)
* Replace Role and FinishReason classes with NewType + Literal
- Remove EnumLike metaclass from _types.py
- Replace Role class with NewType('Role', str) + RoleLiteral
- Replace FinishReason class with NewType('FinishReason', str) + FinishReasonLiteral
- Update all usages across codebase to use string literals
- Remove .value access patterns (direct string comparison now works)
- Add backward compatibility for legacy dict serialization format
- Update tests to reflect new string-based types
Addresses #3591, #3615
* Simplify ChatResponse and AgentResponse type hints (#3592)
- Remove overloads from ChatResponse.__init__
- Remove text parameter from ChatResponse.__init__
- Remove | dict[str, Any] from finish_reason and usage_details params
- Remove **kwargs from AgentResponse.__init__
- Both now accept ChatMessage | Sequence[ChatMessage] | None for messages
- Update docstrings and examples to reflect changes
- Fix tests that were using removed kwargs
- Fix Role type hint usage in ag-ui utils
* Remove text parameter from ChatResponseUpdate and AgentResponseUpdate (#3597)
- Remove text parameter from ChatResponseUpdate.__init__
- Remove text parameter from AgentResponseUpdate.__init__
- Remove **kwargs from both update classes
- Simplify contents parameter type to Sequence[Content] | None
- Update all usages to use contents=[Content.from_text(...)] pattern
- Fix imports in test files
- Update docstrings and examples
* Rename from_chat_response_updates to from_updates (#3593)
- ChatResponse.from_chat_response_updates → ChatResponse.from_updates
- ChatResponse.from_chat_response_generator → ChatResponse.from_update_generator
- AgentResponse.from_agent_run_response_updates → AgentResponse.from_updates
* Remove try_parse_value method from ChatResponse and AgentResponse (#3595)
- Remove try_parse_value method from ChatResponse
- Remove try_parse_value method from AgentResponse
- Remove try_parse_value calls from from_updates and from_update_generator methods
- Update samples to use try/except with response.value instead
- Update tests to use response.value pattern
- Users should now use response.value with try/except for safe parsing
* Add agent_id to AgentResponse and clarify author_name documentation (#3596)
- Add agent_id parameter to AgentResponse class
- Document that author_name is on ChatMessage objects, not responses
- Update ChatResponse docstring with author_name note
- Update AgentResponse docstring with author_name note
* Simplify ChatMessage.__init__ signature (#3618)
- Make contents a positional argument accepting Sequence[Content | str]
- Auto-convert strings in contents to TextContent
- Remove overloads, keep text kwarg for backward compatibility with serialization
- Update _parse_content_list to handle string items
- Update all usages across codebase to use new format: ChatMessage("role", ["text"])
* Allow Content as input on run and get_response
- Update prepare_messages and normalize_messages to accept Content
- Update type signatures in _agents.py and _clients.py
- Add tests for Content input handling
* Fix ChatMessage usage across packages and samples
Update all remaining ChatMessage(role=..., text=...) to use new
ChatMessage('role', ['text']) signature.
* Fix Role string usage and response format parsing
- Fix redis provider: remove .value access on string literals
- Fix durabletask ensure_response_format: set _response_format before accessing .value
* Fix ollama .value and ai_model_id issues, handle None in content list
- Fix ollama _chat_client: remove .value on string literals
- Fix ollama _chat_client: rename ai_model_id to model_id
- Fix _parse_content_list: skip None values gracefully
* Fix A2AAgent type signature to include Content
* Fix Role/FinishReason NewType dict annotations and improve test coverage to 95%
* Fix mypy errors for Role/FinishReason NewType usage
* Fix Role.TOOL and Role.ASSISTANT usage in _orchestrator_helpers.py
* Fix Role NewType usage in durabletask _models.py
This commit is contained in:
@@ -16,7 +16,6 @@ from agent_framework import (
|
||||
Content,
|
||||
ContextProvider,
|
||||
FunctionTool,
|
||||
Role,
|
||||
ToolProtocol,
|
||||
get_logger,
|
||||
normalize_messages,
|
||||
@@ -628,7 +627,7 @@ class ClaudeAgent(BaseAgent, Generic[TOptions]):
|
||||
text = delta.get("text", "")
|
||||
if text:
|
||||
yield AgentResponseUpdate(
|
||||
role=Role.ASSISTANT,
|
||||
role="assistant",
|
||||
contents=[Content.from_text(text=text, raw_representation=message)],
|
||||
raw_representation=message,
|
||||
)
|
||||
@@ -636,7 +635,7 @@ class ClaudeAgent(BaseAgent, Generic[TOptions]):
|
||||
thinking = delta.get("thinking", "")
|
||||
if thinking:
|
||||
yield AgentResponseUpdate(
|
||||
role=Role.ASSISTANT,
|
||||
role="assistant",
|
||||
contents=[Content.from_text_reasoning(text=thinking, raw_representation=message)],
|
||||
raw_representation=message,
|
||||
)
|
||||
|
||||
@@ -4,7 +4,7 @@ from typing import Any
|
||||
from unittest.mock import AsyncMock, MagicMock, patch
|
||||
|
||||
import pytest
|
||||
from agent_framework import AgentResponseUpdate, AgentThread, ChatMessage, Content, Role, tool
|
||||
from agent_framework import AgentResponseUpdate, AgentThread, ChatMessage, Content, tool
|
||||
|
||||
from agent_framework_claude import ClaudeAgent, ClaudeAgentOptions, ClaudeAgentSettings
|
||||
from agent_framework_claude._agent import TOOLS_MCP_SERVER_NAME
|
||||
@@ -375,7 +375,7 @@ class TestClaudeAgentRunStream:
|
||||
updates.append(update)
|
||||
# StreamEvent yields text deltas
|
||||
assert len(updates) == 2
|
||||
assert updates[0].role == Role.ASSISTANT
|
||||
assert updates[0].role == "assistant"
|
||||
assert updates[0].text == "Streaming "
|
||||
assert updates[1].text == "response"
|
||||
|
||||
@@ -632,7 +632,7 @@ class TestFormatPrompt:
|
||||
"""Test formatting user message."""
|
||||
agent = ClaudeAgent()
|
||||
msg = ChatMessage(
|
||||
role=Role.USER,
|
||||
role="user",
|
||||
contents=[Content.from_text(text="Hello")],
|
||||
)
|
||||
result = agent._format_prompt([msg]) # type: ignore[reportPrivateUsage]
|
||||
@@ -642,9 +642,9 @@ class TestFormatPrompt:
|
||||
"""Test formatting multiple messages."""
|
||||
agent = ClaudeAgent()
|
||||
messages = [
|
||||
ChatMessage(role=Role.USER, contents=[Content.from_text(text="Hi")]),
|
||||
ChatMessage(role=Role.ASSISTANT, contents=[Content.from_text(text="Hello!")]),
|
||||
ChatMessage(role=Role.USER, contents=[Content.from_text(text="How are you?")]),
|
||||
ChatMessage("user", [Content.from_text(text="Hi")]),
|
||||
ChatMessage("assistant", [Content.from_text(text="Hello!")]),
|
||||
ChatMessage("user", [Content.from_text(text="How are you?")]),
|
||||
]
|
||||
result = agent._format_prompt(messages) # type: ignore[reportPrivateUsage]
|
||||
assert "Hi" in result
|
||||
|
||||
Reference in New Issue
Block a user