use semconv constants for output type values

Author: Nik-Reddy

instrumentation-genai/opentelemetry-instrumentation-openai-v2/src/opentelemetry/instrumentation/openai_v2/utils.py

@@ -282,7 +282,14 @@ def get_llm_request_attributes(
             # response_format may be string, object with a string in the `type` key,
             # or a type (e.g. Pydantic model class used with parse())
             if isinstance(response_format, type):
-                attributes[request_response_format_attr_key] = "json"
+                if latest_experimental_enabled:
+                    attributes[request_response_format_attr_key] = (
+                        GenAIAttributes.GenAiOutputTypeValues.JSON.value
+                    )
+                else:
+                    attributes[request_response_format_attr_key] = (
+                        GenAIAttributes.GenAiOpenaiRequestResponseFormatValues.JSON_SCHEMA.value
+                    )
             elif isinstance(response_format, Mapping):
                 if (
                     response_format_type := response_format.get("type")
@@ -369,7 +376,9 @@ def create_chat_invocation(
         # response_format may be string, object with a string in the `type` key,
         # or a type (e.g. Pydantic model class used with parse())
         if isinstance(response_format, type):
-            invocation.attributes[GenAIAttributes.GEN_AI_OUTPUT_TYPE] = "json"
+            invocation.attributes[GenAIAttributes.GEN_AI_OUTPUT_TYPE] = (
+                GenAIAttributes.GenAiOutputTypeValues.JSON.value
+            )
         elif isinstance(response_format, Mapping):
             if (
                 response_format_type := get_value(response_format.get("type"))

instrumentation-genai/opentelemetry-instrumentation-openai-v2/tests/structured_outputs_utils.py

@@ -20,7 +20,7 @@
 class CalendarEvent(BaseModel):
     name: str
     date: str
-    participants: list
+    participants: list[str]
 
 
 STRUCTURED_OUTPUT_PROMPT = [

instrumentation-genai/opentelemetry-instrumentation-openai-v2/tests/test_async_structured_outputs.py

@@ -52,6 +52,9 @@ async def test_async_structured_output_with_content(
             response_format=CalendarEvent,
         )
 
+    # Verify wrapper doesn't interfere with parse() return
+    assert response.choices[0].message.parsed is not None
+
     spans = span_exporter.get_finished_spans()
     assert len(spans) == 1
     assert_all_attributes(
@@ -69,7 +72,8 @@ async def test_async_structured_output_with_content(
         if latest_experimental_enabled
         else GenAIAttributes.GEN_AI_OPENAI_REQUEST_RESPONSE_FORMAT
     )
-    assert spans[0].attributes[output_type_attr_key] == "json_schema"
+    expected_value = "json" if latest_experimental_enabled else "json_schema"
+    assert spans[0].attributes[output_type_attr_key] == expected_value
 
     if latest_experimental_enabled:
         assert_messages_attribute(
@@ -78,18 +82,14 @@ async def test_async_structured_output_with_content(
         )
         assert_messages_attribute(
             spans[0].attributes["gen_ai.output.messages"],
-            format_simple_expected_output_message(
-                response.choices[0].message.content
-            ),
+            format_simple_expected_output_message(response.choices[0].message.content),
         )
     else:
         logs = log_exporter.get_finished_logs()
         assert len(logs) == 2
 
         user_message = {"content": STRUCTURED_OUTPUT_PROMPT[0]["content"]}
-        assert_message_in_logs(
-            logs[0], "gen_ai.user.message", user_message, spans[0]
-        )
+        assert_message_in_logs(logs[0], "gen_ai.user.message", user_message, spans[0])
 
         choice_event = {
             "index": 0,
@@ -99,9 +99,7 @@ async def test_async_structured_output_with_content(
                 "content": response.choices[0].message.content,
             },
         }
-        assert_message_in_logs(
-            logs[1], "gen_ai.choice", choice_event, spans[0]
-        )
+        assert_message_in_logs(logs[1], "gen_ai.choice", choice_event, spans[0])
 
 
 @pytest.mark.asyncio()
@@ -121,6 +119,9 @@ async def test_async_structured_output_no_content(
             response_format=CalendarEvent,
         )
 
+    # Verify wrapper doesn't interfere with parse() return
+    assert response.choices[0].message.parsed is not None
+
     spans = span_exporter.get_finished_spans()
     assert len(spans) == 1
     assert_all_attributes(
@@ -138,7 +139,8 @@ async def test_async_structured_output_no_content(
         if latest_experimental_enabled
         else GenAIAttributes.GEN_AI_OPENAI_REQUEST_RESPONSE_FORMAT
     )
-    assert spans[0].attributes[output_type_attr_key] == "json_schema"
+    expected_value = "json" if latest_experimental_enabled else "json_schema"
+    assert spans[0].attributes[output_type_attr_key] == expected_value
 
     logs = log_exporter.get_finished_logs()
     if latest_experimental_enabled:
@@ -155,6 +157,4 @@ async def test_async_structured_output_no_content(
             "finish_reason": "stop",
             "message": {"role": "assistant"},
         }
-        assert_message_in_logs(
-            logs[1], "gen_ai.choice", choice_event, spans[0]
-        )
+        assert_message_in_logs(logs[1], "gen_ai.choice", choice_event, spans[0])

instrumentation-genai/opentelemetry-instrumentation-openai-v2/tests/test_structured_outputs.py

@@ -45,6 +45,9 @@ def test_structured_output_with_content(
             response_format=CalendarEvent,
         )
 
+    # Verify wrapper doesn't interfere with parse() return
+    assert response.choices[0].message.parsed is not None
+
     spans = span_exporter.get_finished_spans()
     assert len(spans) == 1
     assert_all_attributes(
@@ -62,7 +65,8 @@ def test_structured_output_with_content(
         if latest_experimental_enabled
         else GenAIAttributes.GEN_AI_OPENAI_REQUEST_RESPONSE_FORMAT
     )
-    assert spans[0].attributes[output_type_attr_key] == "json"
+    expected_value = "json" if latest_experimental_enabled else "json_schema"
+    assert spans[0].attributes[output_type_attr_key] == expected_value
 
     if latest_experimental_enabled:
         assert_messages_attribute(
@@ -103,6 +107,9 @@ def test_structured_output_no_content(
             response_format=CalendarEvent,
         )
 
+    # Verify wrapper doesn't interfere with parse() return
+    assert response.choices[0].message.parsed is not None
+
     spans = span_exporter.get_finished_spans()
     assert len(spans) == 1
     assert_all_attributes(
@@ -120,7 +127,8 @@ def test_structured_output_no_content(
         if latest_experimental_enabled
         else GenAIAttributes.GEN_AI_OPENAI_REQUEST_RESPONSE_FORMAT
     )
-    assert spans[0].attributes[output_type_attr_key] == "json"
+    expected_value = "json" if latest_experimental_enabled else "json_schema"
+    assert spans[0].attributes[output_type_attr_key] == expected_value
 
     logs = log_exporter.get_finished_logs()
     if latest_experimental_enabled: