Fix exception when tracing agents_client.threads.create(messages=[ThreadMessageOptions(....)]) (#42812)

Author: dargilco

sdk/ai/azure-ai-agents/CHANGELOG.md

@@ -8,12 +8,13 @@
 
 ### Features Added
 
-- Added static merge_resources method to `McpTool` with accompanying sample.
+- Added static `merge_resources` method to `McpTool` with accompanying sample.
 
 ### Bugs Fixed
 
-* Fix the issue with logging Agent message, when the message has "in progress" status (related to [issue](https://github.com/Azure/azure-sdk-for-python/issues/42645)).
-* Fix the issue with `RunStepOpenAPIToolCall` logging [issue](https://github.com/Azure/azure-sdk-for-python/issues/42645).
+- Fix issue with tracing an Agent message, when the message has "in progress" status (related to [GitHub Issue 42645](https://github.com/Azure/azure-sdk-for-python/issues/42645)).
+- Fix issue with tracing `RunStepOpenAPIToolCall` ([GitHub issue 42645](https://github.com/Azure/azure-sdk-for-python/issues/42645)).
+- Fix issue when `.threads.create(messages=[ThreadMessageOptions(...])` is called on the `AgentsClient`, when tracing is enabled ([GitHub issue 42805](https://github.com/Azure/azure-sdk-for-python/issues/42805))
 
 ### Sample updates
 

sdk/ai/azure-ai-agents/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/ai/azure-ai-agents",
-  "Tag": "python/ai/azure-ai-agents_65510bf995"
+  "Tag": "python/ai/azure-ai-agents_f5906767ec"
 }

sdk/ai/azure-ai-agents/azure/ai/agents/telemetry/_ai_agents_instrumentor.py

@@ -26,6 +26,8 @@
     MessageAttachment,
     MessageDeltaChunk,
     MessageIncompleteDetails,
+    MessageInputContentBlock,
+    MessageInputTextBlock,
     RunStep,
     RunStepDeltaChunk,
     RunStepError,
@@ -36,6 +38,7 @@
     RunStepCodeInterpreterToolCall,
     RunStepBingGroundingToolCall,
     ThreadMessage,
+    ThreadMessageOptions,
     ThreadRun,
     ToolDefinition,
     ToolOutput,
@@ -369,31 +372,42 @@ def _create_event_attributes(
     def add_thread_message_event(
         self,
         span,
-        message: ThreadMessage,
+        message: Union[ThreadMessage, ThreadMessageOptions],
         usage: Optional[_models.RunStepCompletionUsage] = None,
     ) -> None:
-        content_body = {}
+
+        content_body: Optional[Union[str, Dict[str, Any]]] = None
         if _trace_agents_content:
-            for content in message.content:
-                typed_content = content.get(content.type, None)
-                if typed_content:
-                    content_details = {"value": self._get_field(typed_content, "value")}
-                    annotations = self._get_field(typed_content, "annotations")
-                    if annotations:
-                        content_details["annotations"] = [a.as_dict() for a in annotations]
-                    content_body[content.type] = content_details
+            if isinstance(message, ThreadMessage):
+                for content in message.content:
+                    typed_content = content.get(content.type, None)
+                    if typed_content:
+                        content_details = {"value": self._get_field(typed_content, "value")}
+                        annotations = self._get_field(typed_content, "annotations")
+                        if annotations:
+                            content_details["annotations"] = [a.as_dict() for a in annotations]
+                        content_body = {}
+                        content_body[content.type] = content_details
+            elif isinstance(message, ThreadMessageOptions):
+                if isinstance(message.content, str):
+                    content_body = message.content
+                elif isinstance(message.content, List):
+                    for block in message.content:
+                        if isinstance(block, MessageInputTextBlock):
+                            content_body = block.text
+                            break
 
         self._add_message_event(
             span,
             self._get_role(message.role),
             content_body,
-            attachments=message.attachments,
-            thread_id=message.thread_id,
-            agent_id=message.agent_id,
-            message_id=message.id,
-            thread_run_id=message.run_id,
-            message_status=message.status,
-            incomplete_details=message.incomplete_details,
+            attachments=getattr(message, "attachments", None),
+            thread_id=getattr(message, "thread_id", None),
+            agent_id=getattr(message, "agent_id", None),
+            message_id=getattr(message, "id", None),
+            thread_run_id=getattr(message, "run_id", None),
+            message_status=getattr(message, "status", None),
+            incomplete_details=getattr(message, "incomplete_details", None),
             usage=usage,
         )
 
@@ -563,7 +577,7 @@ def _add_message_event(
         self,
         span,
         role: str,
-        content: Any,
+        content: Optional[Union[str, dict[str, Any], List[MessageInputContentBlock]]] = None,
         attachments: Any = None,  # Optional[List[MessageAttachment]] or dict
         thread_id: Optional[str] = None,
         agent_id: Optional[str] = None,
@@ -575,9 +589,15 @@ def _add_message_event(
     ) -> None:
         # TODO document new fields
 
-        event_body = {}
+        event_body: dict[str, Any]= {}
         if _trace_agents_content:
-            event_body["content"] = content
+            if isinstance(content, List):
+                for block in content:
+                    if isinstance(block, MessageInputTextBlock):
+                        event_body["content"] = block.text
+                        break
+            else:
+                event_body["content"] = content
             if attachments:
                 event_body["attachments"] = []
                 for attachment in attachments:
@@ -809,7 +829,7 @@ def start_create_agent_span(
     def start_create_thread_span(
         self,
         server_address: Optional[str] = None,
-        messages: Optional[List[ThreadMessage]] = None,
+        messages: Optional[Union[List[ThreadMessage], List[ThreadMessageOptions]]] = None,
         _tool_resources: Optional[ToolResources] = None,
     ) -> "Optional[AbstractSpan]":
         span = start_span(OperationName.CREATE_THREAD, server_address=server_address)
@@ -1487,7 +1507,7 @@ def start_create_message_span(
         self,
         server_address: Optional[str] = None,
         thread_id: Optional[str] = None,
-        content: Optional[str] = None,
+        content: Optional[Union[str, List[MessageInputContentBlock]]] = None,
         role: Optional[Union[str, MessageRole]] = None,
         attachments: Optional[List[MessageAttachment]] = None,
     ) -> "Optional[AbstractSpan]":

sdk/ai/azure-ai-agents/samples/sample_agents_basics.py

@@ -27,24 +27,6 @@
 from azure.identity import DefaultAzureCredential
 from azure.ai.agents.models import ListSortOrder
 
-import sys
-import logging
-
-# Enable detailed console logs across Azure libraries
-azure_logger = logging.getLogger("azure")
-azure_logger.setLevel(logging.DEBUG)
-azure_logger.addHandler(logging.StreamHandler(stream=sys.stdout))
-
-# Exclude details logs for network calls associated with getting Entra ID token
-identity_logger = logging.getLogger("azure.identity")
-identity_logger.setLevel(logging.ERROR)
-
-# Make sure regular (redacted) detailed azure.core logs are not shown, as we are about to
-# turn on non-redacted logs by passing 'logging_enable=True' to the client constructor
-# (which are implemented as a separate logging policy)
-logger = logging.getLogger("azure.core.pipeline.policies.http_logging_policy")
-logger.setLevel(logging.ERROR)
-
 # Pass in 'logging_enable=True' to your client constructor for un-redacted logs
 project_client = AIProjectClient(
     endpoint=os.environ["PROJECT_ENDPOINT"], credential=DefaultAzureCredential(), logging_enable=True

sdk/ai/azure-ai-agents/tests/test_ai_agents_instrumentor.py

@@ -18,6 +18,7 @@
     McpTool,
     MessageDeltaChunk,
     MessageDeltaTextContent,
+    MessageInputTextBlock,
     OpenApiAnonymousAuthDetails,
     OpenApiTool,
     RequiredMcpToolCall,
@@ -28,6 +29,7 @@
     RunStepToolCallDetails,
     SubmitToolApprovalAction,
     ThreadMessage,
+    ThreadMessageOptions,
     ThreadRun,
     Tool,
     ToolApproval,
@@ -36,26 +38,22 @@
 from azure.ai.agents.telemetry._ai_agents_instrumentor import _AIAgentsInstrumentorPreview
 from azure.ai.agents.telemetry import AIAgentsInstrumentor, _utils
 from azure.core.settings import settings
-from memory_trace_exporter import MemoryTraceExporter
 from gen_ai_trace_verifier import GenAiTraceVerifier
-from opentelemetry import trace
-from opentelemetry.sdk.trace import TracerProvider
-from opentelemetry.sdk.trace.export import SimpleSpanProcessor
 from azure.ai.agents import AgentsClient
 
 from devtools_testutils import (
     recorded_by_proxy,
 )
 
 from test_agents_client_base import agentClientPreparer
-from test_ai_instrumentor_base import TestAiAgentsInstrumentorBase
+from test_ai_instrumentor_base import TestAiAgentsInstrumentorBase, MessageCreationMode, CONTENT_TRACING_ENV_VARIABLE
 
-CONTENT_TRACING_ENV_VARIABLE = "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"
 settings.tracing_implementation = "OpenTelemetry"
 _utils._span_impl_type = settings.tracing_implementation()
 
 
 class TestAiAgentsInstrumentor(TestAiAgentsInstrumentorBase):
+
     """Tests for AI agents instrumentor."""
 
     @pytest.fixture(scope="function")
@@ -72,19 +70,6 @@ def instrument_without_content(self):
         yield
         self.cleanup()
 
-    def setup_telemetry(self):
-        trace._TRACER_PROVIDER = TracerProvider()
-        self.exporter = MemoryTraceExporter()
-        span_processor = SimpleSpanProcessor(self.exporter)
-        trace.get_tracer_provider().add_span_processor(span_processor)
-        AIAgentsInstrumentor().instrument()
-
-    def cleanup(self):
-        self.exporter.shutdown()
-        AIAgentsInstrumentor().uninstrument()
-        trace._TRACER_PROVIDER = None
-        os.environ.pop(CONTENT_TRACING_ENV_VARIABLE, None)
-
     # helper function: create client and using environment variables
     def create_client(self, **kwargs):
         # fetch environment variables
@@ -227,13 +212,38 @@ def set_env_var(var_name, value):
     @agentClientPreparer()
     @recorded_by_proxy
     def test_agent_chat_with_tracing_content_recording_enabled(self, **kwargs):
+        # Note: The proper way to invoke the same test over and over again with different parameter values is to use @pytest.mark.parametrize. However,
+        # this does not work together with @recorded_by_proxy. So we call the helper function 4 times instead in a single recorded test.
+        self._agent_chat_with_tracing_content_recording_enabled(message_creation_mode=MessageCreationMode.MESSAGE_CREATE_STR, **kwargs)
+        self._agent_chat_with_tracing_content_recording_enabled(message_creation_mode=MessageCreationMode.MESSAGE_CREATE_INPUT_TEXT_BLOCK, **kwargs)
+        self._agent_chat_with_tracing_content_recording_enabled(message_creation_mode=MessageCreationMode.THREAD_CREATE_STR, **kwargs)
+        self._agent_chat_with_tracing_content_recording_enabled(message_creation_mode=MessageCreationMode.THREAD_CREATE_INPUT_TEXT_BLOCK, **kwargs)
+
+    def _agent_chat_with_tracing_content_recording_enabled(self, message_creation_mode: MessageCreationMode, **kwargs):
+        self.cleanup()
+        os.environ.update({CONTENT_TRACING_ENV_VARIABLE: "True"})
+        self.setup_telemetry()
         assert True == AIAgentsInstrumentor().is_content_recording_enabled()
         assert True == AIAgentsInstrumentor().is_instrumented()
 
         client = self.create_client(**kwargs)
         agent = client.create_agent(model="gpt-4o-mini", name="my-agent", instructions="You are helpful agent")
-        thread = client.threads.create()
-        client.messages.create(thread_id=thread.id, role="user", content="Hello, tell me a joke")
+        user_content = "Hello, tell me a joke"
+
+        # Test 4 different patterns of thread & message creation
+        if message_creation_mode == MessageCreationMode.MESSAGE_CREATE_STR:
+            thread = client.threads.create()
+            client.messages.create(thread_id=thread.id, role="user", content=user_content)
+        elif message_creation_mode == MessageCreationMode.MESSAGE_CREATE_INPUT_TEXT_BLOCK:
+            thread = client.threads.create()
+            client.messages.create(thread_id=thread.id, role="user", content=[MessageInputTextBlock(text=user_content)])
+        elif message_creation_mode == MessageCreationMode.THREAD_CREATE_STR:
+            thread = client.threads.create(messages=[ThreadMessageOptions(role="user", content=user_content)])
+        elif message_creation_mode == MessageCreationMode.THREAD_CREATE_INPUT_TEXT_BLOCK:
+            thread = client.threads.create(messages=[ThreadMessageOptions(role="user", content=[MessageInputTextBlock(text=user_content)])])
+        else:
+            assert False, f"Unknown message creation mode: {message_creation_mode}"
+
         run = client.runs.create(thread_id=thread.id, agent_id=agent.id)
 
         while run.status in ["queued", "in_progress", "requires_action"]:
@@ -250,6 +260,7 @@ def test_agent_chat_with_tracing_content_recording_enabled(self, **kwargs):
         assert len(messages) > 1
         client.close()
 
+        # ------------------------- Validate "create_agent" span ---------------------------------
         self.exporter.force_flush()
         spans = self.exporter.get_spans_by_name("create_agent my-agent")
         assert len(spans) == 1
@@ -277,6 +288,7 @@ def test_agent_chat_with_tracing_content_recording_enabled(self, **kwargs):
         events_match = GenAiTraceVerifier().check_span_events(span, expected_events)
         assert events_match == True
 
+        # ------------------------- Validate "create_thread" span ---------------------------------
         spans = self.exporter.get_spans_by_name("create_thread")
         assert len(spans) == 1
         span = spans[0]
@@ -289,32 +301,48 @@ def test_agent_chat_with_tracing_content_recording_enabled(self, **kwargs):
         attributes_match = GenAiTraceVerifier().check_span_attributes(span, expected_attributes)
         assert attributes_match == True
 
-        spans = self.exporter.get_spans_by_name("create_message")
-        assert len(spans) == 1
-        span = spans[0]
-        expected_attributes = [
-            ("gen_ai.system", "az.ai.agents"),
-            ("gen_ai.operation.name", "create_message"),
-            ("server.address", ""),
-            ("gen_ai.thread.id", ""),
-            ("gen_ai.message.id", ""),
-        ]
-        attributes_match = GenAiTraceVerifier().check_span_attributes(span, expected_attributes)
-        assert attributes_match == True
-
-        expected_events = [
-            {
-                "name": "gen_ai.user.message",
-                "attributes": {
-                    "gen_ai.system": "az.ai.agents",
-                    "gen_ai.thread.id": "*",
-                    "gen_ai.event.content": '{"content": "Hello, tell me a joke", "role": "user"}',
-                },
-            }
-        ]
-        events_match = GenAiTraceVerifier().check_span_events(span, expected_events)
-        assert events_match == True
-
+        if message_creation_mode in (MessageCreationMode.THREAD_CREATE_STR, MessageCreationMode.THREAD_CREATE_INPUT_TEXT_BLOCK):
+            expected_events = [
+                {
+                    "name": "gen_ai.user.message",
+                    "attributes": {
+                        "gen_ai.system": "az.ai.agents",
+                        "gen_ai.event.content": '{"content": "Hello, tell me a joke", "role": "user"}',
+                    },
+                }
+            ]
+            events_match = GenAiTraceVerifier().check_span_events(span, expected_events)
+            assert events_match == True
+
+        # ------------------------- Validate "create_message" span ---------------------------------
+        if message_creation_mode in (MessageCreationMode.MESSAGE_CREATE_STR, MessageCreationMode.MESSAGE_CREATE_INPUT_TEXT_BLOCK):
+            spans = self.exporter.get_spans_by_name("create_message")
+            assert len(spans) == 1
+            span = spans[0]
+            expected_attributes = [
+                ("gen_ai.system", "az.ai.agents"),
+                ("gen_ai.operation.name", "create_message"),
+                ("server.address", ""),
+                ("gen_ai.thread.id", ""),
+                ("gen_ai.message.id", ""),
+            ]
+            attributes_match = GenAiTraceVerifier().check_span_attributes(span, expected_attributes)
+            assert attributes_match == True
+
+            expected_events = [
+                {
+                    "name": "gen_ai.user.message",
+                    "attributes": {
+                        "gen_ai.system": "az.ai.agents",
+                        "gen_ai.thread.id": "*",
+                        "gen_ai.event.content": '{"content": "Hello, tell me a joke", "role": "user"}',
+                    },
+                }
+            ]
+            events_match = GenAiTraceVerifier().check_span_events(span, expected_events)
+            assert events_match == True
+
+        # ------------------------- Validate "start_thread_run" span ---------------------------------
         spans = self.exporter.get_spans_by_name("start_thread_run")
         assert len(spans) == 1
         span = spans[0]
@@ -332,6 +360,7 @@ def test_agent_chat_with_tracing_content_recording_enabled(self, **kwargs):
         attributes_match = GenAiTraceVerifier().check_span_attributes(span, expected_attributes)
         assert attributes_match == True
 
+        # ------------------------- Validate "get_thread_run" span ---------------------------------
         spans = self.exporter.get_spans_by_name("get_thread_run")
         assert len(spans) >= 1
         span = spans[-1]
@@ -350,6 +379,7 @@ def test_agent_chat_with_tracing_content_recording_enabled(self, **kwargs):
         attributes_match = GenAiTraceVerifier().check_span_attributes(span, expected_attributes)
         assert attributes_match == True
 
+        # ------------------------- Validate "list_messages" span ---------------------------------
         spans = self.exporter.get_spans_by_name("list_messages")
         assert len(spans) == 2
         span = spans[0]