feat: Implement async generator tools #788
Merged
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.
Description
Enable decorated tools to be an async generator, enabling streaming of tool events back to to the caller. Assuming #773 is merged, the changes needed are fairly minor, as currently we're just swallowing tool stream events.
Implements #543
Api Bar-raising
The tool event being emitted (as a dictionary) needs to go through bar-raising. The event name should not matter, as it's an internal name-only (TypedEvents are not exposed; only the dictionary)
Proposed new Event
ToolStreamEvent:tool_stream_event:tool_use: ToolUse- the tool use that emitted the eventdata: Any- the data that was streamed/yielded from the toolExample tool yielding:
Example Consumption:
Existing Events
Our existing events are as follows and the proposed names must not conflict with any of the existing events:
InitEventLoopEventinit_event_loop: boolStartEventstart: boolStartEventLoopEventstart_event_loop: boolModelStreamChunkEventevent: StreamEventToolUseStreamEventdelta: ContentBlockDeltacurrent_tool_use: dict[str, Any]TextStreamEventdata: str,delta: ContentBlockDeltaReasoningTextStreamEventreasoningText: str | Nonedelta: ContentBlockDeltareasoning: boolReasoningSignatureStreamEventreasoning_signature: str | None,delta: ContentBlockDelta,reasoning: boolEventLoopThrottleEventevent_loop_throttled_delay: intModelMessageEventmessage: MessageToolResultMessageEventmessage: AnyForceStopEventforce_stop: bool,force_stop_reason: strAgentResultEventresult: AgentResultRelated Issues
#543
Documentation PR
Type of Change
New feature
Testing
How have you tested the change? Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli
hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.