Draft: introduce typed generative AI operation names

sentry_sdk/consts.py

@@ -117,6 +117,19 @@ def __str__(self) -> str:
         return self.value
 
 
+class GEN_AI_OPERATION(str, Enum):
+    """Semantic operation names used in gen_ai.operation.name span data."""
+
+    CHAT = "chat"
+    CREATE_AGENT = "create_agent"
+    EMBEDDINGS = "embeddings"
+    EVALUATE = "evaluate"
+    EXECUTE_TOOL = "execute_tool"
+    HANDOFF = "handoff"
+    INVOKE_AGENT = "invoke_agent"
+    TEXT_COMPLETION = "text_completion"
+
+
 class INSTRUMENTER:
     SENTRY = "sentry"
     OTEL = "otel"

sentry_sdk/integrations/openai_agents/spans/invoke_agent.py

@@ -7,7 +7,7 @@
     set_data_normalized,
     truncate_and_annotate_messages,
 )
-from sentry_sdk.consts import OP, SPANDATA
+from sentry_sdk.consts import GEN_AI_OPERATION, OP, SPANDATA
 from sentry_sdk.scope import should_send_default_pii
 from sentry_sdk.traces import StreamedSpan
 from sentry_sdk.tracing_utils import (
@@ -36,7 +36,7 @@ def invoke_agent_span(
             attributes={
                 "sentry.op": OP.GEN_AI_INVOKE_AGENT,
                 "sentry.origin": SPAN_ORIGIN,
-                SPANDATA.GEN_AI_OPERATION_NAME: "invoke_agent",
+                SPANDATA.GEN_AI_OPERATION_NAME: GEN_AI_OPERATION.INVOKE_AGENT,
             },
         )
     else:
@@ -48,7 +48,7 @@ def invoke_agent_span(
         )
         span.__enter__()
 
-        span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, "invoke_agent")
+        span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, GEN_AI_OPERATION.INVOKE_AGENT)
 
     record_inputs = False
     if has_data_collection_enabled(client_options):

tests/test_gen_ai_operation.py

@@ -0,0 +1,12 @@
+from sentry_sdk.consts import GEN_AI_OPERATION
+
+
+def test_gen_ai_operation_names_are_string_compatible():
+    assert GEN_AI_OPERATION.INVOKE_AGENT == "invoke_agent"
+    assert isinstance(GEN_AI_OPERATION.INVOKE_AGENT, str)
+    assert GEN_AI_OPERATION.EMBEDDINGS == "embeddings"
+
+
+def test_gen_ai_operation_names_are_unique():
+    values = [operation.value for operation in GEN_AI_OPERATION]
+    assert len(values) == len(set(values))