add support for execute tool input and output types

Author: nikhilc-microsoft

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/__init__.py

@@ -47,6 +47,10 @@
     TextPart,
     ToolCallRequestPart,
     ToolCallResponsePart,
+    ToolInputMessage,
+    ToolInputMessages,
+    ToolOutputMessage,
+    ToolOutputMessages,
     UriPart,
 )
 from .models.response import Response
@@ -122,6 +126,10 @@
     "OutputMessages",
     "InputMessagesParam",
     "OutputMessagesParam",
+    "ToolInputMessage",
+    "ToolOutputMessage",
+    "ToolInputMessages",
+    "ToolOutputMessages",
     # Utility functions
     "extract_context_from_headers",
     "get_traceparent",

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/execute_tool_scope.py

@@ -12,6 +12,7 @@
     GEN_AI_CONVERSATION_ID_KEY,
     GEN_AI_TOOL_ARGS_KEY,
     GEN_AI_TOOL_CALL_ID_KEY,
+    GEN_AI_TOOL_CALL_RESULT_KEY,
     GEN_AI_TOOL_DESCRIPTION_KEY,
     GEN_AI_TOOL_NAME_KEY,
     GEN_AI_TOOL_TYPE_KEY,
@@ -21,6 +22,8 @@
     USER_ID_KEY,
     USER_NAME_KEY,
 )
+from .message_utils import serialize_messages
+from .models.messages import ToolInputMessages, ToolOutputMessages
 from .models.user_details import UserDetails
 from .opentelemetry_scope import OpenTelemetryScope
 from .request import Request
