ai/core: add toAIStreamResponse() helper to streamText. (#1429)

Author: lgrammel

.changeset/neat-badgers-scream.md

@@ -0,0 +1,5 @@
+---
+'ai': patch
+---
+
+ai/core: add toAIStreamResponse() helper to streamText.

examples/next-groq/app/api/chat/route.ts

@@ -1,5 +1,5 @@
 import { createOpenAI } from '@ai-sdk/openai';
-import { StreamingTextResponse, experimental_streamText } from 'ai';
+import { experimental_streamText } from 'ai';
 
 export const dynamic = 'force-dynamic';
 
@@ -9,20 +9,15 @@ const groq = createOpenAI({
 });
 
 export async function POST(req: Request) {
-  try {
-    // Extract the `messages` from the body of the request
-    const { messages } = await req.json();
+  // Extract the `messages` from the body of the request
+  const { messages } = await req.json();
 
-    // Call the language model
-    const result = await experimental_streamText({
-      model: groq.chat('llama2-70b-4096'),
-      messages,
-    });
+  // Call the language model
+  const result = await experimental_streamText({
+    model: groq.chat('llama3-70b-8192'),
+    messages,
+  });
 
-    // Respond with the stream
-    return new StreamingTextResponse(result.toAIStream());
-  } catch (error) {
-    console.log(error);
-    throw error;
-  }
+  // Respond with the stream
+  return result.toAIStreamResponse();
 }

packages/core/core/generate-text/stream-text.ts

@@ -6,6 +6,8 @@ import {
 } from '@ai-sdk/provider';
 import {
   AIStreamCallbacksAndOptions,
+  StreamData,
+  StreamingTextResponse,
   createCallbacksTransformer,
   createStreamDataTransformer,
 } from '../../streams';
@@ -274,10 +276,24 @@ writes each text delta as a separate chunk.
     read();
   }
 
+  /**
+Converts the result to a streamed response object with a stream data part stream.
+It can be used with the `useChat` and `useCompletion` hooks.
+
+@param init Optional headers.
+
+@return A response object.
+   */
+  toAIStreamResponse(init?: ResponseInit): Response {
+    return new StreamingTextResponse(this.toAIStream(), init);
+  }
+
   /**
 Creates a simple text stream response.
 Each text delta is encoded as UTF-8 and sent as a separate chunk.
 Non-text-delta events are ignored.
+
+@param init Optional headers and status code.
    */
   toTextStreamResponse(init?: ResponseInit): Response {
     const encoder = new TextEncoder();