feat (provider/openai): set stream_options/include_usage to true when…

… streaming (#1578) Co-authored-by: Valentin Cassarino <valencassa@gmail.com>
vercel · May 14, 2024 · 1009594 · 1009594
1 parent e403313
commit 1009594
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 0 deletions.
diff --git a/.changeset/hot-years-live.md b/.changeset/hot-years-live.md
@@ -0,0 +1,5 @@
+---
+'@ai-sdk/openai': patch
+---
+
+feat (provider/openai): set stream_options/include_usage to true when streaming
diff --git a/examples/ai-core/src/stream-text/openai-completion.ts b/examples/ai-core/src/stream-text/openai-completion.ts
@@ -15,6 +15,10 @@ async function main() {
   for await (const textPart of result.textStream) {
     process.stdout.write(textPart);
   }
+
+  console.log();
+  console.log('Token usage:', await result.usage);
+  console.log('Finish reason:', await result.finishReason);
 }
 
 main().catch(console.error);
diff --git a/packages/openai/src/openai-chat-language-model.test.ts b/packages/openai/src/openai-chat-language-model.test.ts
@@ -552,6 +552,7 @@ describe('doStream', () => {
 
     expect(await server.getRequestBodyJson()).toStrictEqual({
       stream: true,
+      stream_options: { include_usage: true },
       model: 'gpt-3.5-turbo',
       messages: [{ role: 'user', content: [{ type: 'text', text: 'Hello' }] }],
       logprobs: false,

diff --git a/packages/openai/src/openai-chat-language-model.ts b/packages/openai/src/openai-chat-language-model.ts
@@ -198,6 +198,9 @@ export class OpenAIChatLanguageModel implements LanguageModelV1 {
       body: {
         ...args,
         stream: true,
+        stream_options: {
+          include_usage: true,
+        },
       },
       failedResponseHandler: openaiFailedResponseHandler,
       successfulResponseHandler: createEventSourceResponseHandler(

diff --git a/packages/openai/src/openai-completion-language-model.test.ts b/packages/openai/src/openai-completion-language-model.test.ts
@@ -348,6 +348,7 @@ describe('doStream', () => {
 
     expect(await server.getRequestBodyJson()).toStrictEqual({
       stream: true,
+      stream_options: { include_usage: true },
       model: 'gpt-3.5-turbo-instruct',
       prompt: 'Hello',
     });

diff --git a/packages/openai/src/openai-completion-language-model.ts b/packages/openai/src/openai-completion-language-model.ts
@@ -179,6 +179,9 @@ export class OpenAICompletionLanguageModel implements LanguageModelV1 {
       body: {
         ...this.getArgs(options),
         stream: true,
+        stream_options: {
+          include_usage: true,
+        },
       },
       failedResponseHandler: openaiFailedResponseHandler,
       successfulResponseHandler: createEventSourceResponseHandler(