openai[minor]: OpenAI - Ability to set stream_options and streamUsage when instantiating ChatOpenAI class.

[deranga]

Fixes 965 - Where its not possible to get the usage back from OpenAI when streaming and using chains or agents.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
langchainjs-api-refs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 21, 2024 9:40pm
langchainjs-docs	✅ Ready (Inspect)	Visit Preview		Jun 21, 2024 9:40pm

[bracesproul]

hey, thanks for taking initiative on this! We're actually implementing a new streamUsage constructor arg & call option, but haven't gotten around to implementing it for OpenAI yet. If you wanted to implement it, here's a PR you can copy from. If not, feel free to close this PR.

Please ping me if you have any questions on it!

[bracesproul]

Actually, lets include both streamOptions: { includeUsage: boolean } (prefer camel case for our API) and streamUsage: boolean. OAI might add more fields to their stream_options API in the future, in which case we'd like a way to support those too!

[deranga]

@bracesproul, I think I've made the changes you are after.

[jacoblee93]

Getting a few 400s when running integration tests:

400 The 'stream_options' parameter is only allowed when 'stream' is enabled.

Seems like we may need to be a bit more selective on how we populate this?

[deranga]

Is it possible to run the integration tests outside of being kicked off by a maintainer?

To address the 400 for stream: false when requesting usage data I've updated so that either stream_options: {include_usage:true}/ streamUsage true will force the stream flag to be set to true, and if not fallback to this.streaming. To make it BC I've altered streamUsage to default to false.

It may make more sense to just throw the error back the user of the library, stating that you can't request stream usage info with the stream flag set to false?

Let me know if there's any other changes you'd like to see before its ready to merge

Thanks

[jacoblee93]

Changed to default to true, avoid passing as an invocation param if this.streaming is false.

e

[jacoblee93]

Thank you!