Skip to content

Commit fa50c2f

Browse files
committed
fix(openai): treat openai Omit sentinels like NotGiven when logging
1 parent cd34845 commit fa50c2f

2 files changed

Lines changed: 101 additions & 27 deletions

File tree

‎langfuse/openai.py‎

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

35-
from openai._types import NotGiven
35+
from openai._types import NotGiven, Omit
3636
from packaging.version import Version
3737
from pydantic import BaseModel
3838
from pydantic_core import to_jsonable_python
@@ -207,7 +207,7 @@ class OpenAiDefinition:
207207

208208

209209
def _is_not_given(value: Any) -> bool:
210-
return isinstance(value, NotGiven)
210+
return isinstance(value, (NotGiven, Omit))
211211

212212

213213
def _get_attr_or_item(value: Any, key: str, default: Any = None) -> Any:
@@ -356,13 +356,13 @@ def _extract_responses_prompt(kwargs: Any) -> Any:
356356
for key in _RESPONSES_PROMPT_FIELDS:
357357
value = kwargs.get(key, None)
358358

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

362-
if isinstance(input_value, NotGiven):
362+
if _is_not_given(input_value):
363363
input_value = None
364364

365-
if isinstance(instructions, NotGiven):
365+
if _is_not_given(instructions):
366366
instructions = None
367367

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

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

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

407404
if prompt:
408405
# uf user provided functions, we need to send these together with messages to langfuse
@@ -533,7 +530,7 @@ def _get_langfuse_data_from_kwargs(resource: OpenAiDefinition, kwargs: Any) -> A
533530
metadata = kwargs.get("metadata", {})
534531
if (
535532
metadata is not None
536-
and not isinstance(metadata, NotGiven)
533+
and not _is_not_given(metadata)
537534
and not isinstance(metadata, dict)
538535
):
539536
if isinstance(metadata, BaseModel):
@@ -556,63 +553,61 @@ def _get_langfuse_data_from_kwargs(resource: OpenAiDefinition, kwargs: Any) -> A
556553

557554
parsed_temperature = (
558555
kwargs.get("temperature", 1)
559-
if not isinstance(kwargs.get("temperature", 1), NotGiven)
556+
if not _is_not_given(kwargs.get("temperature", 1))
560557
else 1
561558
)
562559

563560
parsed_max_tokens = (
564561
kwargs.get("max_tokens", float("inf"))
565-
if not isinstance(kwargs.get("max_tokens", float("inf")), NotGiven)
562+
if not _is_not_given(kwargs.get("max_tokens", float("inf")))
566563
else float("inf")
567564
)
568565

569566
parsed_max_completion_tokens = (
570567
kwargs.get("max_completion_tokens", None)
571-
if not isinstance(kwargs.get("max_completion_tokens", float("inf")), NotGiven)
568+
if not _is_not_given(kwargs.get("max_completion_tokens", float("inf")))
572569
else None
573570
)
574571

575572
parsed_top_p = (
576-
kwargs.get("top_p", 1)
577-
if not isinstance(kwargs.get("top_p", 1), NotGiven)
578-
else 1
573+
kwargs.get("top_p", 1) if not _is_not_given(kwargs.get("top_p", 1)) else 1
579574
)
580575

581576
parsed_frequency_penalty = (
582577
kwargs.get("frequency_penalty", 0)
583-
if not isinstance(kwargs.get("frequency_penalty", 0), NotGiven)
578+
if not _is_not_given(kwargs.get("frequency_penalty", 0))
584579
else 0
585580
)
586581

587582
parsed_presence_penalty = (
588583
kwargs.get("presence_penalty", 0)
589-
if not isinstance(kwargs.get("presence_penalty", 0), NotGiven)
584+
if not _is_not_given(kwargs.get("presence_penalty", 0))
590585
else 0
591586
)
592587

593588
parsed_seed = (
594589
kwargs.get("seed", None)
595-
if not isinstance(kwargs.get("seed", None), NotGiven)
590+
if not _is_not_given(kwargs.get("seed", None))
596591
else None
597592
)
598593

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

601596
parsed_service_tier = (
602597
kwargs.get("service_tier", None)
603-
if not isinstance(kwargs.get("service_tier", None), NotGiven)
598+
if not _is_not_given(kwargs.get("service_tier", None))
604599
else None
605600
)
606601

607602
if resource.type == "embedding":
608603
parsed_dimensions = (
609604
kwargs.get("dimensions", None)
610-
if not isinstance(kwargs.get("dimensions", None), NotGiven)
605+
if not _is_not_given(kwargs.get("dimensions", None))
611606
else None
612607
)
613608
parsed_encoding_format = (
614609
kwargs.get("encoding_format", "float")
615-
if not isinstance(kwargs.get("encoding_format", "float"), NotGiven)
610+
if not _is_not_given(kwargs.get("encoding_format", "float"))
616611
else "float"
617612
)
618613

@@ -1195,7 +1190,7 @@ def _get_raw_response_mode(kwargs: Any) -> Optional[str]:
11951190
"""
11961191
extra_headers = kwargs.get("extra_headers", None)
11971192

1198-
if extra_headers is None or isinstance(extra_headers, NotGiven):
1193+
if extra_headers is None or _is_not_given(extra_headers):
11991194
return None
12001195

12011196
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)