Skip to content

docs: document JSON output schema #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1cbyc wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document JSON output schema #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,49 @@ $ tokenmeter count p.txt --output-tokens 500 # include an assumed completion
$ tokenmeter models # list models and prices
```

### JSON output

Pass `--json` to emit a machine-readable summary that scripts and CI jobs can parse:

```console
$ tokenmeter count prompts/system.txt --model gpt-4o --output-tokens 500 --json
{
"inputs": [
{
"name": "prompts/system.txt",
"model": "gpt-4o",
"input_tokens": 812,
"output_tokens": 500,
"input_cost": 0.00203,
"output_cost": 0.005,
"total_cost": 0.00703
}
],
"total_tokens": 1312,
"total_cost": 0.00703
}
```

The top-level object contains:

| Field | Type | Description |
| --- | --- | --- |
| `inputs` | array | One object per input file, directory entry, or stdin stream. |
| `total_tokens` | integer | Sum of input and assumed output tokens across all inputs. |
| `total_cost` | number | Estimated total USD cost across all inputs, rounded to 6 decimal places. |

Each `inputs[]` object contains:

| Field | Type | Description |
| --- | --- | --- |
| `name` | string | Input name, such as a file path or `-` for stdin. |
| `model` | string | Model used for token counting and pricing. |
| `input_tokens` | integer | Counted prompt/input tokens. |
| `output_tokens` | integer | Assumed completion tokens from `--output-tokens` (defaults to `0`). |
| `input_cost` | number | Estimated USD input-token cost, rounded to 6 decimal places. |
| `output_cost` | number | Estimated USD output-token cost, rounded to 6 decimal places. |
| `total_cost` | number | Estimated USD cost for the input, rounded to 6 decimal places. |

### As a budget gate

Fail a build when a prompt set would cost more than you allow:
Expand Down
14 changes: 13 additions & 1 deletion tests/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,20 @@ def test_count_file_json(tmp_path):
result = runner.invoke(cli_module.app, ["count", str(f), "--json"])
assert result.exit_code == 0
payload = json.loads(result.stdout)
assert set(payload) == {"inputs", "total_tokens", "total_cost"}
assert payload["total_tokens"] == 4
assert payload["inputs"][0]["input_tokens"] == 4
assert payload["total_cost"] == 0.00001
assert payload["inputs"] == [
{
"name": str(f),
"model": "gpt-4o",
"input_tokens": 4,
"output_tokens": 0,
"input_cost": 0.00001,
"output_cost": 0.0,
"total_cost": 0.00001,
}
]


def test_count_unknown_model_is_bad_input(tmp_path):
Expand Down