Documentation can be updated for assistant.usage events

Đang mở
  • Có gì không ổn?
#2,834 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

  • #2837 của @rinceyuan — đã đóng, không merge

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
documentation, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Java
Star
10.7k
Fork
1.5k
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/copilot-sdk

Tất cả issue của github/copilot-sdk

Issue tương tự

Thêm issue về Java

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.