@@ -108,7 +111,8 @@ def __init__(
         endpoint = details.endpoint
 
         self.set_tag_maybe(GEN_AI_TOOL_NAME_KEY, tool_name)
-        self.set_tag_maybe(GEN_AI_TOOL_ARGS_KEY, arguments)
+        if arguments is not None:
+            self.record_tool_input(arguments)
         self.set_tag_maybe(GEN_AI_TOOL_TYPE_KEY, tool_type)
         self.set_tag_maybe(GEN_AI_TOOL_CALL_ID_KEY, tool_call_id)
         self.set_tag_maybe(GEN_AI_TOOL_DESCRIPTION_KEY, description)
@@ -134,13 +138,18 @@ def __init__(
                 validate_and_normalize_ip(user_details.user_client_ip),
             )
 
-    def record_response(self, response: str) -> None:
-        """Records response information for telemetry tracking.
+    def record_tool_input(self, messages: ToolInputMessages) -> None:
+        """Record the tool input for telemetry tracking.
 
-        Note: This method is intentionally a no-op as GEN_AI_EVENT_CONTENT was removed.
-        The method is kept for interface compatibility.
+        Args:
+            messages: A ToolInputMessages wrapper containing tool call requests
+        """
+        self.set_tag_maybe(GEN_AI_TOOL_ARGS_KEY, serialize_messages(messages))
+
+    def record_tool_output(self, messages: ToolOutputMessages) -> None:
+        """Record the tool output for telemetry tracking.
 
         Args:
-            response: The response to record
+            messages: A ToolOutputMessages wrapper containing tool call responses
         """
-        pass
+        self.set_tag_maybe(GEN_AI_TOOL_CALL_RESULT_KEY, serialize_messages(messages))

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/message_utils.py

@@ -12,6 +12,7 @@
 import json
 import logging
 from dataclasses import asdict
+from enum import Enum
 from typing import Union
 
 from .models.messages import (
@@ -24,6 +25,8 @@
     OutputMessages,
     OutputMessagesParam,
     TextPart,
+    ToolInputMessages,
+    ToolOutputMessages,
 )
 
 logger = logging.getLogger(__name__)
@@ -37,10 +40,10 @@ def is_string_list(
 
 
 def is_wrapped_messages(
-    param: Union[InputMessagesParam, OutputMessagesParam],
+    param: Union[InputMessagesParam, OutputMessagesParam, ToolInputMessages, ToolOutputMessages],
 ) -> bool:
-    """Return ``True`` when *param* is a versioned wrapper (``InputMessages`` or ``OutputMessages``)."""
-    return isinstance(param, (InputMessages, OutputMessages))
+    """Return ``True`` when *param* is a versioned wrapper."""
+    return isinstance(param, (InputMessages, OutputMessages, ToolInputMessages, ToolOutputMessages))
 
 
 # ---------------------------------------------------------------------------
@@ -51,15 +54,15 @@ def is_wrapped_messages(
 def to_input_messages(messages: list[str]) -> list[ChatMessage]:
     """Convert plain input strings into OTEL ``ChatMessage`` objects."""
     return [
-        ChatMessage(role=MessageRole.USER.value, parts=[TextPart(content=content)])
+        ChatMessage(role=MessageRole.USER, parts=[TextPart(content=content)])
         for content in messages
     ]
 
 
 def to_output_messages(messages: list[str]) -> list[OutputMessage]:
     """Convert plain output strings into OTEL ``OutputMessage`` objects."""
     return [
-        OutputMessage(role=MessageRole.ASSISTANT.value, parts=[TextPart(content=content)])
+        OutputMessage(role=MessageRole.ASSISTANT, parts=[TextPart(content=content)])
         for content in messages
     ]
 
@@ -97,11 +100,16 @@ def normalize_output_messages(param: OutputMessagesParam) -> OutputMessages:
 
 
 def _message_dict_factory(items: list[tuple[str, object]]) -> dict[str, object]:
-    """Custom dict factory for ``dataclasses.asdict`` that drops ``None`` values."""
-    return {k: v for k, v in items if v is not None}
+    """Custom dict factory for ``dataclasses.asdict``.
+
+    Drops ``None`` values and converts enum members to their string value.
+    """
+    return {k: (v.value if isinstance(v, Enum) else v) for k, v in items if v is not None}
 
 
-def serialize_messages(wrapper: Union[InputMessages, OutputMessages]) -> str:
+def serialize_messages(
+    wrapper: Union[InputMessages, OutputMessages, ToolInputMessages, ToolOutputMessages],
+) -> str:
     """Serialize a versioned message wrapper to JSON.
 
     The output is the full wrapper object:

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/models/messages.py

@@ -168,7 +168,7 @@ class GenericPart:
 class ChatMessage:
     """An input message sent to a model (OTEL gen-ai semantic conventions)."""
 
-    role: str
+    role: MessageRole
     parts: list[MessagePart] = field(default_factory=list)
     name: str | None = None
 
@@ -180,6 +180,24 @@ class OutputMessage(ChatMessage):
     finish_reason: str | None = None
 
 
+@dataclass
+class ToolInputMessage:
+    """A tool input message representing a tool call request."""
+
+    role: MessageRole
+    parts: list[ToolCallRequestPart] = field(default_factory=list)
+    name: str | None = None
+
+
+@dataclass
+class ToolOutputMessage:
+    """A tool output message representing a tool call response."""
+
+    role: MessageRole
+    parts: list[ToolCallResponsePart] = field(default_factory=list)
+    name: str | None = None
+
+
 # ---------------------------------------------------------------------------
 # Versioned wrappers
 # ---------------------------------------------------------------------------
@@ -204,6 +222,22 @@ class OutputMessages:
     version: str = field(default=A365_MESSAGE_SCHEMA_VERSION, init=False)
 
 
+@dataclass
+class ToolInputMessages:
+    """Versioned wrapper for tool input messages."""
+
+    messages: list[ToolInputMessage] = field(default_factory=list)
+    version: str = field(default=A365_MESSAGE_SCHEMA_VERSION, init=False)
+
+
+@dataclass
+class ToolOutputMessages:
+    """Versioned wrapper for tool output messages."""
+
+    messages: list[ToolOutputMessage] = field(default_factory=list)
+    version: str = field(default=A365_MESSAGE_SCHEMA_VERSION, init=False)
+
+
 # ---------------------------------------------------------------------------
 # Parameter type aliases (backward-compatible union types)
 # ---------------------------------------------------------------------------

libraries/microsoft-agents-a365-observability-core/microsoft_agents_a365/observability/core/tool_call_details.py

@@ -3,17 +3,21 @@
 
 # Data class for tool call details.
 
+from __future__ import annotations
+
 from dataclasses import dataclass
-from urllib.parse import ParseResult
+
+from .models.messages import ToolInputMessages
+from .models.service_endpoint import ServiceEndpoint
 
 
 @dataclass
 class ToolCallDetails:
     """Details of a tool call made by an agent in the system."""
 
     tool_name: str
-    arguments: str | None = None
+    arguments: ToolInputMessages | None = None
     tool_call_id: str | None = None
     description: str | None = None
     tool_type: str | None = None
-    endpoint: ParseResult | None = None
+    endpoint: ServiceEndpoint | None = None

tests/observability/core/test_custom_start_end_time.py

@@ -21,6 +21,12 @@
     get_tracer_provider,
 )
 from microsoft_agents_a365.observability.core.config import _telemetry_manager
