Documentation
¶
Overview ¶
Package usage tracks model token and cost estimates.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RenderText ¶
RenderText writes a human-readable usage report.
Types ¶
type BlockUsage ¶
type BlockUsage struct {
Type string `json:"type"`
Count int `json:"count"`
Tokens int `json:"tokens"`
}
BlockUsage reports block counts and token estimates for one content block type.
type Report ¶
type Report struct {
Kind string `json:"kind"`
Action string `json:"action"`
Status string `json:"status"`
SessionID string `json:"session_id,omitempty"`
Model string `json:"model"`
MessageCount int `json:"message_count"`
Summary Summary `json:"summary"`
Roles []RoleUsage `json:"roles"`
Blocks []BlockUsage `json:"blocks"`
ToolUse ToolUseSummary `json:"tool_use"`
}
Report summarizes usage for a session or message set.
func BuildReport ¶
BuildReport returns a usage report using estimated token counts.
type RoleUsage ¶
type RoleUsage struct {
Role string `json:"role"`
Messages int `json:"messages"`
Tokens int `json:"tokens"`
}
RoleUsage reports message and token totals for one role.
type Summary ¶
type Summary struct {
InputTokens int `json:"input_tokens"`
OutputTokens int `json:"output_tokens"`
CacheCreationInputTokens int `json:"cache_creation_input_tokens,omitempty"`
CacheReadInputTokens int `json:"cache_read_input_tokens,omitempty"`
TotalTokens int `json:"total_tokens"`
EstimatedUSD float64 `json:"estimated_usd"`
Source string `json:"source"`
}
Summary contains token totals and estimated or actual cost information.
func ActualSummary ¶
ActualSummary returns an aggregate actual-usage summary when any token usage payloads are present.
type ToolUseSummary ¶
type ToolUseSummary struct {
ToolUses int `json:"tool_uses"`
ToolResults int `json:"tool_results"`
Errors int `json:"errors"`
}
ToolUseSummary reports tool-use, tool-result, and error block counts.
Source Files
Click to show internal directories.
Click to hide internal directories.