Skip to content

Commit 597f54f

Browse files
fix(openai): capture reasoning_effort and verbosity in model parameters (#1900)
Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Hassieb Pakzad <hassiebp@users.noreply.github.com>
1 parent f55cdc4 commit 597f54f

2 files changed

Lines changed: 106 additions & 1 deletion

File tree

‎langfuse/openai.py‎

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
from dataclasses import dataclass
3131
from datetime import datetime
3232
from inspect import isawaitable, isclass
33-
from typing import Any, Optional, cast
33+
from typing import Any, Dict, Optional, cast
3434

3535
from openai import _types as openai_types
3636
from openai._types import NotGiven
@@ -494,6 +494,36 @@ def _extract_chat_response(kwargs: Any) -> Any:
494494
return response
495495

496496

497+
def _parse_reasoning_model_parameters(
498+
resource: OpenAiDefinition, kwargs: Any
499+
) -> Dict[str, Any]:
500+
"""Collect reasoning-model request params as flat model parameters.
501+
502+
Chat Completions accepts `reasoning_effort` and `verbosity` at the top level,
503+
while the Responses API nests them under `reasoning` and `text`.
504+
"""
505+
if resource.object in ("Responses", "AsyncResponses"):
506+
reasoning = kwargs.get("reasoning", None)
507+
text = kwargs.get("text", None)
508+
candidates = {
509+
"reasoning_effort": _get_attr_or_item(reasoning, "effort"),
510+
"reasoning_summary": _get_attr_or_item(reasoning, "summary"),
511+
"verbosity": _get_attr_or_item(text, "verbosity"),
512+
"max_output_tokens": kwargs.get("max_output_tokens", None),
513+
}
514+
else:
515+
candidates = {
516+
"reasoning_effort": kwargs.get("reasoning_effort", None),
517+
"verbosity": kwargs.get("verbosity", None),
518+
}
519+
520+
return {
521+
key: value
522+
for key, value in candidates.items()
523+
if value is not None and not _is_not_given(value)
524+
}
525+
526+
497527
def _get_langfuse_data_from_kwargs(resource: OpenAiDefinition, kwargs: Any) -> Any:
498528
default_name = (
499529
"OpenAI-embedding" if resource.type == "embedding" else "OpenAI-generation"
@@ -646,6 +676,10 @@ def _get_langfuse_data_from_kwargs(resource: OpenAiDefinition, kwargs: Any) -> A
646676
if parsed_service_tier is not None:
647677
modelParameters["service_tier"] = parsed_service_tier
648678

679+
modelParameters.update(_parse_reasoning_model_parameters(resource, kwargs))
680+
if "max_output_tokens" in modelParameters:
681+
modelParameters.pop("max_tokens", None)
682+
649683
langfuse_prompt = kwargs.get("langfuse_prompt", None)
650684

651685
return {

‎tests/unit/test_openai.py‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1167,6 +1167,77 @@ async def test_openai_async_stream_captures_service_tier_from_chunks(
11671167
assert model_parameters["temperature"] == 0
11681168

11691169

1170+
def test_chat_completion_captures_reasoning_parameters(
1171+
langfuse_memory_client, get_span, json_attr
1172+
):
1173+
openai_client = lf_openai.OpenAI(api_key="test")
1174+
response = _make_chat_response()
1175+
1176+
with patch.object(openai_client.chat.completions, "_post", return_value=response):
1177+
openai_client.chat.completions.create(
1178+
name="unit-openai-reasoning-params",
1179+
model="gpt-5",
1180+
messages=[{"role": "user", "content": "1 + 1 = ?"}],
1181+
reasoning_effort="minimal",
1182+
verbosity="low",
1183+
)
1184+
1185+
langfuse_memory_client.flush()
1186+
span = get_span("unit-openai-reasoning-params")
1187+
1188+
model_parameters = json_attr(
1189+
span, LangfuseOtelSpanAttributes.OBSERVATION_MODEL_PARAMETERS
1190+
)
1191+
assert model_parameters["reasoning_effort"] == "minimal"
1192+
assert model_parameters["verbosity"] == "low"
1193+
1194+
1195+
def test_chat_completion_reasoning_parameters_absent_by_default(
1196+
langfuse_memory_client, get_span, json_attr
1197+
):
1198+
from openai._types import NOT_GIVEN
1199+
1200+
openai_client = lf_openai.OpenAI(api_key="test")
1201+
response = _make_chat_response()
1202+
1203+
with patch.object(openai_client.chat.completions, "_post", return_value=response):
1204+
openai_client.chat.completions.create(
1205+
name="unit-openai-reasoning-params-absent",
1206+
model="gpt-4o-mini",
1207+
messages=[{"role": "user", "content": "1 + 1 = ?"}],
1208+
reasoning_effort=NOT_GIVEN,
1209+
)
1210+
1211+
langfuse_memory_client.flush()
1212+
span = get_span("unit-openai-reasoning-params-absent")
1213+
1214+
model_parameters = json_attr(
1215+
span, LangfuseOtelSpanAttributes.OBSERVATION_MODEL_PARAMETERS
1216+
)
1217+
assert "reasoning_effort" not in model_parameters
1218+
assert "verbosity" not in model_parameters
1219+
1220+
1221+
def test_responses_kwargs_capture_reasoning_parameters():
1222+
data = lf_openai_module._get_langfuse_data_from_kwargs(
1223+
SimpleNamespace(type="chat", object="Responses"),
1224+
{
1225+
"model": "gpt-5",
1226+
"input": "1 + 1 = ?",
1227+
"reasoning": {"effort": "high", "summary": "auto"},
1228+
"text": {"verbosity": "high", "format": {"type": "text"}},
1229+
"max_output_tokens": 256,
1230+
},
1231+
)
1232+
1233+
model_parameters = data["model_parameters"]
1234+
assert model_parameters["reasoning_effort"] == "high"
1235+
assert model_parameters["reasoning_summary"] == "auto"
1236+
assert model_parameters["verbosity"] == "high"
1237+
assert model_parameters["max_output_tokens"] == 256
1238+
assert "max_tokens" not in model_parameters
1239+
1240+
11701241
def test_embedding_model_parameters_do_not_include_service_tier(
11711242
langfuse_memory_client, get_span, json_attr
11721243
):

0 commit comments

Comments
 (0)