Repository navigation
Preserve provider usage in request results - #4335
Open
Tanisha-Katara wants to merge 1 commit into
Open
Tanisha-Katara wants to merge 1 commit into
Tanisha-Katara wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Preserves provider-reported usage counters on
RequestResultfor OpenAI Chat/Completions/Embeddings, OpenAI Responses, and LiteLLM-backed calls.The field is optional and omitted from serialized JSON when absent, so existing request results stay unchanged unless a provider actually returns usage.
Why
HELM currently estimates token costs from benchmark-side tokenization, but several providers now return more detailed usage counters. Those counters can include cache-specific token details such as cached input tokens and cache-write tokens. Keeping the raw provider usage attached to the result makes those details available to downstream analysis without asking HELM to interpret every provider's accounting semantics in this change.
For client paths that can make multiple provider calls for one HELM request, this keeps each provider usage dict under
responsesinstead of silently dropping all but one.Validation
uv run --python 3.12 pytest src/helm/common/test_codec.py -quv run --python 3.12 black --check src/helm/common/request.py src/helm/common/test_codec.py src/helm/clients/openai_client.py src/helm/clients/openai_responses_client.py src/helm/clients/litellm_client.pyuv run --python 3.12 python -m compileall -q src/helm/common/request.py src/helm/clients/openai_client.py src/helm/clients/openai_responses_client.py src/helm/clients/litellm_client.pygit diff --check