Async Assistant Streaming Helpers

[metaskills]

Confirm this is a feature request for the Node library and not the underlying OpenAI API.

• This is a feature request for the Node library

Describe the feature or improvement you're requesting

When using the Assistant Streaming Helpers it is sometimes desirable to have an async/await level of control for the event listener. For example, an imageFileDone listener that would move a file to a new destination as part of tools being submitted.

Additional context

I am the author of Experts.js (https://github.com/metaskills/experts) and I felt this particular pain point in a few of my projects. I've not heard of other's needs for this behavior. That said, I thought that would be helpful for more context.

https://github.com/metaskills/experts?tab=readme-ov-file#streaming--events

Thanks y'all.

[meorphis]

Thanks for reporting @metaskills. I'll route this one to the relevant team to track as a feature request.

[rattrayalex]

Thanks for the suggestion @metaskills . Could you provide a more concrete snippet of the code you'd like to write, and what you have to write today?

[metaskills]

Sure, in the Experts.js link there is a UAT test for a contrived product assistant that generates an image using data with code interpreter. Illustrated here and code. This is the "imageFileDone listener" I mentioned above.

https://github.com/metaskills/experts/blob/main/test/fixtures/productsTool.js#L48-L53

[Ethan-Arrowood]

Hi @metaskills I believe all you would need is the Node.js events .once() api: https://nodejs.org/api/events.html#eventsonceemitter-name-options

This will let you async/await on any event emitter.

[rattrayalex]

Hmm, we offer async/await await stream.finalMessages() : Promise<Message[]> and await stream.finalRunSteps(): Promise<RunStep[]>. Which additional events would you also like to await? I am not aware of an imageFileDone event in the assistants API.

[metaskills]

@Ethan-Arrowood I had no idea once offered that. Still thinking it would not work... well, maybe. I would have to rearchitect the interface of all my user-defined events and re-attach them "once" for each run. Sounds odd tho, but wiling to try if that is really the fix.

@rattrayalex Those are the assistant methods defined here. My request is for the assistant events defined here.

[rattrayalex]

Ah, silly me. Thanks very much. We'll look into that…