Files
codex/codex-rs/app-server-protocol/schema/json/v2/RawResponseCompletedNotification.json
T
Dylan Hurd 2c4a95736b Expose response usage metadata in completion events (#41087)
## What changed

- Parse optional `usage_metadata.amount` values from Responses API completion events without converting their string representation.
- Propagate the metadata through SSE and WebSocket streams, regular turns, and remote compaction.
- Add `usageMetadata` to the app-server `rawResponse/completed` notification and its generated schemas.

## Testing

- Cover missing, null, zero, and high-precision amounts, including completion events emitted during compaction.

GitOrigin-RevId: b16d81e8350eab0dc7ff613d0dc9dbed73041713
2026-08-27 07:50:05 +00:00

93 lines
1.9 KiB
JSON
Generated

{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"ResponseUsageMetadata": {
"description": "Usage metadata reported for one upstream response.",
"properties": {
"amount": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"TokenUsageBreakdown": {
"properties": {
"cacheWriteInputTokens": {
"default": 0,
"format": "int64",
"type": "integer"
},
"cachedInputTokens": {
"format": "int64",
"type": "integer"
},
"inputTokens": {
"format": "int64",
"type": "integer"
},
"outputTokens": {
"format": "int64",
"type": "integer"
},
"reasoningOutputTokens": {
"format": "int64",
"type": "integer"
},
"totalTokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"cachedInputTokens",
"inputTokens",
"outputTokens",
"reasoningOutputTokens",
"totalTokens"
],
"type": "object"
}
},
"description": "Internal-only notification containing the exact usage from one upstream Responses API completion.",
"properties": {
"responseId": {
"type": "string"
},
"threadId": {
"type": "string"
},
"turnId": {
"type": "string"
},
"usage": {
"anyOf": [
{
"$ref": "#/definitions/TokenUsageBreakdown"
},
{
"type": "null"
}
]
},
"usageMetadata": {
"anyOf": [
{
"$ref": "#/definitions/ResponseUsageMetadata"
},
{
"type": "null"
}
]
}
},
"required": [
"responseId",
"threadId",
"turnId"
],
"title": "RawResponseCompletedNotification",
"type": "object"
}