+from microsoft_agents_a365.observability.core.models.messages import (
+    MessageRole,
+    ToolCallRequestPart,
+    ToolInputMessage,
+    ToolInputMessages,
+)
 from microsoft_agents_a365.observability.core.opentelemetry_scope import OpenTelemetryScope
 from opentelemetry.sdk.trace.export import SimpleSpanProcessor
 from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter
@@ -46,7 +52,14 @@ def setUpClass(cls):
         )
         cls.tool_details = ToolCallDetails(
             tool_name="test_tool",
-            arguments='{"arg": "value"}',
+            arguments=ToolInputMessages(
+                messages=[
+                    ToolInputMessage(
+                        role=MessageRole.ASSISTANT,
+                        parts=[ToolCallRequestPart(name="test_tool", arguments={"arg": "value"})],
+                    )
+                ]
+            ),
             tool_call_id="call-123",
         )
 

tests/observability/core/test_execute_tool_scope.py

@@ -23,6 +23,12 @@
     CHANNEL_LINK_KEY,
     CHANNEL_NAME_KEY,
 )
+from microsoft_agents_a365.observability.core.models.messages import (
+    MessageRole,
+    ToolCallRequestPart,
+    ToolInputMessage,
+    ToolInputMessages,
+)
 from microsoft_agents_a365.observability.core.opentelemetry_scope import OpenTelemetryScope
 from opentelemetry.sdk.trace.export import SimpleSpanProcessor
 from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter
@@ -50,7 +56,19 @@ def setUpClass(cls):
         )
         cls.tool_details = ToolCallDetails(
             tool_name="weather_tool",
-            arguments='{"location": "Seattle", "units": "metric"}',
+            arguments=ToolInputMessages(
+                messages=[
+                    ToolInputMessage(
+                        role=MessageRole.ASSISTANT,
+                        parts=[
+                            ToolCallRequestPart(
+                                name="weather_tool",
+                                arguments={"location": "Seattle", "units": "metric"},
+                            )
+                        ],
+                    )
+                ]
+            ),
             tool_call_id="call-123",
             description="Get current weather information for a location",
         )
@@ -79,14 +97,22 @@ def tearDown(self):
 
         self.span_exporter.clear()
 
-    def test_record_response_method_exists(self):
-        """Test that record_response method exists on ExecuteToolScope."""
+    def test_record_tool_input_method_exists(self):
+        """Test that record_tool_input method exists on ExecuteToolScope."""
+        scope = ExecuteToolScope.start(Request(), self.tool_details, self.agent_details)
+
+        if scope is not None:
+            self.assertTrue(hasattr(scope, "record_tool_input"))
+            self.assertTrue(callable(scope.record_tool_input))
+            scope.dispose()
+
+    def test_record_tool_output_method_exists(self):
+        """Test that record_tool_output method exists on ExecuteToolScope."""
         scope = ExecuteToolScope.start(Request(), self.tool_details, self.agent_details)
 
         if scope is not None:
-            # Test that the method exists
-            self.assertTrue(hasattr(scope, "record_response"))
-            self.assertTrue(callable(scope.record_response))
+            self.assertTrue(hasattr(scope, "record_tool_output"))
+            self.assertTrue(callable(scope.record_tool_output))
             scope.dispose()
 
     def test_request_metadata_set_on_span(self):