Skip to content

Commit e3b0671

Browse files
fix(openai): trace responses.retrieve so background responses get output and usage
Responses.create and Responses.parse are instrumented, Responses.retrieve is not. Background responses (background=True) return immediately with status queued and no usage, and complete through retrieve() - either directly or via responses.stream(response_id=...), which delegates to retrieve(stream=True). The result is a generation in the trace that never receives its output, token counts or cost, which reads as a free call rather than a missing one. Instrument Responses.retrieve and AsyncResponses.retrieve. The response id is recorded as the generation input, since retrieve() carries no prompt of its own; model, output and usage come from the response, so both the streaming and non-streaming paths are handled by the existing extraction code.
1 parent d22213a commit e3b0671

2 files changed

Lines changed: 92 additions & 1 deletion

File tree

‎langfuse/openai.py‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,22 @@ class OpenAiDefinition:
193193
sync=False,
194194
min_version="1.66.0",
195195
),
196+
OpenAiDefinition(
197+
module="openai.resources.responses",
198+
object="Responses",
199+
method="retrieve",
200+
type="chat",
201+
sync=True,
202+
min_version="1.66.0",
203+
),
204+
OpenAiDefinition(
205+
module="openai.resources.responses",
206+
object="AsyncResponses",
207+
method="retrieve",
208+
type="chat",
209+
sync=False,
210+
min_version="1.66.0",
211+
),
196212
OpenAiDefinition(
197213
module="openai.resources.embeddings",
198214
object="Embeddings",
@@ -550,7 +566,11 @@ def _get_langfuse_data_from_kwargs(resource: OpenAiDefinition, kwargs: Any) -> A
550566

551567
prompt = None
552568

553-
if resource.type == "completion":
569+
if resource.method == "retrieve":
570+
# retrieve() only knows the id of a response created earlier; the model,
571+
# output and usage are filled in from the response itself.
572+
prompt = {"response_id": kwargs.get("response_id", None)}
573+
elif resource.type == "completion":
554574
prompt = kwargs.get("prompt", None)
555575
elif resource.object == "Responses" or resource.object == "AsyncResponses":
556576
prompt = _extract_responses_prompt(kwargs)

‎tests/unit/test_openai.py‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1399,3 +1399,74 @@ def test_with_raw_response_streaming_passes_through_untraced(
13991399
span.name != "OpenAI-generation"
14001400
for span in memory_exporter.get_finished_spans()
14011401
)
1402+
1403+
1404+
def test_response_retrieve_exports_generation_span(
1405+
langfuse_memory_client, get_span, json_attr
1406+
):
1407+
"""Background responses complete through retrieve(), which must be traced."""
1408+
openai_client = lf_openai.OpenAI(api_key="test")
1409+
response = SimpleNamespace(
1410+
model="gpt-4o-mini",
1411+
output=[{"role": "assistant", "content": "2"}],
1412+
usage=SimpleNamespace(input_tokens=3, output_tokens=1, total_tokens=4),
1413+
)
1414+
1415+
with patch.object(openai_client.responses, "_get", return_value=response):
1416+
result = openai_client.responses.retrieve(
1417+
response_id="resp_123",
1418+
name="unit-openai-response-retrieve",
1419+
)
1420+
1421+
assert result is response
1422+
1423+
langfuse_memory_client.flush()
1424+
span = get_span("unit-openai-response-retrieve")
1425+
1426+
assert span.attributes[LangfuseOtelSpanAttributes.OBSERVATION_TYPE] == "generation"
1427+
assert (
1428+
span.attributes[LangfuseOtelSpanAttributes.OBSERVATION_MODEL] == "gpt-4o-mini"
1429+
)
1430+
assert json_attr(span, LangfuseOtelSpanAttributes.OBSERVATION_INPUT) == {
1431+
"response_id": "resp_123"
1432+
}
1433+
assert json_attr(span, LangfuseOtelSpanAttributes.OBSERVATION_OUTPUT) == {
1434+
"role": "assistant",
1435+
"content": "2",
1436+
}
1437+
assert json_attr(span, LangfuseOtelSpanAttributes.OBSERVATION_USAGE_DETAILS) == {
1438+
"input_tokens": 3,
1439+
"output_tokens": 1,
1440+
"total_tokens": 4,
1441+
}
1442+
1443+
1444+
@pytest.mark.asyncio
1445+
async def test_async_response_retrieve_exports_generation_span(
1446+
langfuse_memory_client, get_span, json_attr
1447+
):
1448+
openai_client = lf_openai.AsyncOpenAI(api_key="test")
1449+
response = SimpleNamespace(
1450+
model="gpt-4o-mini",
1451+
output=[{"role": "assistant", "content": "2"}],
1452+
usage=SimpleNamespace(input_tokens=3, output_tokens=1, total_tokens=4),
1453+
)
1454+
1455+
async def _get(*args, **kwargs):
1456+
return response
1457+
1458+
with patch.object(openai_client.responses, "_get", side_effect=_get):
1459+
result = await openai_client.responses.retrieve(
1460+
response_id="resp_123",
1461+
name="unit-openai-async-response-retrieve",
1462+
)
1463+
1464+
assert result is response
1465+
1466+
langfuse_memory_client.flush()
1467+
span = get_span("unit-openai-async-response-retrieve")
1468+
1469+
assert span.attributes[LangfuseOtelSpanAttributes.OBSERVATION_TYPE] == "generation"
1470+
assert json_attr(span, LangfuseOtelSpanAttributes.OBSERVATION_INPUT) == {
1471+
"response_id": "resp_123"
1472+
}

0 commit comments

Comments
 (0)