Add events util #1480
Add events util #1480
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
collindutter
force-pushed
the
feature/events-util
branch
from
0f2efa3 to
c84a945
Compare
collindutter
force-pushed
the
feature/events-util
branch
from
c84a945 to
7301a5a
Compare
collindutter
force-pushed
the
feature/events-util
branch
from
7301a5a to
83685e9
Compare
collindutter
force-pushed
the
feature/events-util
branch
from
83685e9 to
c5b03a9
Compare
| ## Stream Iterator | ||
|
|
||
| You can use `Structure.run_stream()` for streaming Events from the `Structure` in the form of an iterator. |
There was a problem hiding this comment.
Would prefer a EventStream util like Stream that currently exists and punt more core API changes to the Structure api to a later time, but not going to block the PR based on that.
There was a problem hiding this comment.
The downside of this approach is that EventStream would need to support anything that might need this functionality (Structures, Tasks, Drivers, Tools, etc).
I'm just as nervous about modifying Structure's API, but this implementation does at least seem consistent with other similar frameworks.
|
|
||
| !!! tip | ||
|
|
||
| Set `stream=True` on your [Prompt Driver](../drivers/prompt-drivers.md) in order to receive completion chunk events. |
There was a problem hiding this comment.
I would love to see this requirement be inferred based on Structure usage rather than needing it to be set in the constructor. Obviously out of scope, but writing it down until I have time to fill out an issue.
There was a problem hiding this comment.
Agreed, we need a better way for framework components to broadcast that they publish stream-like events.
Describe your changes
Added
Structure.run_stream()for streaming Events from a Structure as an iterator.Issue ticket number and link
Closes #1479