Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
alexander-alderman-webb wants to merge 1 commit into
base: webb/openai/completions-input
Choose a base branch
from
Draft

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions sentry_sdk/integrations/openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,10 +361,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)
Expand Down Expand Up @@ -614,12 +610,14 @@ def _new_chat_completion_common(f: "Any", *args: "Any", **kwargs: "Any") -> "Any
span.__enter__()

span.set_data(SPANDATA.GEN_AI_SYSTEM, "openai")
is_streaming_response = kwargs.get("stream", 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
Expand Down
4 changes: 4 additions & 0 deletions tests/integrations/openai/test_openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading