Map ResponseCompletedEvent to UsageEvent in agent events #83
Conversation
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
- Define UsageEvent dataclass and add to AgentEvent union - Import RawResponsesStreamEvent and ResponseCompletedEvent - Map RawResponsesStreamEvent carrying ResponseCompletedEvent to UsageEvent in mapping function - Add null-check for optional usage to satisfy type checking
- Import RawResponsesStreamEvent, ResponseCompletedEvent, UsageEvent in tests - Update test to construct ResponseCompletedEvent with construct() to bypass validation - Add test_map_response_completed_event_to_usage_event validating UsageEvent fields
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Add
UsageEventto internal agent events and mapResponseCompletedEventfrom SDK to this new event so downstream consumers can track token usage.Implementation Details
UsageEventdataclass and added it toAgentEventunion.RawResponsesStreamEventandResponseCompletedEventand updatedmap_sdk_event_to_agent_eventto emitUsageEventwith input, output, and total token counts, including a null-check on usage.UsageEvent.Assumptions
ResponseCompletedEvent.response.usageis not present, noUsageEventis emitted.construct(), so actualParsedResponsemodel instantiation is not required.Testing
Added a unit test in
tests/agent/test_events.py:ResponseCompletedEventviaconstruct()with sample usage counts.UsageEventwith correct token counts.All linting, type checks, and tests pass.
Considerations
Alternative approaches (e.g., manually constructing Pydantic models or using
model_construct()) were considered;.construct()was chosen for simplicity in tests.