Feature/better events #768
Conversation
collindutter
force-pushed
the
feature/better-events
branch
2 times, most recently
from
9a76b01
to
6d148ee
Compare
| - **BREAKING** Bumped `pinecone` from `^2` to `^3`. | ||
| - **BREAKING**: Removed `workdir`, `loaders`, `default_loader`, and `save_file_encoding` fields from `FileManager` and added `file_manager_driver`. | ||
| - **BREADKING**: Removed `mime_type` field from `ImageArtifact`. `mime_type` is now a property constructed using the Artifact type and `format` field. | ||
| - Improved RAG performance in `VectorQueryEngine`. | ||
| - Moved [Griptape Docs](https://github.com/griptape-ai/griptape-docs) to this repository. | ||
| - The return value of `EventListener.handler` will be passed to the `EventListenerDriver.try_publish_event_payload`'s' `event_payload` parameter. | ||
|
|
||
| ### Fixed | ||
| - Type hint for parameter `azure_ad_token_provider` on Azure OpenAI drivers to `Optional[Callable[[], str]]`. |
There was a problem hiding this comment.
Maybe "CHANGED" type hint? Can we clarify what this fixed?
Ditto for line 45 below. Did we SUPPLY the missing params?
There was a problem hiding this comment.
This didn't fix anything, it updated the behavior of the handler function to use the user's return value in the Driver. Previously this return value was thrown away.
There was a problem hiding this comment.
Ditto for line 45 below.
Assuming you're talking about Missing parameters azure_ad_token and azure_ad_token_provider, this was a fix because the type hints were incorrect.
There was a problem hiding this comment.
Yes, it's the missing parameters here, I was advocating for including a verb in the sentence, or at least clarifying what was wrong and what was done to fix it.
| @@ -9,12 +9,17 @@ | |||
|
|
|||
| @define | |||
| class EventListener: | |||
| handler: Callable[[BaseEvent], Optional[dict]] = field(default=Factory(lambda: lambda event: event.to_dict())) | |||
There was a problem hiding this comment.
no action, but good god this is brutal to parse
collindutter
force-pushed
the
feature/better-events
branch
from
99e5d94
to
dde96fc
Compare
collindutter
force-pushed
the
feature/better-events
branch
from
0f6514e
to
097d4e0
Compare
| - **BREAKING** Bumped `pinecone` from `^2` to `^3`. | ||
| - **BREAKING**: Removed `workdir`, `loaders`, `default_loader`, and `save_file_encoding` fields from `FileManager` and added `file_manager_driver`. | ||
| - **BREADKING**: Removed `mime_type` field from `ImageArtifact`. `mime_type` is now a property constructed using the Artifact type and `format` field. | ||
| - Improved RAG performance in `VectorQueryEngine`. | ||
| - Moved [Griptape Docs](https://github.com/griptape-ai/griptape-docs) to this repository. | ||
| - The return value of `EventListener.handler` will be passed to the `EventListenerDriver.try_publish_event_payload`'s' `event_payload` parameter. | ||
|
|
||
| ### Fixed | ||
| - Type hint for parameter `azure_ad_token_provider` on Azure OpenAI drivers to `Optional[Callable[[], str]]`. |
There was a problem hiding this comment.
Yes, it's the missing parameters here, I was advocating for including a verb in the sentence, or at least clarifying what was wrong and what was done to fix it.
| @@ -1,6 +1,7 @@ | |||
| ## Overview | |||
|
|
|||
| You can use [EventListener](../../reference/griptape/events/event_listener.md)s to listen for events during a Structure's execution. | |||
| See [Event Listener Drivers](../drivers/event-listener-drivers.md) for forwarding events to external services. | |||
There was a problem hiding this comment.
for examples of? guidance on?
There was a problem hiding this comment.
Nice work!
Overall, I really like the decision to add back EventListener.handler. It avoids a breaking change, keeps the local usage simple, and at the same time enables clients to customize events sent to the drivers. So cool.
Requesting changes for minor typos; everything else is optional and I'll leave to your discretion.
collindutter
force-pushed
the
feature/better-events
branch
from
3b2d7d8
to
c44366c
Compare
collindutter
force-pushed
the
feature/better-events
branch
from
c44366c
to
6391b61
Compare
EventListener.handlerEventListener.handlerwill be passed to theEventListenerDriver.try_publish_event_payload's'event_payloadparameter.LocalEventListenerDriverhttps://griptape--768.org.readthedocs.build/768/