Skip to content

Python: fix(python): include cache tokens in input_token_count for Bedrock and Claude - #10003

Open
123XieC wants to merge 1 commit into
microsoft:mainfrom
123XieC:fix/include-cache-tokens-in-input-count
Open

123XieC wants to merge 1 commit into
microsoft:mainfrom
123XieC:fix/include-cache-tokens-in-input-count

Conversation

@123XieC

@123XieC 123XieC commented Nov 3, 2026

Copy link
Copy Markdown

Motivation & Context

Same root cause as #9808 (AnthropicClient, fixed by #9859), in two more connectors that #9859 did not touch.

  • BedrockChatClient._parse_usage maps Converse inputTokens to input_token_count. With prompt caching, Bedrock reports cache reads/writes separately in cacheReadInputTokens / cacheWriteInputTokens, and inputTokens covers only the uncached part. So on main the usage is internally inconsistent (input 12 + output 40 but total 9352).
  • ClaudeAgent builds input_token_count from the Claude Agent SDK ResultMessage.usage["input_tokens"], which is Anthropic's uncached-only field, and computes total_token_count = input + output, so both undercount.

input_token_count is total input for the OpenAI and Gemini clients and is exported as gen_ai.usage.input_tokens, which the OTel GenAI semconv says should include cached tokens.

Description & Review Guide

  • Bedrock (_parse_usage): sum cacheReadInputTokens + cacheWriteInputTokens into input_token_count. Cache-specific fields are unchanged.
  • Claude (ClaudeAgent): sum cache_creation_input_tokens + cache_read_input_tokens into input_token_count, and derive total_token_count from the inclusive input total. Cache-specific fields are unchanged.
  • Updated the two existing unit tests whose expected values now reflect the inclusive input count:
    • test_parse_usage_surfaces_cache_tokens: input_token_count 10 → 21.
    • test_run_captures_result_message_usage_and_finish_reason: input_token_count 42 → 50, total_token_count 60 → 68.

No new tests were added because the existing tests already cover the cache-token paths and their updated assertions verify the fix.

Verification

  • python -m pytest python/packages/bedrock/tests/test_bedrock_client.py -q → all pass, including the updated test_parse_usage_surfaces_cache_tokens.
  • python -m pytest python/packages/claude/tests/test_claude_agent.py -q → all pass, including the updated test_run_captures_result_message_usage_and_finish_reason.

Related Issue

Fixes #9988

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: locating the two connectors' usage parsing, and drafting the minimal change following the already-merged #9859 pattern. I reproduced the undercount locally and ran the updated tests myself.

Copilot AI balanced review requested due to automatic review settings November 3, 2026 03:15
@123XieC
123XieC temporarily deployed to github-app-auth November 3, 2026 03:15 — with GitHub Actions Inactive
@agent-framework-automation agent-framework-automation Bot added the python Usage: [Issues, PRs], Target: Python label Nov 3, 2026
@github-actions github-actions Bot changed the title fix(python): include cache tokens in input_token_count for Bedrock and Claude Python: fix(python): include cache tokens in input_token_count for Bedrock and Claude Nov 3, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown

123XieC please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues were identified in the Bedrock and Claude cache-token accounting changes.

No open issues 🎉

What changed in this PR

Extends the cache-token accounting fix from #9859 to the Bedrock and Claude connectors, addressing #9988 and aligning input usage with other providers.

Changes:

  • Include cache read and write/creation tokens in both connectors’ input_token_count, preserving separate cache counters.
  • Compute Claude’s total_token_count from the inclusive input count plus output tokens.
  • Update existing cache-token tests to assert the corrected counts.
File Description
python/​packages/​claude/​tests/​test_claude_agent.py Updates expected input and total counts to include cached tokens.
python/​packages/​claude/​agent_framework_claude/​_agent.py Includes cache creation and read tokens in input and total usage.
python/​packages/​bedrock/​tests/​test_bedrock_client.py Updates the expected input count to include cached tokens.
python/​packages/​bedrock/​agent_framework_bedrock/​_chat_client.py Includes cache read and write tokens in input usage.

Review effort: Balanced

This branch was successfully deployed

No deployments
github-app-auth — 685f0cb2 Deployed Nov 3, 2026 by 123XieC via team_check #8454
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Python: [Bug]: BedrockChatClient and ClaudeAgent report input_token_count without cached prompt tokens

2 participants