remove superfluous comments and use the constants everywhere

Author: shellmayr

sentry_sdk/ai/utils.py

@@ -17,15 +17,13 @@ class GEN_AI_ALLOWED_MESSAGE_ROLES:
     TOOL_CALL = "tool_call"
 
 
-# Gen AI message role reverse mapping showing allowed target roles and their source variants
 GEN_AI_MESSAGE_ROLE_REVERSE_MAPPING = {
     GEN_AI_ALLOWED_MESSAGE_ROLES.SYSTEM: ["system"],
     GEN_AI_ALLOWED_MESSAGE_ROLES.USER: ["user"],
     GEN_AI_ALLOWED_MESSAGE_ROLES.ASSISTANT: ["assistant", "ai"],
     GEN_AI_ALLOWED_MESSAGE_ROLES.TOOL_CALL: ["tool_call"],
 }
 
-# Convert reverse mapping to actual mapping for efficient lookups
 GEN_AI_MESSAGE_ROLE_MAPPING = {}
 for target_role, source_roles in GEN_AI_MESSAGE_ROLE_REVERSE_MAPPING.items():
     for source_role in source_roles:

sentry_sdk/integrations/anthropic.py

@@ -144,7 +144,6 @@ def _set_input_data(span, kwargs, integration):
             else:
                 normalized_messages.append(message)
 
-        # Further normalize message roles to standard gen_ai values
         role_normalized_messages = normalize_message_roles(normalized_messages)
         set_data_normalized(
             span,

sentry_sdk/integrations/langgraph.py

@@ -180,7 +180,6 @@ def new_invoke(self, *args, **kwargs):
             ):
                 input_messages = _parse_langgraph_messages(args[0])
                 if input_messages:
-                    # Normalize message roles to standard gen_ai values
                     normalized_input_messages = normalize_message_roles(input_messages)
                     set_data_normalized(
                         span,
@@ -232,7 +231,6 @@ async def new_ainvoke(self, *args, **kwargs):
             ):
                 input_messages = _parse_langgraph_messages(args[0])
                 if input_messages:
-                    # Normalize message roles to standard gen_ai values
                     normalized_input_messages = normalize_message_roles(input_messages)
                     set_data_normalized(
                         span,

sentry_sdk/integrations/openai.py

@@ -182,7 +182,6 @@ def _set_input_data(span, kwargs, operation, integration):
         and should_send_default_pii()
         and integration.include_prompts
     ):
-        # Normalize message roles to standard gen_ai values
         normalized_messages = normalize_message_roles(messages)
         set_data_normalized(
             span, SPANDATA.GEN_AI_REQUEST_MESSAGES, normalized_messages, unpack=False

sentry_sdk/integrations/openai_agents/spans/invoke_agent.py

@@ -60,7 +60,6 @@ def invoke_agent_span(context, agent, kwargs):
             )
 
         if len(messages) > 0:
-            # Normalize message roles to standard gen_ai values
             normalized_messages = normalize_message_roles(messages)
             set_data_normalized(
                 span,

sentry_sdk/integrations/openai_agents/utils.py

@@ -1,5 +1,6 @@
 import sentry_sdk
 from sentry_sdk.ai.utils import (
+    GEN_AI_ALLOWED_MESSAGE_ROLES,
     normalize_message_roles,
     set_data_normalized,
     normalize_message_role,
@@ -104,7 +105,7 @@ def _set_input_data(span, get_response_kwargs):
     if system_instructions:
         request_messages.append(
             {
-                "role": "system",
+                "role": GEN_AI_ALLOWED_MESSAGE_ROLES.SYSTEM,
                 "content": [{"type": "text", "text": system_instructions}],
             }
         )
@@ -120,9 +121,19 @@ def _set_input_data(span, get_response_kwargs):
             )
         else:
             if message.get("type") == "function_call":
-                request_messages.append({"role": "assistant", "content": [message]})
+                request_messages.append(
+                    {
+                        "role": GEN_AI_ALLOWED_MESSAGE_ROLES.ASSISTANT,
+                        "content": [message],
+                    }
+                )
             elif message.get("type") == "function_call_output":
-                request_messages.append({"role": "tool", "content": [message]})
+                request_messages.append(
+                    {
+                        "role": GEN_AI_ALLOWED_MESSAGE_ROLES.TOOL_CALL,
+                        "content": [message],
+                    }
+                )
 
     set_data_normalized(
         span,