Skip to content

feat(openai): Deprecate include_prompts parameter in favour of data_collection options #7034

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

Open
ericapisani wants to merge 1 commit into
base: master
Choose a base branch
from
+21 −92
Open

feat(openai): Deprecate include_prompts parameter in favour of data_collection options #7034

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
19 changes: 2 additions & 17 deletions sentry_sdk/integrations/openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,10 +371,7 @@ def _set_responses_api_input_data(

client_options = sentry_sdk.get_client().options
if has_data_collection_enabled(client_options):
if (
integration.include_prompts
and client_options["data_collection"]["gen_ai"]["inputs"]
):
if client_options["data_collection"]["gen_ai"]["inputs"]:
tools = kwargs.get("tools")
if tools is not None and _is_given(tools):
set_on_span(
Expand All @@ -394,9 +391,6 @@ def _set_responses_api_input_data(
)

if has_data_collection_enabled(client_options):
# This takes precedence over the global data collection settings
if not integration.include_prompts:
return
if not client_options["data_collection"]["gen_ai"]["inputs"]:
return
elif not should_send_default_pii() or not integration.include_prompts:
Comment thread
ericapisani marked this conversation as resolved.
Expand Down Expand Up @@ -519,10 +513,7 @@ def _set_completions_api_input_data(

client = sentry_sdk.get_client()
if has_data_collection_enabled(client.options):
if (
integration.include_prompts
and client.options["data_collection"]["gen_ai"]["inputs"]
):
if client.options["data_collection"]["gen_ai"]["inputs"]:
tools = kwargs.get("tools")
if tools is not None and _is_given(tools):
set_on_span(
Expand All @@ -546,9 +537,6 @@ def _set_completions_api_input_data(
)

if has_data_collection_enabled(client.options):
# This takes precedence over the global data collection settings
if not integration.include_prompts:
return
if not client.options["data_collection"]["gen_ai"]["inputs"]:
return
elif not should_send_default_pii() or not integration.include_prompts:
Expand Down Expand Up @@ -627,9 +615,6 @@ def _set_embeddings_input_data(

client = sentry_sdk.get_client()
if has_data_collection_enabled(client.options):
# This takes precedence over the global data collection settings
if not integration.include_prompts:
return
if not client.options["data_collection"]["gen_ai"]["inputs"]:
return
elif not should_send_default_pii() or not integration.include_prompts:
Expand Down
94 changes: 19 additions & 75 deletions tests/integrations/openai/test_openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,11 +666,10 @@ def test_nonstreaming_chat_completion(
@pytest.mark.parametrize("span_streaming", [True, False])
@pytest.mark.parametrize("stream_gen_ai_spans", [True, False])
@pytest.mark.parametrize(
"data_collection,include_prompts,expected_present,expected_absent",
"data_collection,expected_present,expected_absent",
[
pytest.param(
{"gen_ai": {"inputs": True}},
True,
{
SPANDATA.GEN_AI_SYSTEM_INSTRUCTIONS: json.dumps(
[{"type": "text", "content": "You are a helpful assistant."}]
Expand All @@ -681,22 +680,20 @@ def test_nonstreaming_chat_completion(
SPANDATA.GEN_AI_TOOL_DEFINITIONS: safe_serialize(EXAMPLE_TOOLS),
},
[],
id="inputs-enabled",
id="gen-ai-inputs-enabled",
),
pytest.param(
{"gen_ai": {"inputs": False}},
True,
{},
[
SPANDATA.GEN_AI_SYSTEM_INSTRUCTIONS,
SPANDATA.GEN_AI_REQUEST_MESSAGES,
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
],
id="inputs-disabled",
id="gen-ai-inputs-disabled",
),
pytest.param(
{},
True,
{
SPANDATA.GEN_AI_SYSTEM_INSTRUCTIONS: json.dumps(
[{"type": "text", "content": "You are a helpful assistant."}]
Expand All @@ -709,33 +706,21 @@ def test_nonstreaming_chat_completion(
[],
id="gen-ai-omitted-defaults-to-enabled",
),
pytest.param(
{"gen_ai": {"inputs": True}},
False,
{},
[
SPANDATA.GEN_AI_SYSTEM_INSTRUCTIONS,
SPANDATA.GEN_AI_REQUEST_MESSAGES,
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
],
id="include-prompts-disabled-overrides-inputs-enabled",
),
],
)
def test_completions_api_data_collection(
sentry_init,
capture_events,
capture_items,
data_collection,
include_prompts,
expected_present,
expected_absent,
nonstreaming_chat_completions_model_response,
stream_gen_ai_spans,
span_streaming,
):
sentry_init(
integrations=[OpenAIIntegration(include_prompts=include_prompts)],
integrations=[OpenAIIntegration()],
disabled_integrations=[StdlibIntegration],
traces_sample_rate=1.0,
_experiments={"data_collection": data_collection},
Expand Down Expand Up @@ -3013,49 +2998,37 @@ def _collect_embeddings_span_data(
@pytest.mark.parametrize("span_streaming", [True, False])
@pytest.mark.parametrize("stream_gen_ai_spans", [True, False])
@pytest.mark.parametrize(
"data_collection,send_default_pii,include_prompts,expect_input",
"data_collection,send_default_pii,expect_input",
[
pytest.param(
{"gen_ai": {"inputs": True}},
False,
True,
True,
id="inputs-enabled-overrides-pii-disabled",
id="gen-ai-inputs-enabled-overrides-pii-disabled",
),
pytest.param(
{"gen_ai": {"inputs": False}},
True,
True,
False,
id="inputs-disabled-overrides-pii-enabled",
id="gen-ai-inputs-disabled-overrides-pii-enabled",
),
pytest.param(
{},
False,
True,
True,
id="gen-ai-omitted-defaults-to-enabled",
),
pytest.param(
{"gen_ai": {"inputs": False}},
False,
True,
False,
id="inputs-disabled-and-pii-disabled",
),
pytest.param(
{"gen_ai": {"inputs": True}},
True,
False,
False,
id="include-prompts-disabled-overrides-inputs-enabled",
id="gen-ai-inputs-disabled-and-pii-disabled",
),
pytest.param(
None,
False,
True,
False,
id="no-experiment-falls-back-to-pii",
id="no-gen-ai-data-collection-falls-back-to-send-default-pii",
),
],
)
Expand All @@ -3065,13 +3038,12 @@ def test_embeddings_create_data_collection(
capture_items,
data_collection,
send_default_pii,
include_prompts,
expect_input,
stream_gen_ai_spans,
span_streaming,
):
init_kwargs = {
"integrations": [OpenAIIntegration(include_prompts=include_prompts)],
"integrations": [OpenAIIntegration()],
"disabled_integrations": [StdlibIntegration],
"traces_sample_rate": 1.0,
"send_default_pii": send_default_pii,
Expand Down Expand Up @@ -3429,40 +3401,29 @@ async def test_embeddings_create_async(
@pytest.mark.parametrize("stream_gen_ai_spans", [True, False])
@pytest.mark.asyncio
@pytest.mark.parametrize(
"data_collection,send_default_pii,include_prompts,expect_input",
"data_collection,send_default_pii,expect_input",
[
pytest.param(
{"gen_ai": {"inputs": True}},
False,
True,
True,
id="inputs-enabled-overrides-pii-disabled",
id="gen-ai-inputs-enabled-overrides-pii-disabled",
),
pytest.param(
{"gen_ai": {"inputs": False}},
True,
True,
False,
id="inputs-disabled-overrides-pii-enabled",
id="gen-ai-inputs-disabled-overrides-pii-enabled",
),
pytest.param(
{},
False,
True,
True,
id="gen-ai-omitted-defaults-to-enabled",
),
pytest.param(
{"gen_ai": {"inputs": True}},
True,
False,
False,
id="include-prompts-disabled-overrides-inputs-enabled",
),
pytest.param(
None,
False,
True,
False,
id="no-experiment-falls-back-to-pii",
),
Expand All @@ -3474,13 +3435,12 @@ async def test_embeddings_create_async_data_collection(
capture_items,
data_collection,
send_default_pii,
include_prompts,
expect_input,
stream_gen_ai_spans,
span_streaming,
):
init_kwargs = {
"integrations": [OpenAIIntegration(include_prompts=include_prompts)],
"integrations": [OpenAIIntegration()],
"disabled_integrations": [StdlibIntegration],
"traces_sample_rate": 1.0,
"send_default_pii": send_default_pii,
Expand Down Expand Up @@ -5235,7 +5195,7 @@ def test_ai_client_span_responses_api(
},
[],
True,
id="inputs-enabled-string-input",
id="gen-ai-inputs-enabled-string-input",
),
pytest.param(
{"gen_ai": {"inputs": True}},
Expand All @@ -5257,7 +5217,7 @@ def test_ai_client_span_responses_api(
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
],
True,
id="inputs-enabled-instructions-only",
id="gen-ai-inputs-enabled-instructions-only",
),
pytest.param(
{"gen_ai": {"inputs": True}},
Expand All @@ -5284,7 +5244,7 @@ def test_ai_client_span_responses_api(
},
[SPANDATA.GEN_AI_TOOL_DEFINITIONS],
True,
id="inputs-enabled-list-input-with-system-message",
id="gen-ai-inputs-enabled-list-input-with-system-message",
),
pytest.param(
{"gen_ai": {"inputs": False}},
Expand All @@ -5300,7 +5260,7 @@ def test_ai_client_span_responses_api(
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
],
True,
id="inputs-disabled",
id="gen-ai-inputs-disabled",
),
pytest.param(
{},
Expand Down Expand Up @@ -5328,23 +5288,7 @@ def test_ai_client_span_responses_api(
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
],
True,
id="inputs-enabled-no-input-provided",
),
pytest.param(
{"gen_ai": {"inputs": True}},
{
"instructions": "You are a coding assistant that talks like a pirate.",
"input": "How do I check if a Python object is an instance of a class?",
"tools": EXAMPLE_TOOLS,
},
{},
[
SPANDATA.GEN_AI_REQUEST_MESSAGES,
SPANDATA.GEN_AI_SYSTEM_INSTRUCTIONS,
SPANDATA.GEN_AI_TOOL_DEFINITIONS,
],
False,
id="include-prompts-disabled-overrides-inputs-enabled",
id="gen-ai-inputs-enabled-no-input-provided",
),
],
)
Expand Down
Loading