Skip to content

Commit 0bc39fb

Browse files
authored
fix(openai): treat openai Omit sentinels like NotGiven when logging (#1805)
1 parent 22f45e7 commit 0bc39fb

2 files changed

Lines changed: 108 additions & 26 deletions

File tree

‎langfuse/openai.py‎

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
from inspect import isawaitable, isclass
3333
from typing import Any, Optional, cast
3434

35+
from openai import _types as openai_types
3536
from openai._types import NotGiven
3637
from packaging.version import Version
3738
from pydantic import BaseModel
@@ -60,6 +61,13 @@
6061
except ImportError:
6162
RAW_RESPONSE_HEADER = "X-Stainless-Raw-Response"
6263

64+
_openai_omit_type = getattr(openai_types, "Omit", None)
65+
_OPENAI_UNSET_TYPES: tuple[type[Any], ...] = (
66+
(NotGiven, _openai_omit_type)
67+
if isinstance(_openai_omit_type, type)
68+
else (NotGiven,)
69+
)
70+
6371

6472
@dataclass
6573
class OpenAiDefinition:
@@ -207,7 +215,7 @@ class OpenAiDefinition:
207215

208216

209217
def _is_not_given(value: Any) -> bool:
210-
return isinstance(value, NotGiven)
218+
return isinstance(value, _OPENAI_UNSET_TYPES)
211219

212220

213221
def _get_attr_or_item(value: Any, key: str, default: Any = None) -> Any:
@@ -356,13 +364,13 @@ def _extract_responses_prompt(kwargs: Any) -> Any:
356364
for key in _RESPONSES_PROMPT_FIELDS:
357365
value = kwargs.get(key, None)
358366

359-
if value is not None and not isinstance(value, NotGiven):
367+
if value is not None and not _is_not_given(value):
360368
prompt_fields[key] = _serialize_openai_value(value)
361369

362-
if isinstance(input_value, NotGiven):
370+
if _is_not_given(input_value):
363371
input_value = None
364372

365-
if isinstance(instructions, NotGiven):
373+
if _is_not_given(instructions):
366374
instructions = None
367375

368376
if instructions is None:
@@ -395,14 +403,11 @@ def _extract_chat_prompt(kwargs: Any) -> Any:
395403
"""Extracts the user input from prompts. Returns an array of messages or dict with messages and functions"""
396404
prompt = {}
397405

398-
if kwargs.get("functions") is not None:
399-
prompt.update({"functions": kwargs["functions"]})
406+
for key in ("functions", "function_call", "tools"):
407+
value = kwargs.get(key)
400408

401-
if kwargs.get("function_call") is not None:
402-
prompt.update({"function_call": kwargs["function_call"]})
403-
404-
if kwargs.get("tools") is not None:
405-
prompt.update({"tools": kwargs["tools"]})
409+
if value is not None and not _is_not_given(value):
410+
prompt.update({key: value})
406411

407412
if prompt:
408413
# uf user provided functions, we need to send these together with messages to langfuse
@@ -533,7 +538,7 @@ def _get_langfuse_data_from_kwargs(resource: OpenAiDefinition, kwargs: Any) -> A
533538
metadata = kwargs.get("metadata", {})
534539
if (
535540
metadata is not None
536-
and not isinstance(metadata, NotGiven)
541+
and not _is_not_given(metadata)
537542
and not isinstance(metadata, dict)
538543
):
539544
if isinstance(metadata, BaseModel):
@@ -556,63 +561,61 @@ def _get_langfuse_data_from_kwargs(resource: OpenAiDefinition, kwargs: Any) -> A
556561

557562
parsed_temperature = (
558563
kwargs.get("temperature", 1)
559-
if not isinstance(kwargs.get("temperature", 1), NotGiven)
564+
if not _is_not_given(kwargs.get("temperature", 1))
560565
else 1
561566
)
562567

563568
parsed_max_tokens = (
564569
kwargs.get("max_tokens", float("inf"))
565-
if not isinstance(kwargs.get("max_tokens", float("inf")), NotGiven)
570+
if not _is_not_given(kwargs.get("max_tokens", float("inf")))
566571
else float("inf")
567572
)
568573

569574
parsed_max_completion_tokens = (
570575
kwargs.get("max_completion_tokens", None)
571-
if not isinstance(kwargs.get("max_completion_tokens", float("inf")), NotGiven)
576+
if not _is_not_given(kwargs.get("max_completion_tokens", float("inf")))
572577
else None
573578
)
574579

575580
parsed_top_p = (
576-
kwargs.get("top_p", 1)
577-
if not isinstance(kwargs.get("top_p", 1), NotGiven)
578-
else 1
581+
kwargs.get("top_p", 1) if not _is_not_given(kwargs.get("top_p", 1)) else 1
579582
)
580583

581584
parsed_frequency_penalty = (
582585
kwargs.get("frequency_penalty", 0)
583-
if not isinstance(kwargs.get("frequency_penalty", 0), NotGiven)
586+
if not _is_not_given(kwargs.get("frequency_penalty", 0))
584587
else 0
585588
)
586589

587590
parsed_presence_penalty = (
588591
kwargs.get("presence_penalty", 0)
589-
if not isinstance(kwargs.get("presence_penalty", 0), NotGiven)
592+
if not _is_not_given(kwargs.get("presence_penalty", 0))
590593
else 0
591594
)
592595

593596
parsed_seed = (
594597
kwargs.get("seed", None)
595-
if not isinstance(kwargs.get("seed", None), NotGiven)
598+
if not _is_not_given(kwargs.get("seed", None))
596599
else None
597600
)
598601

599-
parsed_n = kwargs.get("n", 1) if not isinstance(kwargs.get("n", 1), NotGiven) else 1
602+
parsed_n = kwargs.get("n", 1) if not _is_not_given(kwargs.get("n", 1)) else 1
600603

601604
parsed_service_tier = (
602605
kwargs.get("service_tier", None)
603-
if not isinstance(kwargs.get("service_tier", None), NotGiven)
606+
if not _is_not_given(kwargs.get("service_tier", None))
604607
else None
605608
)
606609

607610
if resource.type == "embedding":
608611
parsed_dimensions = (
609612
kwargs.get("dimensions", None)
610-
if not isinstance(kwargs.get("dimensions", None), NotGiven)
613+
if not _is_not_given(kwargs.get("dimensions", None))
611614
else None
612615
)
613616
parsed_encoding_format = (
614617
kwargs.get("encoding_format", "float")
615-
if not isinstance(kwargs.get("encoding_format", "float"), NotGiven)
618+
if not _is_not_given(kwargs.get("encoding_format", "float"))
616619
else "float"
617620
)
618621

@@ -1195,7 +1198,7 @@ def _get_raw_response_mode(kwargs: Any) -> Optional[str]:
11951198
"""
11961199
extra_headers = kwargs.get("extra_headers", None)
11971200

1198-
if extra_headers is None or isinstance(extra_headers, NotGiven):
1201+
if extra_headers is None or _is_not_given(extra_headers):
11991202
return None
12001203

12011204
try:

‎tests/unit/test_openai_prompt_extraction.py‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,19 @@
1111
except ImportError:
1212
from openai._types import NOT_GIVEN
1313

14+
from openai._types import Omit
15+
1416
from langfuse.openai import (
1517
OpenAiArgsExtractor,
1618
OpenAiDefinition,
19+
_extract_chat_prompt,
1720
_extract_responses_prompt,
1821
_get_langfuse_data_from_kwargs,
1922
_serialize_openai_value,
2023
)
2124

25+
OMIT = Omit()
26+
2227

2328
@pytest.mark.parametrize(
2429
"kwargs, expected",
@@ -51,6 +56,22 @@
5156
),
5257
({"instructions": NOT_GIVEN, "input": "Hello!"}, "Hello!"),
5358
({"instructions": NOT_GIVEN, "input": NOT_GIVEN}, None),
59+
(
60+
{"instructions": "You are helpful.", "input": OMIT},
61+
{"instructions": "You are helpful."},
62+
),
63+
({"instructions": OMIT, "input": "Hello!"}, "Hello!"),
64+
({"instructions": OMIT, "input": OMIT}, None),
65+
(
66+
{
67+
"instructions": OMIT,
68+
"input": "Hello!",
69+
"tool_choice": OMIT,
70+
"parallel_tool_calls": OMIT,
71+
"tools": OMIT,
72+
},
73+
"Hello!",
74+
),
5475
(
5576
{
5677
"input": "Search for the weather in Berlin.",
@@ -195,6 +216,64 @@ def test_store_preserves_user_structured_output_metadata_keys_for_openai():
195216
assert openai_args["metadata"] is not metadata
196217

197218

219+
def test_serialize_openai_value_treats_omit_as_not_given():
220+
assert _serialize_openai_value(OMIT) is None
221+
assert _serialize_openai_value({"tool_choice": OMIT, "keep": 1}) == {"keep": 1}
222+
223+
224+
@pytest.mark.parametrize("sentinel", [NOT_GIVEN, OMIT], ids=["not_given", "omit"])
225+
def test_extract_chat_prompt_excludes_unset_sentinel_tool_fields(sentinel):
226+
messages = [{"role": "user", "content": "Hello!"}]
227+
228+
prompt = _extract_chat_prompt(
229+
{
230+
"messages": messages,
231+
"functions": sentinel,
232+
"function_call": sentinel,
233+
"tools": sentinel,
234+
}
235+
)
236+
237+
assert prompt == messages
238+
239+
240+
@pytest.mark.parametrize("sentinel", [NOT_GIVEN, OMIT], ids=["not_given", "omit"])
241+
def test_unset_sentinel_kwargs_do_not_leak_into_langfuse_data(sentinel):
242+
resource = OpenAiDefinition(
243+
module="",
244+
object="Completions",
245+
method="create",
246+
type="chat",
247+
sync=True,
248+
)
249+
args = OpenAiArgsExtractor(
250+
model="gpt-4.1",
251+
messages=[{"role": "user", "content": "Hello!"}],
252+
metadata=sentinel,
253+
temperature=sentinel,
254+
top_p=sentinel,
255+
max_tokens=sentinel,
256+
frequency_penalty=sentinel,
257+
presence_penalty=sentinel,
258+
seed=sentinel,
259+
n=sentinel,
260+
service_tier=sentinel,
261+
tools=sentinel,
262+
).get_langfuse_args()
263+
264+
langfuse_data = _get_langfuse_data_from_kwargs(resource, args)
265+
266+
assert langfuse_data["input"] == [{"role": "user", "content": "Hello!"}]
267+
assert langfuse_data["metadata"] is None
268+
assert langfuse_data["model_parameters"] == {
269+
"temperature": 1,
270+
"max_tokens": float("inf"),
271+
"top_p": 1,
272+
"frequency_penalty": 0,
273+
"presence_penalty": 0,
274+
}
275+
276+
198277
def test_store_does_not_forward_instrumentation_structured_output_metadata():
199278
class ResponseFormat(BaseModel):
200279
name: str

0 commit comments

Comments
 (0)