after_model_callback: a replacement LlmResponse drops `usage_metadata`, erasing the model call from token accounting
Los mantenedores suelen responder en 5 días
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 68/100
Línea de trabajo
Empieza por flows/llm_flows/core/_finalizer.py, donde, según el issue, partial y turn_complete ya se heredan y grounding_metadata se gestiona. Revisa las pruebas del finalizer para las respuestas de reemplazo creadas mediante callbacks y añade cobertura tanto para un usage_metadata no establecido como para uno proporcionado explícitamente. Se considera terminado cuando el usage heredado aparece en los eventos finales y persistidos, mientras que se conserva un valor de reemplazo explícito.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
🔴 Required Information
Describe the Bug:
Follow-up to #7035. That fix (#7036, 39e4538) makes a callback-built
replacement inherit the streaming-control fields partial and
turn_complete; usage_metadata was deliberately left out of its scope.
The same mechanism still drops it. When an after_model_callback returns a
rebuilt LlmResponse (the documented contract) and does not set
usage_metadata, the replacement carries None. finalize_model_response_event
copies only non-None fields into the Event, so the yielded final event and
the event persisted to the session have no usage for that model call.
Everything that reads usage from events loses it: the BigQuery analytics
plugin's event path, the A2A converters, agent_test_runner, and any client
doing per-call cost attribution from session history. Plugins that read
llm_response.usage_metadata inside their own after_model_callback still
see it, because plugin callbacks run before the agent callback, which is why
the loss is easy to miss in logs.
usage_metadata measures the model call (prompt, candidate and cached token
counts billed by the provider), not the content of the response. Replacing
the content does not change what the call cost, so there is no reading under
which None is the more accurate value. It applies in streaming and
non-streaming mode alike.
To Reproduce:
Self-contained, no API key (fake model reports usage on its final response,
as Gemini does):
pip install google-adk==2.11.0 && python repro_usage_loss.py
# repro_usage_loss.py
"""Repro: after_model_callback replacement drops usage_metadata on current main."""
import asyncio
from typing import AsyncGenerator
from google.adk.agents import LlmAgent
from google.adk.agents.run_config import RunConfig, StreamingMode
from google.adk.models.base_llm import BaseLlm
from google.adk.models.llm_request import LlmRequest
from google.adk.models.llm_response import LlmResponse
from google.adk.runners import InMemoryRunner
from google.genai import types
USAGE = types.GenerateContentResponseUsageMetadata(
prompt_token_count=120, candidates_token_count=8, total_token_count=128)
def _resp(text, partial=None, usage=None):
return LlmResponse(
content=types.Content(role="model", parts=[types.Part(text=text)]),
partial=partial, usage_metadata=usage)
class FakeLlm(BaseLlm):
@classmethod
def supported_models(cls): return [".*"]
async def generate_content_async(self, llm_request: LlmRequest, stream=False
) -> AsyncGenerator[LlmResponse, None]:
if stream:
for d in ["Hello ", "world."]:
yield _resp(d, partial=True)
yield _resp("Hello world.", usage=USAGE) # provider reports usage on final
def rebuild_cb(callback_context, llm_response):
if not (llm_response.content and llm_response.content.parts): return None
t = llm_response.content.parts[0].text or ""
return _resp(t.replace("world", "[REDACTED]"))
async def run(label, cb, stream):
agent = LlmAgent(name="a", model=FakeLlm(model="fake"), after_model_callback=cb)
runner = InMemoryRunner(agent=agent, app_name="r")
s = await runner.session_service.create_session(app_name="r", user_id="u")
cfg = RunConfig(streaming_mode=StreamingMode.SSE if stream else StreamingMode.NONE)
finals = []
async for ev in runner.run_async(user_id="u", session_id=s.id,
new_message=types.Content(role="user", parts=[types.Part(text="hi")]), run_config=cfg):
if not ev.partial: finals.append(ev)
stored = await runner.session_service.get_session(app_name="r", user_id="u", session_id=s.id)
persisted = [e for e in stored.events if e.author == "a"]
tok = lambda e: e.usage_metadata.total_token_count if e.usage_metadata else None
print(f"{label:22} final_event.usage={tok(finals[-1])!s:5} persisted.usage={tok(persisted[-1])!s:5} partial_flags={[e.partial for e in persisted]}")
async def main():
import google.adk; print("google-adk", google.adk.__version__)
await run("CONTROL non-stream", None, False)
await run("REBUILD non-stream", rebuild_cb, False)
await run("CONTROL SSE", None, True)
await run("REBUILD SSE", rebuild_cb, True)
asyncio.run(main())
Actual output on google-adk 2.11.0 (latest release; also reproduced on main @ 42a17a9f):
google-adk 2.11.0
CONTROL non-stream final_event.usage=128 persisted.usage=128 partial_flags=[None]
REBUILD non-stream final_event.usage=None persisted.usage=None partial_flags=[None]
CONTROL SSE final_event.usage=128 persisted.usage=128 partial_flags=[None]
REBUILD SSE final_event.usage=None persisted.usage=None partial_flags=[None]
(The partial flags are correct in all four runs, confirming #7036 landed
and that this is the remaining gap.)
Expected behavior:
A replacement that leaves usage_metadata unset inherits it from the
response it replaces, so the persisted event still reports 128 tokens. A
replacement that sets its own usage_metadata (e.g. a callback that made an
additional model call and wants to report combined usage) is respected.
Suggested fix:
Extend the inheritance already applied in flows/llm_flows/core/_finalizer.py for
partial/turn_complete to usage_metadata, same copy-on-inherit
semantics (no mutation of the callback-owned object, explicit values win).
Scope deliberately limited to this one field: grounding_metadata already
has its own handling in the same function, and finish_reason/error_code
are left to the callback because a guardrail replacement may legitimately
change finish semantics. PR: #7449
Desktop:
- OS: macOS (Darwin 27.0)
- Python: 3.13.12
- google-adk: 2.11.0 (release) and main @ 42a17a9f
- Lenguaje dominante
- Python
- Estrellas
- 21.8k
- Forks
- 4.1k
- Merge medio
- 1 d 13 h
- PR fusionados (30 d)
- 6
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de google/adk-python
-
Update opentelemetry-api and opentelemetry-sdk to 1.44.0Posiblemente ocupada @llalitkumarrr la tomó hace 1 día. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
google/adk-python#7433 · 2 comentarios · 1 asignado ·
Los mantenedores suelen responder en 5 días
-
CI Mypy Check flags an existing streaming_utils.py error as new because the PR run reuses the baseline's mypy cachePosiblemente ocupada @DeanChensj la tomó hace 2 días. Abiertoneeds review
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
google/adk-python#7409 · 1 comentario · 2 asignados ·
Los mantenedores suelen responder en 5 días
-
A2aAgentExecutor sends the raw exception text to the A2A caller when the run failsPosiblemente ocupada @sanketpatil06 la tomó hace 3 días. Abiertoa2a request clarification
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
google/adk-python#7385 · 2 comentarios · 1 asignado ·
Los mantenedores suelen responder en 5 días
-
Please support mermaid 12 (inbuild elk) in `adk web`Posiblemente ocupada @sanketpatil06 la tomó hace 3 días. Abiertoneeds review web
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
google/adk-python#7381 · 1 comentario · 1 asignado ·
Los mantenedores suelen responder en 5 días
-
[A2A] RemoteA2aAgent(use_legacy=False): extension header written to state['http_kwargs'], ignored by a2a-sdk 1.x transportsPosiblemente ocupada @surajksharma07 la tomó hace 10 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
google/adk-python#7334 · 2 comentarios · 1 asignado ·
Los mantenedores suelen responder en 5 días
Todos los issues de google/adk-python
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
Deepak3699/Ai_Mentor#244 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
btclib-org/btclib-node#1880 ·
Los mantenedores suelen responder en 1 día
-
CONTRIBUTING.md: say how ticketless bug fixes and feature PRs are handledPosiblemente ocupada @khuisman la tomó hoy. Abiertov0.9.2
Dificultad 1/5 Menos de una hora Aptitud para principiantes 84/100
khuisman/mcp-gee-sweet#941 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
pyjanitor-devs/pyjanitor#1758 ·
Los mantenedores suelen responder en 1 día
-
bug ready for review
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
odysseus-dev/odysseus#6641 ·
Los mantenedores suelen responder en 1 día