Fix ChatMessage and Role API changes across packages

After rebasing on upstream/main which merged PR #3647 (Types API Review
improvements), fix all packages to use the new API:

- ChatMessage: Use keyword args (role=, text=, contents=) instead of
  positional args
- Role: Compare using .value attribute since it's now an enum

Packages fixed:
- ag-ui: Fixed Role value extraction bugs in _message_adapters.py
- anthropic: Fixed ChatMessage and Role comparisons in tests
- azure-ai: Fixed Role comparison in _client.py
- azure-ai-search: Fixed ChatMessage and Role in source/tests
- bedrock: Fixed ChatMessage signatures in tests
- chatkit: Fixed ChatMessage and Role in source/tests
- copilotstudio: Fixed ChatMessage and Role in tests
- declarative: Fixed ChatMessage in _executors_agents.py
- mem0: Fixed ChatMessage and Role in source/tests
- purview: Fixed ChatMessage in source/tests

Author: eavanvalkenburg

python/packages/ag-ui/agent_framework_ag_ui/_message_adapters.py

@@ -268,7 +268,7 @@ def _update_tool_call_arguments(
 
     def _find_matching_func_call(call_id: str) -> Content | None:
         for prev_msg in result:
-            role_val = prev_msg.role if hasattr(prev_msg.role, "value") else str(prev_msg.role)
+            role_val = prev_msg.role.value if hasattr(prev_msg.role, "value") else str(prev_msg.role)
             if role_val != "assistant":
                 continue
             for content in prev_msg.contents or []:
@@ -286,7 +286,7 @@ def _resolve_approval_call_id(tool_call_id: str, parsed_payload: dict[str, Any]
                 return str(explicit_call_id)
 
         for prev_msg in result:
-            role_val = prev_msg.role if hasattr(prev_msg.role, "value") else str(prev_msg.role)
+            role_val = prev_msg.role.value if hasattr(prev_msg.role, "value") else str(prev_msg.role)
             if role_val != "assistant":
                 continue
             direct_call = None
@@ -395,7 +395,7 @@ def _filter_modified_args(
                         m
                         for m in result
                         if not (
-                            (m.role if hasattr(m.role, "value") else str(m.role)) == "tool"
+                            (m.role.value if hasattr(m.role, "value") else str(m.role)) == "tool"
                             and any(
                                 c.type == "function_result" and c.call_id == approval_call_id
                                 for c in (m.contents or [])

python/packages/anthropic/tests/test_anthropic_client.py

@@ -148,7 +148,7 @@ def test_anthropic_client_service_url(mock_anthropic_client: MagicMock) -> None:
 def test_prepare_message_for_anthropic_text(mock_anthropic_client: MagicMock) -> None:
     """Test converting text message to Anthropic format."""
     chat_client = create_test_anthropic_client(mock_anthropic_client)
-    message = ChatMessage("user", ["Hello, world!"])
+    message = ChatMessage(role="user", text="Hello, world!")
 
     result = chat_client._prepare_message_for_anthropic(message)
 
@@ -227,8 +227,8 @@ def test_prepare_messages_for_anthropic_with_system(mock_anthropic_client: Magic
     """Test converting messages list with system message."""
     chat_client = create_test_anthropic_client(mock_anthropic_client)
     messages = [
-        ChatMessage("system", ["You are a helpful assistant."]),
-        ChatMessage("user", ["Hello!"]),
+        ChatMessage(role="system", text="You are a helpful assistant."),
+        ChatMessage(role="user", text="Hello!"),
     ]
 
     result = chat_client._prepare_messages_for_anthropic(messages)
@@ -243,8 +243,8 @@ def test_prepare_messages_for_anthropic_without_system(mock_anthropic_client: Ma
     """Test converting messages list without system message."""
     chat_client = create_test_anthropic_client(mock_anthropic_client)
     messages = [
-        ChatMessage("user", ["Hello!"]),
-        ChatMessage("assistant", ["Hi there!"]),
+        ChatMessage(role="user", text="Hello!"),
+        ChatMessage(role="assistant", text="Hi there!"),
     ]
 
     result = chat_client._prepare_messages_for_anthropic(messages)
@@ -372,7 +372,7 @@ async def test_prepare_options_basic(mock_anthropic_client: MagicMock) -> None:
     """Test _prepare_options with basic ChatOptions."""
     chat_client = create_test_anthropic_client(mock_anthropic_client)
 
-    messages = [ChatMessage("user", ["Hello"])]
+    messages = [ChatMessage(role="user", text="Hello")]
     chat_options = ChatOptions(max_tokens=100, temperature=0.7)
 
     run_options = chat_client._prepare_options(messages, chat_options)
@@ -388,8 +388,8 @@ async def test_prepare_options_with_system_message(mock_anthropic_client: MagicM
     chat_client = create_test_anthropic_client(mock_anthropic_client)
 
     messages = [
-        ChatMessage("system", ["You are helpful."]),
-        ChatMessage("user", ["Hello"]),
+        ChatMessage(role="system", text="You are helpful."),
+        ChatMessage(role="user", text="Hello"),
     ]
     chat_options = ChatOptions()
 
@@ -403,7 +403,7 @@ async def test_prepare_options_with_tool_choice_auto(mock_anthropic_client: Magi
     """Test _prepare_options with auto tool choice."""
     chat_client = create_test_anthropic_client(mock_anthropic_client)
 
-    messages = [ChatMessage("user", ["Hello"])]
+    messages = [ChatMessage(role="user", text="Hello")]
     chat_options = ChatOptions(tool_choice="auto")
 
     run_options = chat_client._prepare_options(messages, chat_options)
@@ -415,7 +415,7 @@ async def test_prepare_options_with_tool_choice_required(mock_anthropic_client:
     """Test _prepare_options with required tool choice."""
     chat_client = create_test_anthropic_client(mock_anthropic_client)
 
-    messages = [ChatMessage("user", ["Hello"])]
+    messages = [ChatMessage(role="user", text="Hello")]
     # For required with specific function, need to pass as dict
     chat_options = ChatOptions(tool_choice={"mode": "required", "required_function_name": "get_weather"})
 
@@ -429,7 +429,7 @@ async def test_prepare_options_with_tool_choice_none(mock_anthropic_client: Magi
     """Test _prepare_options with none tool choice."""
     chat_client = create_test_anthropic_client(mock_anthropic_client)
 
-    messages = [ChatMessage("user", ["Hello"])]
+    messages = [ChatMessage(role="user", text="Hello")]
     chat_options = ChatOptions(tool_choice="none")
 
     run_options = chat_client._prepare_options(messages, chat_options)
@@ -446,7 +446,7 @@ def get_weather(location: str) -> str:
         """Get weather for a location."""
         return f"Weather for {location}"
 
-    messages = [ChatMessage("user", ["Hello"])]
+    messages = [ChatMessage(role="user", text="Hello")]
     chat_options = ChatOptions(tools=[get_weather])
 
     run_options = chat_client._prepare_options(messages, chat_options)
@@ -459,7 +459,7 @@ async def test_prepare_options_with_stop_sequences(mock_anthropic_client: MagicM
     """Test _prepare_options with stop sequences."""
     chat_client = create_test_anthropic_client(mock_anthropic_client)
 
-    messages = [ChatMessage("user", ["Hello"])]
+    messages = [ChatMessage(role="user", text="Hello")]
     chat_options = ChatOptions(stop=["STOP", "END"])
 
     run_options = chat_client._prepare_options(messages, chat_options)
@@ -471,7 +471,7 @@ async def test_prepare_options_with_top_p(mock_anthropic_client: MagicMock) -> N
     """Test _prepare_options with top_p."""
     chat_client = create_test_anthropic_client(mock_anthropic_client)
 
-    messages = [ChatMessage("user", ["Hello"])]
+    messages = [ChatMessage(role="user", text="Hello")]
     chat_options = ChatOptions(top_p=0.9)
 
     run_options = chat_client._prepare_options(messages, chat_options)
@@ -498,11 +498,11 @@ def test_process_message_basic(mock_anthropic_client: MagicMock) -> None:
     assert response.response_id == "msg_123"
     assert response.model_id == "claude-3-5-sonnet-20241022"
     assert len(response.messages) == 1
-    assert response.messages[0].role == "assistant"
+    assert response.messages[0].role.value == "assistant"
     assert len(response.messages[0].contents) == 1
     assert response.messages[0].contents[0].type == "text"
     assert response.messages[0].contents[0].text == "Hello there!"
-    assert response.finish_reason == "stop"
+    assert response.finish_reason.value == "stop"
     assert response.usage_details is not None
     assert response.usage_details["input_token_count"] == 10
     assert response.usage_details["output_token_count"] == 5
@@ -532,7 +532,7 @@ def test_process_message_with_tool_use(mock_anthropic_client: MagicMock) -> None
     assert response.messages[0].contents[0].type == "function_call"
     assert response.messages[0].contents[0].call_id == "call_123"
     assert response.messages[0].contents[0].name == "get_weather"
-    assert response.finish_reason == "tool_calls"
+    assert response.finish_reason.value == "tool_calls"
 
 
 def test_parse_usage_from_anthropic_basic(mock_anthropic_client: MagicMock) -> None:
@@ -666,7 +666,7 @@ async def test_inner_get_response(mock_anthropic_client: MagicMock) -> None:
 
     mock_anthropic_client.beta.messages.create.return_value = mock_message
 
-    messages = [ChatMessage("user", ["Hi"])]
+    messages = [ChatMessage(role="user", text="Hi")]
     chat_options = ChatOptions(max_tokens=10)
 
     response = await chat_client._inner_get_response(  # type: ignore[attr-defined]
@@ -690,7 +690,7 @@ async def mock_stream():
 
     mock_anthropic_client.beta.messages.create.return_value = mock_stream()
 
-    messages = [ChatMessage("user", ["Hi"])]
+    messages = [ChatMessage(role="user", text="Hi")]
     chat_options = ChatOptions(max_tokens=10)
 
     chunks: list[ChatResponseUpdate] = []
@@ -721,13 +721,13 @@ async def test_anthropic_client_integration_basic_chat() -> None:
     """Integration test for basic chat completion."""
     client = AnthropicClient()
 
-    messages = [ChatMessage("user", ["Say 'Hello, World!' and nothing else."])]
+    messages = [ChatMessage(role="user", text="Say 'Hello, World!' and nothing else.")]
 
     response = await client.get_response(messages=messages, options={"max_tokens": 50})
 
     assert response is not None
     assert len(response.messages) > 0
-    assert response.messages[0].role == "assistant"
+    assert response.messages[0].role.value == "assistant"
     assert len(response.messages[0].text) > 0
     assert response.usage_details is not None
 
@@ -738,7 +738,7 @@ async def test_anthropic_client_integration_streaming_chat() -> None:
     """Integration test for streaming chat completion."""
     client = AnthropicClient()
 
-    messages = [ChatMessage("user", ["Count from 1 to 5."])]
+    messages = [ChatMessage(role="user", text="Count from 1 to 5.")]
 
     chunks = []
     async for chunk in client.get_response(messages=messages, stream=True, options={"max_tokens": 50}):
@@ -754,7 +754,7 @@ async def test_anthropic_client_integration_function_calling() -> None:
     """Integration test for function calling."""
     client = AnthropicClient()
 
-    messages = [ChatMessage("user", ["What's the weather in San Francisco?"])]
+    messages = [ChatMessage(role="user", text="What's the weather in San Francisco?")]
     tools = [get_weather]
 
     response = await client.get_response(
@@ -774,7 +774,7 @@ async def test_anthropic_client_integration_hosted_tools() -> None:
     """Integration test for hosted tools."""
     client = AnthropicClient()
 
-    messages = [ChatMessage("user", ["What tools do you have available?"])]
+    messages = [ChatMessage(role="user", text="What tools do you have available?")]
     tools = [
         HostedWebSearchTool(),
         HostedCodeInterpreterTool(),
@@ -801,8 +801,8 @@ async def test_anthropic_client_integration_with_system_message() -> None:
     client = AnthropicClient()
 
     messages = [
-        ChatMessage("system", ["You are a pirate. Always respond like a pirate."]),
-        ChatMessage("user", ["Hello!"]),
+        ChatMessage(role="system", text="You are a pirate. Always respond like a pirate."),
+        ChatMessage(role="user", text="Hello!"),
     ]
 
     response = await client.get_response(messages=messages, options={"max_tokens": 50})
@@ -817,7 +817,7 @@ async def test_anthropic_client_integration_temperature_control() -> None:
     """Integration test with temperature control."""
     client = AnthropicClient()
 
-    messages = [ChatMessage("user", ["Say hello."])]
+    messages = [ChatMessage(role="user", text="Say hello.")]
 
     response = await client.get_response(
         messages=messages,
@@ -835,11 +835,11 @@ async def test_anthropic_client_integration_ordering() -> None:
     client = AnthropicClient()
 
     messages = [
-        ChatMessage("user", ["Say hello."]),
-        ChatMessage("user", ["Then say goodbye."]),
-        ChatMessage("assistant", ["Thank you for chatting!"]),
-        ChatMessage("assistant", ["Let me know if I can help."]),
-        ChatMessage("user", ["Just testing things."]),
+        ChatMessage(role="user", text="Say hello."),
+        ChatMessage(role="user", text="Then say goodbye."),
+        ChatMessage(role="assistant", text="Thank you for chatting!"),
+        ChatMessage(role="assistant", text="Let me know if I can help."),
+        ChatMessage(role="user", text="Just testing things."),
     ]
 
     response = await client.get_response(messages=messages)

python/packages/azure-ai-search/agent_framework_azure_ai_search/_search_provider.py

@@ -524,8 +524,13 @@ async def invoking(
         # Convert to list and filter to USER/ASSISTANT messages with text only
         messages_list = [messages] if isinstance(messages, ChatMessage) else list(messages)
 
+        def get_role_value(role: str) -> str:
+            return role.value if hasattr(role, "value") else str(role)  # type: ignore[union-attr]
+
         filtered_messages = [
-            msg for msg in messages_list if msg and msg.text and msg.text.strip() and msg.role in ["user", "assistant"]
+            msg
+            for msg in messages_list
+            if msg and msg.text and msg.text.strip() and get_role_value(msg.role) in ["user", "assistant"]
         ]
 
         if not filtered_messages:
@@ -546,8 +551,8 @@ async def invoking(
             return Context()
 
         # Create context messages: first message with prompt, then one message per result part
-        context_messages = [ChatMessage("user", [self.context_prompt])]
-        context_messages.extend([ChatMessage("user", [part]) for part in search_result_parts])
+        context_messages = [ChatMessage(role="user", text=self.context_prompt)]
+        context_messages.extend([ChatMessage(role="user", text=part) for part in search_result_parts])
 
         return Context(messages=context_messages)
 
@@ -919,7 +924,7 @@ async def _agentic_search(self, messages: list[ChatMessage]) -> list[str]:
             # Medium/low reasoning uses messages with conversation history
             kb_messages = [
                 KnowledgeBaseMessage(
-                    role=msg.role if hasattr(msg.role, "value") else str(msg.role),
+                    role=msg.role.value if hasattr(msg.role, "value") else str(msg.role),
                     content=[KnowledgeBaseMessageTextContent(text=msg.text)],
                 )
                 for msg in messages

python/packages/azure-ai-search/tests/test_search_provider.py

@@ -39,7 +39,7 @@ def mock_index_client() -> AsyncMock:
 def sample_messages() -> list[ChatMessage]:
     """Create sample chat messages for testing."""
     return [
-        ChatMessage("user", ["What is in the documents?"]),
+        ChatMessage(role="user", text="What is in the documents?"),
     ]
 
 
@@ -318,7 +318,7 @@ async def test_semantic_search_empty_query(self, mock_search_class: MagicMock) -
         )
 
         # Empty message
-        context = await provider.invoking([ChatMessage("user", [""])])
+        context = await provider.invoking([ChatMessage(role="user", text="")])
 
         assert isinstance(context, Context)
         assert len(context.messages) == 0
@@ -520,10 +520,10 @@ async def test_filters_non_user_assistant_messages(self, mock_search_class: Magi
 
         # Mix of message types
         messages = [
-            ChatMessage("system", ["System message"]),
-            ChatMessage("user", ["User message"]),
-            ChatMessage("assistant", ["Assistant message"]),
-            ChatMessage("tool", ["Tool message"]),
+            ChatMessage(role="system", text="System message"),
+            ChatMessage(role="user", text="User message"),
+            ChatMessage(role="assistant", text="Assistant message"),
+            ChatMessage(role="tool", text="Tool message"),
         ]
 
         context = await provider.invoking(messages)
@@ -548,9 +548,9 @@ async def test_filters_empty_messages(self, mock_search_class: MagicMock) -> Non
 
         # Messages with empty/whitespace text
         messages = [
-            ChatMessage("user", [""]),
-            ChatMessage("user", ["   "]),
-            ChatMessage("user", [None]),
+            ChatMessage(role="user", text=""),
+            ChatMessage(role="user", text="   "),
+            ChatMessage(role="user", text=""),  # ChatMessage with None text becomes empty string
         ]
 
         context = await provider.invoking(messages)
@@ -581,7 +581,7 @@ async def test_citations_included_in_semantic_search(self, mock_search_class: Ma
             mode="semantic",
         )
 
-        context = await provider.invoking([ChatMessage("user", ["test query"])])
+        context = await provider.invoking([ChatMessage(role="user", text="test query")])
 
         # Check that citation is included
         assert isinstance(context, Context)

python/packages/azure-ai/agent_framework_azure_ai/_client.py

@@ -495,7 +495,8 @@ def _prepare_messages_for_azure_ai(self, messages: Sequence[ChatMessage]) -> tup
 
         # System/developer messages are turned into instructions, since there is no such message roles in Azure AI.
         for message in messages:
-            if message.role in ["system", "developer"]:
+            role_value = message.role.value if hasattr(message.role, "value") else message.role
+            if role_value in ["system", "developer"]:
                 for text_content in [content for content in message.contents if content.type == "text"]:
                     instructions_list.append(text_content.text)  # type: ignore[arg-type]
             else:

python/packages/bedrock/tests/test_bedrock_client.py

@@ -41,8 +41,8 @@ async def test_get_response_invokes_bedrock_runtime() -> None:
     )
 
     messages = [
-        ChatMessage("system", [Content.from_text(text="You are concise.")]),
-        ChatMessage("user", [Content.from_text(text="hello")]),
+        ChatMessage(role="system", contents=[Content.from_text(text="You are concise.")]),
+        ChatMessage(role="user", contents=[Content.from_text(text="hello")]),
     ]
 
     response = await client.get_response(messages=messages, options={"max_tokens": 32})
@@ -62,7 +62,7 @@ def test_build_request_requires_non_system_messages() -> None:
         client=_StubBedrockRuntime(),
     )
 
-    messages = [ChatMessage("system", [Content.from_text(text="Only system text")])]
+    messages = [ChatMessage(role="system", contents=[Content.from_text(text="Only system text")])]
 
     with pytest.raises(ServiceInitializationError):
         client._prepare_options(messages, {})

python/packages/bedrock/tests/test_bedrock_settings.py

@@ -46,7 +46,7 @@ def test_build_request_includes_tool_config() -> None:
         "tools": [tool],
         "tool_choice": {"mode": "required", "required_function_name": "get_weather"},
     }
-    messages = [ChatMessage("user", [Content.from_text(text="hi")])]
+    messages = [ChatMessage(role="user", contents=[Content.from_text(text="hi")])]
 
     request = client._prepare_options(messages, options)
 
@@ -58,7 +58,7 @@ def test_build_request_serializes_tool_history() -> None:
     client = _build_client()
     options: ChatOptions = {}
     messages = [
-        ChatMessage("user", [Content.from_text(text="how's weather?")]),
+        ChatMessage(role="user", contents=[Content.from_text(text="how's weather?")]),
         ChatMessage(
             role="assistant",
             contents=[