Documentation can be updated for assistant.usage events

Aberta
  • Algo errado?
#2,834 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

  • #2837 de @rinceyuan — fechado sem integrar

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
55/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
documentation, typescript
Domínio
documentation

Direção de pesquisa

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.

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

Descrição

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.

Linguagem predominante
Java
Estrelas
10.7k
Forks
1.5k
Nenhum PR com merge em 30d

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 github/copilot-sdk

Todas as issues de github/copilot-sdk

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

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