Rename experimental_StreamData to StreamData. (#1309)

Author: lgrammel

.changeset/real-spies-sort.md

@@ -0,0 +1,5 @@
+---
+'ai': patch
+---
+
+Remove experimental\_ prefix from StreamData.

docs/pages/docs/api-reference.mdx

@@ -30,7 +30,7 @@ title: API Reference
 - [`StreamingTextResponse`](./api-reference/streaming-text-response)
 - [`AIStream`](./api-reference/ai-stream)
 - [`streamToResponse`](./api-reference/stream-to-response)
-- [`experimental_StreamData`](./api-reference/stream-data)
+- [`StreamData`](./api-reference/stream-data)
 
 ## Prompt Construction Helpers
 

docs/pages/docs/api-reference/_meta.json

@@ -5,7 +5,7 @@
   "use-chat": "useChat",
   "use-completion": "useCompletion",
   "ai-stream": "AIStream",
-  "stream-data": "experimental_StreamData",
+  "stream-data": "StreamData",
   "streaming-text-response": "StreamingTextResponse",
   "stream-to-response": "streamToResponse",
   "tokens": "<Tokens />"

docs/pages/docs/api-reference/providers/inkeep-stream.mdx

@@ -76,7 +76,7 @@ import {
   InkeepStream,
   InkeepOnFinalMetadata,
   StreamingTextResponse,
-  experimental_StreamData,
+  StreamData,
 } from 'ai';
 import { InkeepAI } from '@inkeep/ai-api';
 import type { RecordsCited$ } from '@inkeep/ai-api/models/components';
@@ -122,7 +122,7 @@ export async function POST(req: Request) {
   }
 
   // used to pass custom metadata to the client
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   if (!response?.body) {
     throw new Error('Response body is null');
@@ -148,7 +148,7 @@ export async function POST(req: Request) {
 }
 ```
 
-This example uses the [experimental_StreamData](/docs/api-reference/stream-data) and the callback methods of `InkeepStream` to attach metadata to the response.
+This example uses the [StreamData](/docs/api-reference/stream-data) and the callback methods of `InkeepStream` to attach metadata to the response.
 
 ### Client
 

docs/pages/docs/api-reference/providers/mistral-stream.mdx

@@ -53,11 +53,7 @@ export async function POST(req: Request) {
 
 ```tsx filename="app/api/completion/route.ts" showLineNumbers
 import MistralClient from '@mistralai/mistralai';
-import {
-  MistralStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from 'ai';
+import { MistralStream, StreamingTextResponse, StreamData } from 'ai';
 
 const mistral = new MistralClient(process.env.MISTRAL_API_KEY || '');
 
@@ -75,7 +71,7 @@ export async function POST(req: Request) {
   });
 
   // optional: use stream data
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   data.append({ test: 'value' });
 

docs/pages/docs/api-reference/stream-data.mdx

@@ -1,32 +1,22 @@
 ---
-title: experimental_StreamData
+title: StreamData
 layout:
   toc: false
 ---
 
 import { Callout } from 'nextra-theme-docs';
 
-# `experimental_StreamData`
+# `StreamData`
 
-The `experimental_StreamData` class allows you to stream arbitrary data to the client alongside your LLM response.
+The `StreamData` class allows you to stream arbitrary data to the client alongside your LLM response.
 For information on the implementation, see the associated [pull request](https://github.com/vercel/ai/pull/425).
 
-<Callout>
-  The `experimental_` prefix indicates that the API is not yet stable and may
-  change in the future without a major version bump.
-
-</Callout>
-
 ## Usage
 
 ### On the Server
 
 ```jsx filename="app/api/chat/route.ts" {24-25,39-40,58-59,62-63,66-67}
-import {
-  OpenAIStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from 'ai';
+import { OpenAIStream, StreamingTextResponse, StreamData } from 'ai';
 import OpenAI from 'openai';
 import type { ChatCompletionCreateParams } from 'openai/resources/chat';
 
@@ -46,7 +36,7 @@ export async function POST(req: Request) {
   });
 
   // Instantiate the StreamData. It works with all API providers.
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   const stream = OpenAIStream(response, {
     experimental_onFunctionCall: async (

docs/pages/docs/api-reference/streaming-react-response.mdx

@@ -28,14 +28,14 @@ The `experimental_StreamingReactResponse` class is designed to facilitate stream
 
 This parameter should be a `ReadableStream`, which encapsulates the HTTP response's content. It represents the stream from which the response is read and processed.
 
-### `options?: {ui?: Function, data?: experimental_StreamData}`
+### `options?: {ui?: Function, data?: StreamData}`
 
 This optional parameter allows additional configurations for rendering React components and handling streamed data.
 
 The options object can include:
 
 - `ui?: (message: {content: string, data?: JSONValue[] | undefined}) => UINode | Promise<UINode>`: A function that receives a message object with `content` and optional `data` fields. This function should return a React component (as `UINode`) for each chunk in the stream. The `data` attribute in the message is available when the `data` option is configured to include stream data.
-- `data?: experimental_StreamData`: An instance of `experimental_StreamData` used to process and stream data along with the response.
+- `data?: StreamData`: An instance of `StreamData` used to process and stream data along with the response.
 
 ## Returns
 

docs/pages/docs/guides/providers/inkeep.mdx

@@ -57,7 +57,7 @@ import {
   InkeepStream,
   InkeepOnFinalMetadata,
   StreamingTextResponse,
-  experimental_StreamData,
+  StreamData,
 } from 'ai';
 import { InkeepAI } from '@inkeep/ai-api';
 import type { RecordsCited$ } from '@inkeep/ai-api/models/components';
@@ -103,7 +103,7 @@ export async function POST(req: Request) {
   }
 
   // used to pass custom metadata to the client
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   if (!response?.body) {
     throw new Error('Response body is null');
@@ -140,7 +140,7 @@ This example leverages a few utilities provided by the Vercel AI SDK:
    class with the default headers you probably want (hint: `'Content-Type':
 'text/plain; charset=utf-8'` is already set for you). This will provide the streamed content to the client.
 
-3. Lastly, we use the [experimental_StreamData](/docs/api-reference/stream-data) and callback methods of the `InkeepStream` to attach metadata to the response like `onFinalMetadata.chat_session_id` and `records_cited.citations` for use by the client.
+3. Lastly, we use the [StreamData](/docs/api-reference/stream-data) and callback methods of the `InkeepStream` to attach metadata to the response like `onFinalMetadata.chat_session_id` and `records_cited.citations` for use by the client.
 
 <Callout>
   It's common to save a chat to a database. To do so, you can leverage the

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

@@ -2,7 +2,7 @@ import {
   InkeepStream,
   InkeepOnFinalMetadata,
   StreamingTextResponse,
-  experimental_StreamData,
+  StreamData,
 } from 'ai';
 import { InkeepAI } from '@inkeep/ai-api';
 import type { RecordsCited$ } from '@inkeep/ai-api/models/components';
@@ -48,7 +48,7 @@ export async function POST(req: Request) {
   }
 
   // used to pass custom metadata to the client
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   if (!response?.body) {
     throw new Error('Response body is null');

examples/next-langchain/app/api/stream-data-basic/route.ts

@@ -2,7 +2,7 @@ import {
   StreamingTextResponse,
   LangChainStream,
   Message,
-  experimental_StreamData,
+  StreamData,
 } from 'ai';
 import { ChatOpenAI } from 'langchain/chat_models/openai';
 import { AIMessage, HumanMessage } from 'langchain/schema';
@@ -12,7 +12,7 @@ export const runtime = 'edge';
 export async function POST(req: Request) {
   const { messages } = await req.json();
 
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   // important: use LangChainStream from the AI SDK:
   const { stream, handlers } = LangChainStream({

examples/next-langchain/app/api/stream-data-chain/route.ts

@@ -1,8 +1,4 @@
-import {
-  LangChainStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from 'ai';
+import { LangChainStream, StreamingTextResponse, StreamData } from 'ai';
 import { LLMChain } from 'langchain/chains';
 import { OpenAI } from 'langchain/llms/openai';
 import { PromptTemplate } from 'langchain/prompts';
@@ -18,7 +14,7 @@ export async function POST(req: Request) {
   );
   const chain = new LLMChain({ llm: model, prompt });
 
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   // important: use LangChainStream from the AI SDK:
   const { stream, handlers } = LangChainStream({

examples/next-mistral/app/api/completion/route.ts

@@ -1,9 +1,5 @@
 import MistralClient from '@mistralai/mistralai';
-import {
-  MistralStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from 'ai';
+import { MistralStream, StreamingTextResponse, StreamData } from 'ai';
 
 const mistral = new MistralClient(process.env.MISTRAL_API_KEY || '');
 
@@ -21,7 +17,7 @@ export async function POST(req: Request) {
   });
 
   // optional: use stream data
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   data.append({ test: 'value' });
 

examples/next-openai/app/api/chat-with-functions/route.ts

@@ -1,8 +1,4 @@
-import {
-  OpenAIStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from 'ai';
+import { OpenAIStream, StreamingTextResponse, StreamData } from 'ai';
 import OpenAI from 'openai';
 import type { ChatCompletionCreateParams } from 'openai/resources/chat';
 
@@ -58,7 +54,7 @@ export async function POST(req: Request) {
     functions,
   });
 
-  const data = new experimental_StreamData();
+  const data = new StreamData();
   const stream = OpenAIStream(response, {
     experimental_onFunctionCall: async (
       { name, arguments: args },

examples/next-openai/app/api/chat-with-tools/route.ts

@@ -3,7 +3,7 @@ import {
   StreamingTextResponse,
   Tool,
   ToolCallPayload,
-  experimental_StreamData,
+  StreamData,
 } from 'ai';
 import OpenAI from 'openai';
 
@@ -73,7 +73,7 @@ export async function POST(req: Request) {
     tool_choice: 'auto',
   });
 
-  const data = new experimental_StreamData();
+  const data = new StreamData();
   const stream = OpenAIStream(response, {
     experimental_onToolCall: async (
       call: ToolCallPayload,

examples/next-openai/app/api/completion/route.ts

@@ -1,8 +1,4 @@
-import {
-  StreamingTextResponse,
-  experimental_StreamData,
-  experimental_streamText,
-} from 'ai';
+import { StreamingTextResponse, StreamData, experimental_streamText } from 'ai';
 import { openai } from 'ai/openai';
 
 export const runtime = 'edge';
@@ -18,7 +14,7 @@ export async function POST(req: Request) {
   });
 
   // optional: use stream data
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   data.append({ test: 'value' });
 

examples/next-openai/app/stream-react-response/action.tsx

@@ -3,7 +3,7 @@
 import {
   Message,
   OpenAIStream,
-  experimental_StreamData,
+  StreamData,
   experimental_StreamingReactResponse,
 } from 'ai';
 import { experimental_buildOpenAIMessages } from 'ai/prompts';
@@ -48,7 +48,7 @@ const functions: ChatCompletionCreateParams.Function[] = [
 ];
 
 export async function handler({ messages }: { messages: Message[] }) {
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   const openai = new OpenAI({
     apiKey: process.env.OPENAI_API_KEY!,

examples/nuxt-openai/server/api/chat-with-functions.ts

@@ -1,8 +1,4 @@
-import {
-  OpenAIStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from 'ai';
+import { OpenAIStream, StreamingTextResponse, StreamData } from 'ai';
 import OpenAI from 'openai';
 import type { ChatCompletionCreateParams } from 'openai/resources/chat';
 
@@ -57,7 +53,7 @@ export default defineLazyEventHandler(async () => {
       functions,
     });
 
-    const data = new experimental_StreamData();
+    const data = new StreamData();
     const stream = OpenAIStream(response, {
       experimental_onFunctionCall: async (
         { name, arguments: args },

examples/nuxt-openai/server/api/completion.ts

@@ -1,8 +1,4 @@
-import {
-  OpenAIStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from 'ai';
+import { OpenAIStream, StreamingTextResponse, StreamData } from 'ai';
 import OpenAI from 'openai';
 
 export default defineLazyEventHandler(async () => {
@@ -24,7 +20,7 @@ export default defineLazyEventHandler(async () => {
     });
 
     // optional: use stream data
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     data.append({ test: 'value' });
 

examples/solidstart-openai/src/routes/api/chat-with-functions/index.ts

@@ -1,8 +1,4 @@
-import {
-  OpenAIStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from 'ai';
+import { OpenAIStream, StreamingTextResponse, StreamData } from 'ai';
 import OpenAI from 'openai';
 import type { ChatCompletionCreateParams } from 'openai/resources/chat';
 
@@ -57,7 +53,7 @@ export const POST = async (event: APIEvent) => {
     functions,
   });
 
-  const data = new experimental_StreamData();
+  const data = new StreamData();
   const stream = OpenAIStream(response, {
     experimental_onFunctionCall: async (
       { name, arguments: args },

examples/solidstart-openai/src/routes/api/completion/index.ts

@@ -1,8 +1,4 @@
-import {
-  OpenAIStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from 'ai';
+import { OpenAIStream, StreamingTextResponse, StreamData } from 'ai';
 import OpenAI from 'openai';
 
 import { APIEvent } from 'solid-start/api';
@@ -24,7 +20,7 @@ export const POST = async (event: APIEvent) => {
   });
 
   // optional: use stream data
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   data.append({ test: 'value' });
 

examples/sveltekit-openai/src/routes/api/chat-with-functions/+server.ts

@@ -1,9 +1,5 @@
 import OpenAI from 'openai';
-import {
-  OpenAIStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from 'ai';
+import { OpenAIStream, StreamingTextResponse, StreamData } from 'ai';
 import { env } from '$env/dynamic/private';
 import type { ChatCompletionCreateParams } from 'openai/resources/chat';
 
@@ -60,7 +56,7 @@ export async function POST({ request }) {
     functions,
   });
 
-  const data = new experimental_StreamData();
+  const data = new StreamData();
   const stream = OpenAIStream(response, {
     experimental_onFunctionCall: async (
       { name, arguments: args },

examples/sveltekit-openai/src/routes/api/chat-with-tools/+server.ts

@@ -2,7 +2,7 @@ import OpenAI from 'openai';
 import {
   OpenAIStream,
   StreamingTextResponse,
-  experimental_StreamData,
+  StreamData,
   type Tool,
   type ToolCallPayload,
 } from 'ai';
@@ -70,7 +70,7 @@ export async function POST({ request }) {
     tool_choice: 'auto',
   });
 
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   const stream = OpenAIStream(response, {
     experimental_onToolCall: async (

examples/sveltekit-openai/src/routes/api/completion/+server.ts

@@ -1,9 +1,5 @@
 import OpenAI from 'openai';
-import {
-  OpenAIStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from 'ai';
+import { OpenAIStream, StreamingTextResponse, StreamData } from 'ai';
 
 import { env } from '$env/dynamic/private';
 // You may want to replace the above with a static private env variable
@@ -29,7 +25,7 @@ export const POST = (async ({ request }) => {
   });
 
   // optional: use stream data
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   data.append({ test: 'value' });
 

packages/core/streams/anthropic-stream.test.ts

@@ -1,9 +1,5 @@
 import Anthropic from '@anthropic-ai/sdk';
-import {
-  AnthropicStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from '.';
+import { AnthropicStream, StreamingTextResponse, StreamData } from '.';
 import {
   anthropicMessageChunks,
   anthropicCompletionChunks,
@@ -46,7 +42,7 @@ describe('Anthropic completion', () => {
       apiKey: 'sk-doesnt-matter',
     });
 
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const anthropicResponse = await anthropic.completions.create({
       prompt: '',
@@ -77,7 +73,7 @@ describe('Anthropic completion', () => {
       apiKey: 'sk-doesnt-matter',
     });
 
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     data.append({ t1: 'v1' });
 
@@ -113,7 +109,7 @@ describe('Anthropic message', () => {
       apiKey: 'sk-doesnt-matter',
     });
 
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const anthropicResponse = await anthropic.messages.create({
       messages: [{ role: 'user', content: 'Hello' }],
@@ -144,7 +140,7 @@ describe('Anthropic message', () => {
       apiKey: 'sk-doesnt-matter',
     });
 
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     data.append({ t1: 'v1' });
 

packages/core/streams/aws-bedrock-stream.test.ts

@@ -1,4 +1,4 @@
-import { StreamingTextResponse, experimental_StreamData } from '.';
+import { StreamingTextResponse, StreamData } from '.';
 import {
   bedrockAnthropicChunks,
   bedrockAnthropicV3Chunks,
@@ -40,7 +40,7 @@ function simulateBedrockResponse(chunks: any[]) {
 describe('AWS Bedrock', () => {
   describe('Anthropic', () => {
     it('should send text', async () => {
-      const data = new experimental_StreamData();
+      const data = new StreamData();
 
       const bedrockResponse = simulateBedrockResponse(bedrockAnthropicChunks);
       const stream = AWSBedrockAnthropicStream(bedrockResponse, {
@@ -60,7 +60,7 @@ describe('AWS Bedrock', () => {
     });
 
     it('should send text and data', async () => {
-      const data = new experimental_StreamData();
+      const data = new StreamData();
 
       data.append({ t1: 'v1' });
 
@@ -100,7 +100,7 @@ describe('AWS Bedrock', () => {
 
   describe('Cohere', () => {
     it('should send text', async () => {
-      const data = new experimental_StreamData();
+      const data = new StreamData();
 
       const bedrockResponse = simulateBedrockResponse(bedrockCohereChunks);
       const stream = AWSBedrockCohereStream(bedrockResponse, {
@@ -125,7 +125,7 @@ describe('AWS Bedrock', () => {
     });
 
     it('should send text and data', async () => {
-      const data = new experimental_StreamData();
+      const data = new StreamData();
 
       data.append({ t1: 'v1' });
 
@@ -155,7 +155,7 @@ describe('AWS Bedrock', () => {
 
   describe('Llama2', () => {
     it('should send text', async () => {
-      const data = new experimental_StreamData();
+      const data = new StreamData();
 
       const bedrockResponse = simulateBedrockResponse(bedrockLlama2Chunks);
       const stream = AWSBedrockLlama2Stream(bedrockResponse, {
@@ -177,7 +177,7 @@ describe('AWS Bedrock', () => {
     });
 
     it('should send text and data', async () => {
-      const data = new experimental_StreamData();
+      const data = new StreamData();
 
       data.append({ t1: 'v1' });
 

packages/core/streams/cohere-stream.test.ts

@@ -1,8 +1,4 @@
-import {
-  CohereStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from '.';
+import { CohereStream, StreamingTextResponse, StreamData } from '.';
 import { cohereChatChunks, cohereChunks } from '../tests/snapshots/cohere';
 import { readAllChunks } from '../tests/utils/mock-client';
 import { DEFAULT_TEST_URL, createMockServer } from '../tests/utils/mock-server';
@@ -34,7 +30,7 @@ describe('CohereStream', () => {
   });
 
   it('should send text', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = CohereStream(await fetch(DEFAULT_TEST_URL), {
       onFinal() {
@@ -54,7 +50,7 @@ describe('CohereStream', () => {
   });
 
   it('should send text and data', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     data.append({ t1: 'v1' });
 

packages/core/streams/google-generative-ai-stream.test.ts

@@ -1,8 +1,4 @@
-import {
-  GoogleGenerativeAIStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from '.';
+import { GoogleGenerativeAIStream, StreamingTextResponse, StreamData } from '.';
 import { readAllChunks } from '../tests/utils/mock-client';
 
 function simulateGenerativeAIResponse(chunks: any[]) {
@@ -68,7 +64,7 @@ export const googleGenerativeAIChunks = [
 ];
 
 it('should send text', async () => {
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   const aiResponse = simulateGenerativeAIResponse(googleGenerativeAIChunks);
   const stream = GoogleGenerativeAIStream(aiResponse, {
@@ -88,7 +84,7 @@ it('should send text', async () => {
 });
 
 it('should send text and data', async () => {
-  const data = new experimental_StreamData();
+  const data = new StreamData();
 
   data.append({ t1: 'v1' });
 

packages/core/streams/huggingface-stream.test.ts

@@ -1,9 +1,5 @@
 import { HfInference } from '@huggingface/inference';
-import {
-  HuggingFaceStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from '.';
+import { HuggingFaceStream, StreamingTextResponse, StreamData } from '.';
 import { huggingfaceChunks } from '../tests/snapshots/huggingface';
 import { createClient } from '../tests/utils/mock-client';
 import { DEFAULT_TEST_URL, createMockServer } from '../tests/utils/mock-server';
@@ -36,7 +32,7 @@ describe('HuggingFace stream', () => {
   }
 
   it('should send text', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = HuggingFaceStream(
       Hf.textGenerationStream(
@@ -61,7 +57,7 @@ describe('HuggingFace stream', () => {
   });
 
   it('should send text and data', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     data.append({ t1: 'v1' });
 

packages/core/streams/inkeep-stream.test.ts

@@ -2,7 +2,7 @@ import {
   InkeepOnFinalMetadata,
   InkeepStream,
   StreamingTextResponse,
-  experimental_StreamData,
+  StreamData,
 } from '.';
 import { InkeepEventStream } from '../tests/snapshots/inkeep';
 import { readAllChunks } from '../tests/utils/mock-client';
@@ -34,7 +34,7 @@ describe('InkeepStream', () => {
     '"records_cited":{"citations":[{"number":1,"record":{"url":"https://inkeep.com","title":"Inkeep","breadcrumbs":["Home","About"]}}]}';
 
   it('should receive and send Inkeep onFinal metadata with chat_session_id', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const response = await fetch(DEFAULT_TEST_URL);
 
@@ -60,7 +60,7 @@ describe('InkeepStream', () => {
   });
 
   it('should receive and send Inkeep records_cited data as message annotation', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const response = await fetch(DEFAULT_TEST_URL);
 

packages/core/streams/langchain-stream.test.ts

@@ -2,7 +2,7 @@ import {
   LangChainStream,
   StreamingTextResponse,
   createStreamDataTransformer,
-  experimental_StreamData,
+  StreamData,
 } from '.';
 import { openaiChatCompletionChunks } from '../tests/snapshots/openai-chat';
 import { DEFAULT_TEST_URL, createMockServer } from '../tests/utils/mock-server';
@@ -39,7 +39,7 @@ describe('LangchainStream', () => {
   });
 
   it('should send text', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const model = new ChatOpenAI({
       streaming: true,
@@ -83,7 +83,7 @@ describe('LangchainStream', () => {
   });
 
   it('should send text and data', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     data.append({ t1: 'v1' });
 
@@ -131,7 +131,7 @@ describe('LangchainStream', () => {
 
   describe('LangChain LLM call', () => {
     it('should send text', async () => {
-      const data = new experimental_StreamData();
+      const data = new StreamData();
 
       const { stream, handlers } = LangChainStream({
         onFinal() {
@@ -162,7 +162,7 @@ describe('LangchainStream', () => {
     });
 
     it('should send text and data', async () => {
-      const data = new experimental_StreamData();
+      const data = new StreamData();
 
       data.append({ t1: 'v1' });
 

packages/core/streams/mistral-stream.test.ts

@@ -1,5 +1,5 @@
 import MistralClient from '@mistralai/mistralai';
-import { StreamingTextResponse, experimental_StreamData } from '.';
+import { StreamingTextResponse, StreamData } from '.';
 import { mistralChunks } from '../tests/snapshots/mistral';
 import { readAllChunks } from '../tests/utils/mock-client';
 import { createMockServer } from '../tests/utils/mock-server';
@@ -28,7 +28,7 @@ describe('MistralStream', () => {
   });
 
   it('should send text', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const client = new MistralClient('api-key', 'http://localhost:3030');
 
@@ -56,7 +56,7 @@ describe('MistralStream', () => {
   });
 
   it('should send text and data', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     data.append({ t1: 'v1' });
 

packages/core/streams/openai-stream.test.ts

@@ -1,9 +1,5 @@
 import OpenAI from 'openai';
-import {
-  OpenAIStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from '.';
+import { OpenAIStream, StreamingTextResponse, StreamData } from '.';
 import {
   chatCompletionChunksWithToolCall,
   openaiChatCompletionChunks,
@@ -70,7 +66,7 @@ describe('OpenAIStream', () => {
   });
 
   it('should send text', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(DEFAULT_TEST_URL), {
       onFinal() {
@@ -92,7 +88,7 @@ describe('OpenAIStream', () => {
   });
 
   it('should send function response as text stream when onFunctionCall is not defined', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(FUNCTION_CALL_TEST_URL), {
       onFinal() {
@@ -131,7 +127,7 @@ describe('OpenAIStream', () => {
   });
 
   it('should send function response when onFunctionCall is defined and returns undefined', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(FUNCTION_CALL_TEST_URL), {
       onFinal() {
@@ -153,7 +149,7 @@ describe('OpenAIStream', () => {
   });
 
   it('should not call onText for function calls', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(FUNCTION_CALL_TEST_URL), {
       onFinal() {
@@ -175,7 +171,7 @@ describe('OpenAIStream', () => {
   });
 
   it('should send function response and data when onFunctionCall is defined, returns undefined, and data is added', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(FUNCTION_CALL_TEST_URL), {
       onFinal() {
@@ -200,7 +196,7 @@ describe('OpenAIStream', () => {
   });
 
   it('should send return value when onFunctionCall is defined and returns value', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(FUNCTION_CALL_TEST_URL), {
       onFinal() {
@@ -220,7 +216,7 @@ describe('OpenAIStream', () => {
   });
 
   it('should send return value and data when onFunctionCall is defined, returns value and data is added', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(FUNCTION_CALL_TEST_URL), {
       onFinal() {
@@ -244,7 +240,7 @@ describe('OpenAIStream', () => {
   });
 
   it('should send text and data', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     data.append({ t1: 'v1' });
 
@@ -335,7 +331,7 @@ describe('OpenAIStream', () => {
     }
 
     it('should send text', async () => {
-      const data = new experimental_StreamData();
+      const data = new StreamData();
 
       const stream = OpenAIStream(
         asyncIterableFromArray(azureOpenaiChatCompletionChunks),

packages/core/streams/replicate-stream.test.ts

@@ -1,8 +1,4 @@
-import {
-  ReplicateStream,
-  StreamingTextResponse,
-  experimental_StreamData,
-} from '.';
+import { ReplicateStream, StreamingTextResponse, StreamData } from '.';
 import { replicateTextChunks } from '../tests/snapshots/replicate';
 import { readAllChunks } from '../tests/utils/mock-client';
 import { DEFAULT_TEST_URL, createMockServer } from '../tests/utils/mock-server';
@@ -29,7 +25,7 @@ describe('ReplicateStream', () => {
   });
 
   it('should send text', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = await ReplicateStream(
       {
@@ -58,7 +54,7 @@ describe('ReplicateStream', () => {
   });
 
   it('should send text and data', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     data.append({ t1: 'v1' });
 

packages/core/streams/stream-data.ts

@@ -4,7 +4,7 @@ import { JSONValue } from '../shared/types';
 /**
  * A stream wrapper to send custom JSON-encoded data back to the client.
  */
-export class experimental_StreamData {
+export class StreamData {
   private encoder = new TextEncoder();
 
   private controller: TransformStreamDefaultController<Uint8Array> | null =
@@ -129,3 +129,8 @@ export function createStreamDataTransformer() {
     },
   });
 }
+
+/**
+@deprecated Use `StreamData` instead.
+ */
+export class experimental_StreamData extends StreamData {}

packages/core/streams/streaming-react-response.test.tsx

@@ -2,7 +2,7 @@ import ReactDOMServer from 'react-dom/server';
 import {
   OpenAIStream,
   ReactResponseRow,
-  experimental_StreamData,
+  StreamData,
   experimental_StreamingReactResponse,
 } from '.';
 import {
@@ -85,7 +85,7 @@ describe('without ui', () => {
   });
 
   it('should stream text response as React rows from data stream', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(DEFAULT_TEST_URL), {
       onFinal() {
@@ -128,7 +128,7 @@ describe('with ui: sync jsx for content', () => {
   });
 
   it('should stream React response as React rows from data stream', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(DEFAULT_TEST_URL), {
       onFinal() {
@@ -172,7 +172,7 @@ describe('with ui: async sync jsx for content', () => {
   });
 
   it('should stream React response as React rows from data stream', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(DEFAULT_TEST_URL), {
       onFinal() {
@@ -199,7 +199,7 @@ describe('with ui: async sync jsx for content', () => {
 
 describe('with ui: sync jsx for content and data', () => {
   it('should stream React response as React rows from data stream when data is appended', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(FUNCTION_CALL_TEST_URL), {
       onFinal() {
@@ -243,7 +243,7 @@ describe('with ui: sync jsx for content and data', () => {
 
 describe('with ui: async jsx for content and data', () => {
   it('should stream React response as React rows from data stream when data is appended', async () => {
-    const data = new experimental_StreamData();
+    const data = new StreamData();
 
     const stream = OpenAIStream(await fetch(FUNCTION_CALL_TEST_URL), {
       onFinal() {

packages/core/streams/streaming-react-response.ts

@@ -11,7 +11,7 @@
 import { parseComplexResponse } from '../shared/parse-complex-response';
 import { IdGenerator, JSONValue } from '../shared/types';
 import { nanoid } from '../shared/utils';
-import { experimental_StreamData } from './stream-data';
+import { StreamData } from './stream-data';
 
 type UINode = string | JSX.Element | JSX.Element[] | null | undefined;
 
@@ -35,7 +35,7 @@ export class experimental_StreamingReactResponse {
         content: string;
         data?: JSONValue[];
       }) => UINode | Promise<UINode>;
-      data?: experimental_StreamData;
+      data?: StreamData;
       generateId?: IdGenerator;
     },
   ) {

packages/core/streams/streaming-text-response.ts

@@ -1,15 +1,11 @@
 import type { ServerResponse } from 'node:http';
-import { experimental_StreamData } from './stream-data';
+import { StreamData } from './stream-data';
 
 /**
  * A utility class for streaming text responses.
  */
 export class StreamingTextResponse extends Response {
-  constructor(
-    res: ReadableStream,
-    init?: ResponseInit,
-    data?: experimental_StreamData,
-  ) {
+  constructor(res: ReadableStream, init?: ResponseInit, data?: StreamData) {
     let processedStream = res;
 
     if (data) {