Add Model Invocation Hooks #387
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
This PR introduces new hook events that allow subscribers to monitor and interact with model invocations during agent execution. Each call to the model from the event loop will fire these events, even if we're going to retry the request. In the future I think we could expand the
AfterModelInvocationEvent
to reimplemenet retries and allow customers to specify how the request is retried, but that will require further design.Changes:
BeforeModelInvocationEvent
andAfterModelInvocationEvent
to the experimental hooks systemAfterModelInvocationEvent
includes model response data and stop reason informationstop_data
it didn't make sense to combine the event. I'm still considering how best to include structured_output callsexcept
block.Feedback wanted:
stop_data
field and dataclassRelated Issues
#231
Documentation PR
Todo
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 prepare
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.