fix(openai): Always set gen_ai.response.streaming for Completions (#5692)

Author: alexander-alderman-webb

sentry_sdk/integrations/openai.py

@@ -359,10 +359,6 @@ def _set_completions_api_input_data(
     if model is not None:
         span.set_data(SPANDATA.GEN_AI_REQUEST_MODEL, model)
 
-    stream = kwargs.get("stream")
-    if stream is not None and _is_given(stream):
-        span.set_data(SPANDATA.GEN_AI_RESPONSE_STREAMING, stream)
-
     max_tokens = kwargs.get("max_tokens")
     if max_tokens is not None and _is_given(max_tokens):
         span.set_data(SPANDATA.GEN_AI_REQUEST_MAX_TOKENS, max_tokens)
@@ -584,12 +580,16 @@ def _new_chat_completion_common(f: "Any", *args: "Any", **kwargs: "Any") -> "Any
     span.__enter__()
 
     span.set_data(SPANDATA.GEN_AI_SYSTEM, "openai")
+
+    # Same bool handling as in https://github.com/openai/openai-python/blob/acd0c54d8a68efeedde0e5b4e6c310eef1ce7867/src/openai/resources/completions.py#L585
+    is_streaming_response = kwargs.get("stream", False) or False
+    span.set_data(SPANDATA.GEN_AI_RESPONSE_STREAMING, is_streaming_response)
+
     _set_completions_api_input_data(span, kwargs, integration)
 
     start_time = time.perf_counter()
     response = yield f, args, kwargs
 
-    is_streaming_response = kwargs.get("stream", False)
     if is_streaming_response:
         _set_streaming_completions_api_output_data(
             span, response, kwargs, integration, start_time, finish_span=True

tests/integrations/openai/test_openai.py

@@ -167,6 +167,7 @@ def test_nonstreaming_chat_completion_no_prompts(
     span = tx["spans"][0]
     assert span["op"] == "gen_ai.chat"
     assert span["data"][SPANDATA.GEN_AI_SYSTEM] == "openai"
+    assert span["data"][SPANDATA.GEN_AI_RESPONSE_STREAMING] is False
 
     assert span["data"][SPANDATA.GEN_AI_REQUEST_MODEL] == "some-model"
     assert span["data"][SPANDATA.GEN_AI_REQUEST_MAX_TOKENS] == 100
@@ -259,6 +260,7 @@ def test_nonstreaming_chat_completion(sentry_init, capture_events, messages, req
     span = tx["spans"][0]
     assert span["op"] == "gen_ai.chat"
     assert span["data"][SPANDATA.GEN_AI_SYSTEM] == "openai"
+    assert span["data"][SPANDATA.GEN_AI_RESPONSE_STREAMING] is False
 
     assert span["data"][SPANDATA.GEN_AI_REQUEST_MODEL] == "some-model"
     assert span["data"][SPANDATA.GEN_AI_REQUEST_MAX_TOKENS] == 100
@@ -338,6 +340,7 @@ async def test_nonstreaming_chat_completion_async_no_prompts(
     span = tx["spans"][0]
     assert span["op"] == "gen_ai.chat"
     assert span["data"][SPANDATA.GEN_AI_SYSTEM] == "openai"
+    assert span["data"][SPANDATA.GEN_AI_RESPONSE_STREAMING] is False
 
     assert span["data"][SPANDATA.GEN_AI_REQUEST_MODEL] == "some-model"
     assert span["data"][SPANDATA.GEN_AI_REQUEST_MAX_TOKENS] == 100
@@ -430,6 +433,7 @@ async def test_nonstreaming_chat_completion_async(
     span = tx["spans"][0]
     assert span["op"] == "gen_ai.chat"
     assert span["data"][SPANDATA.GEN_AI_SYSTEM] == "openai"
+    assert span["data"][SPANDATA.GEN_AI_RESPONSE_STREAMING] is False
 
     assert span["data"][SPANDATA.GEN_AI_REQUEST_MODEL] == "some-model"
     assert span["data"][SPANDATA.GEN_AI_REQUEST_MAX_TOKENS] == 100