Documentation can be updated for assistant.usage events

未關閉
#2,834 1 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

  • #2837 來自 @rinceyuan —— 已關閉,未合併

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
55/100
Issue 類型
文件
描述清晰度
基本清楚
活躍度
活躍
技術堆疊
documentation, typescript
領域
documentation

研究方向

The public page on Copilot usage metrics is outside this repository, so the docs edit may land in the docs site, while the JSDoc change belongs in the TypeScript SDK where the assistant.usage event fields are declared. Read the usage event type definitions in the TypeScript source, then document the four token fields and state whether inputTokens includes cache write tokens. Done when the field descriptions answer that question and the wording is consistent with the online page.

由索引模型根據 Issue 內容生成。

描述

documentation

I have two suggestions for the Copilot SDK doc.

  1. The online documentation page can add more details about the assistant.usage events. The SDK currently exposes all four numbers related to pricing "input tokens", "output tokens", "cache read tokens" and "cache write tokens". The documentation site only mentions input tokens and output tokens. copilot-usage-metrics

  2. The online documentation and the TS SDK inline JSDoc can clarify what the "input tokens" number represent from the SDK events. I noticed that the number for "inputTokens" in my Copilot SDK events are abnormally high compared to the numbers reported by a Claude Agent SDK, making me suspect the "inputTokens" number actually includes tokens that are written to the cache. Given that new models have different price for input token and cache write tokens, the documentation should clarify that.

主要語言
Java
星號
10.7k
分支
1.5k
PR 合併指標
30 天內沒有已合併 PR

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

github/copilot-sdk 的其他 Issue

查看 github/copilot-sdk 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。