Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

after_model_callback: a replacement LlmResponse drops `usage_metadata`, erasing the model call from token accounting

Fechada Para iniciantes
  • Algo errado?
#7,451 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 5 dias

@zhuhongd já está trabalhando nisso.

Desde 7/10/2026.

  • #7449 de @zhuhongd — aberto

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
68/100
Tipo de issue
Bug
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
python
Domínio
backend

Direção de pesquisa

Comece por flows/llm_flows/core/_finalizer.py, onde, segundo a issue, partial e turn_complete já são herdados e grounding_metadata é tratado. Verifique os testes do finalizer para respostas de substituição criadas por callback e adicione testes tanto para um usage_metadata não definido quanto para um fornecido explicitamente. O trabalho estará concluído quando o usage herdado aparecer nos eventos finais e persistidos, enquanto um valor de substituição explícito for preservado.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

🔴 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
Linguagem predominante
Python
Estrelas
21.8k
Forks
4.1k
Merge médio
1d 13h
PRs com merge (30d)
6

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de google/adk-python

Todas as issues de google/adk-python

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.