docs: add missing assistant.usage event fields to streaming-events reference#2074
Open
rinceyuan wants to merge 1 commit into
Open
docs: add missing assistant.usage event fields to streaming-events reference#2074rinceyuan wants to merge 1 commit into
rinceyuan wants to merge 1 commit into
Conversation
…ference The assistant.usage event table was missing 8 fields that are present in the AssistantUsageData interface: - reasoningTokens: reasoning/chain-of-thought token count - timeToFirstTokenMs: streaming latency (first token) - interTokenLatencyMs: streaming throughput (avg inter-token) - contentFilterTriggered: content filter detection - finishReason: model finish reason (stop/length/content_filter) - reasoningEffort: reasoning effort level used - cacheExpiresAt: prompt cache expiration timestamp - serviceRequestId: server-side request ID for log correlation Also update the quick-reference table at the end of the file to include the key new fields.
Contributor
Author
|
@microsoft-github-policy-service agree company=Microsoft |
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The \�ssistant.usage\ event table in \streaming-events.md\ was missing 8 fields that are present in the \AssistantUsageData\ typed interface:
These fields are essential for embedders building observability dashboards (token cost monitoring, latency tracking, content safety detection).
Also updated the quick-reference table to include key new fields.
Validation
odejs/src/generated/session-events.ts\ (\AssistantUsageData\ interface)